From: Michal Vaner Date: Mon, 8 Sep 2008 20:28:59 +0000 (+0200) Subject: Help is relative to directory X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=104244a701a81c2f5c5d02527e4fcaea5572b44d;p=pciids.git Help is relative to directory Place it there --- diff --git a/cf/help/account b/cf/help/account new file mode 100644 index 0000000..e523e02 --- /dev/null +++ b/cf/help/account @@ -0,0 +1,57 @@ +Your account +

+If you want to edit something or just receive notifications about changes, you need an account. +If you want to only view and browse information here, you do not need one. +

+The account contains your email address and password. +If you want, you can provide a login name and xmpp address as well. +

+Email and xmpp addresses will be used to send you notifications about changes (if you request them). +Email address can be used to reset your password, if you forget it. +Neither your email nor your xmpp address will be showed to anybody but you and admins. +

+Login name is used for your convenience during login (you can log in by either email or login name) and +it is showed with discussion submits you wrote. + +

Obtaining an account

+

+It is possible you account has been created already. +It is created if you submit something using email. +And we created accounts for all submits imported from previous version of this site. +In that case, you need to reset your password (because exists no password for you). +

+If you do not have an account, go to register item in menu (you can find it, when you visit Log in page) and fill your email address. +A message containing confirmation link will be sent to it. +After you follow the link and fill in the rest, your account is ready for use. + +

Reseting password

+

+If your account was created automatically or you forget your password, you need to reset it. +Enter your email address into the reset password page. +A message with confirmation link will be sent to you. +When you follow it, you will be provided with a form where you can change the password. + +

Logging in

+

+When you want to edit some information here or alter your own settings, you need to be logged in. +Fill the form on the log in page. +You can provide either your email address or your login name, they both work. +

+After successful login, you will be redirected either to ID browsing or to any action you tried to perform and it required login. +

+You can log out again by log out menu item. +You will be logged out automatically if you do not do anything in a long time (approx. 30 minutes) or close your browser. + +

Actions requiring login

+ + +

Accounts with additional rights

+

+There are accounts with additional rights, like deleting whole items or approving history comments. +If you have one, you probably know it already. +If you think you should have one, contact owners of this site. diff --git a/cf/help/admin b/cf/help/admin new file mode 100644 index 0000000..9c2788d --- /dev/null +++ b/cf/help/admin @@ -0,0 +1,42 @@ +Administration interface + +

Layout

+

+Each item requiring administration has it's own rectangle with few lines. +The first line (either white or grey, depending on the current ID status) contains its path. +The second line (green), if it is present, specifies current name. +

+The following gray lines are new discussion comments. +

+The last, yellow, line is for submitting answer. + +

Actions

+

Deletes

+

+The last column (with square check-boxes) is for deleting. +To delete the whole item, use red one in the first line (present only if it is possible to delete this item). +Each discussion comment has it's own one. +The delete checkbox in the yellow line will delete name of the current item (eg. the history is preserved, but it will not appear in pci.ids or other exports). + +

Selecting

+

+The round boxes (on the left side of the deleting ones) is for selecting active history comment, which specifies the name of the item. +If you leave it as it is, on the first line, nothing changes. +If you select the green one, the name does not change, but the whole history of the item is marked as seen and won't appear again in the administration interface (until someone writes some more). +If you select any history comment, it will become active. + +

Commenting

+

+The yellow line act's similarly to browsing and will not appear in administration interface). +If you do not want to change anything about the item, just use the green selection box to read the history. diff --git a/cf/help/index b/cf/help/index new file mode 100644 index 0000000..e662ca6 --- /dev/null +++ b/cf/help/index @@ -0,0 +1,23 @@ +Help index +

Read only operations

+ +

Account based operations

+ +

Editing database

+ +

Information about ID types

+ diff --git a/cf/help/jump b/cf/help/jump new file mode 100644 index 0000000..8f58fb0 --- /dev/null +++ b/cf/help/jump @@ -0,0 +1,32 @@ +Jumping +The jump box (little text box with 'Jump' button by its side) has two functions. + +

Direct ID jump

+

+If you enter an ID and press Jump (or Enter), you are sent directly to that ID. +

+You can use both slashes ('/') and colons (':') as ID segment separators. +If the ID starts with an ID type prefix (eg. 'PC'), it is considered absolute. +If it starts with a segment separator, it is considered absolute inside current ID tree (eg. PCI devices). +Absolute addresses are tried first, if they do not exist, relative search is done. +Otherwise, it is relative and is appended to current ID, then to its parent and so on, until some exists or a root of tree is reached. + +

Name search

+

+If direct ID jump does not succeed, names of items are searched for it. +By default only names of the same ID type are searched (if you browse PCI devices, you will not get results from device classes). +If you want to search all names, prefix the search with an asterisk ('*'). +

+If you want to turn off name search in your query, prefix the query with '#'. + +

Examples

+

+All examples are searches from within ID 'PC:0000:0000'. +

diff --git a/cf/help/list b/cf/help/list new file mode 100644 index 0000000..6fd6444 --- /dev/null +++ b/cf/help/list @@ -0,0 +1,53 @@ +Browsing ID list +

+You can examine the current list of IDs. +The IDs are organized into a tree. +

Page anatomy

+

+Page is divided into parts: +

+ +You can find menu and hierarchy in most other pages and they have the same function. + +

Colors

+Colors are used both in discussion and list of sub-items to mark status of discussion comments and sub-items respectively. +Green entries are discussion comments which provide current item name. +Grey ones are entries with some problem. They are either items without any assigned name (discussion about non-existing item, new item which was not yet approved by an admin) or discussion comments not yet seen by an admin. +White ones are the rest, usual discussion and valid items. + +

Example

+
+
+
+
+

ID 0000

+
+

Main page -> Parent

+

ID 0000

+

Name: ID name

+

Discussion

+
+

Name: ID name +

This item is here just as an example. +

Author +

1900-01-01 00:00 +

+
+

Sub-items

++
IdNameNote +
1234Sub-itemThis is just example +
+
diff --git a/cf/help/mailsubmit b/cf/help/mailsubmit new file mode 100644 index 0000000..26033d8 --- /dev/null +++ b/cf/help/mailsubmit @@ -0,0 +1,11 @@ +Mail submit +

+PCI IDs can be submited and edited using email. +There is a robot at address pci-ids@ucw.cz, which accepts patches sent to it. +Please use unified diffs (diff -u) against the current pci.ids file (preferably the one just downloaded from this page, but the robot tries hard to recognize older versions as well). +Avoid base64 encoding and mail agents converting tabs to spaces, breaking lines and so on. +

+If you do not have an account yet, one is created for your email address. +You will get subscribed to notifications about all the items you changed (if you like to tweak the notifications, look at their documentation. +

+Please note, the robot understands only PCI IDs. Other types of IDs must be entered by the web interface. diff --git a/cf/help/newhistory b/cf/help/newhistory new file mode 100644 index 0000000..654418d --- /dev/null +++ b/cf/help/newhistory @@ -0,0 +1,34 @@ +Discussion +

+If you think some information here is wrong, you know better or want to say something about some item, you can enter discussion. +Browse to the item and click the discuss link. +

+If you do not want to alter current name or note, provide only text. +If you want to change name, provide that one too (in that case, you do not have to provide text, but it is recommended to say why you think the new version is better). +Changing note alone is not possible, you can change it with name only. +If you change just note, enter the same name as before. +

+You can request item deletion here, too. + +

Approval

+

+All submissions are checked by an admin for errors. +Please try to provide valid information. +You should check specific help for corresponding ID type: +

+ +

Notification subscription

+

+If the subscribe checkbox is checked, a notification on the new item will be created for you. +For more information about notifications look at their documentation. +

+The checkbox is present only unless you have a notification covering this item already. + +

See also

+

+You can create new items. +

+If you want to know about changes in some item, set up a notification. diff --git a/cf/help/newitem b/cf/help/newitem new file mode 100644 index 0000000..e073b8f --- /dev/null +++ b/cf/help/newitem @@ -0,0 +1,40 @@ +Add a new item +

+If you know about an ID not present here, you can submit it. +Browse to the item which should contain it and click add item link. +

+You need to fill in the ID and its name. +The ID is just the last part (without parent part, for example if you have PCI device 1234:5678 and the vendor 1234 already exists, you enter only 5678). +If you know chip name, it is preferred over marketing name. +

+You can add some note to the name, for example, if the ID is not really owned by the company using it. +You can add a discussion comment to it (why you think it is correct). +The difference between note and discussion is that note is additional information to name, while discussion is administrative. +Also, note is sometimes distributed, while discussion isn't. +

+Both note and discussion is optional. +

+After you submit it, it will wait approval of an admin. + +

Approval

+

+Each item is checked and approved by an admin. +It is because not all submissions are correct. +

+If you want to it to get approved, please check you enter valid information into correct place (eg. not an USB ID into PCI devices, Device into its vendor). +You should check help specific for each tree: +

+ +

Notification subscription

+

+If the subscribe checkbox is checked, a notification on the new item will be created for you. +For more information about notifications look at their documentation. + +

See also

+

+Once item is submitted, it is not sealed for ever. You can discuss existing items and suggest them new names. +

+If you are interested in changes in some item (or its whole subtree), you can let the system send you notifications. diff --git a/cf/help/notifications b/cf/help/notifications new file mode 100644 index 0000000..a87c8a9 --- /dev/null +++ b/cf/help/notifications @@ -0,0 +1,22 @@ +Notifications +

+If you are interested in any changes in some item, you can set up a notification to get informed. +Browse to the item and click notifications link (it is visible only when you are logged in. +You can set these things: +

+ +

Existing notifications

+

+There is a list of currently existing notifications at the bottom of page. +You can switch to them by clicking on them. + +

See also

+

+This is all your own configuration. You can get an account so you can set it up. +

+You can set up various things (like address, where the notifications are sent) in your profile. diff --git a/cf/help/pci b/cf/help/pci new file mode 100644 index 0000000..214b462 --- /dev/null +++ b/cf/help/pci @@ -0,0 +1,20 @@ +PCI devices +

Vendors

+

+The top level of hierarchy is a vendor list. +Each vendor has a 2-byte long id, stored in database as 4 hexadecimal digits (with lowercase letters). +They can be browsed here. + +

Devices

+

+Each vendor contains a list of its devices. +Each device in the list has a 2-byte long id, stored the same way as vendor id (4 hexadecimal letters). + +

Subsystems

+A device can consist of more sub-systems. +Each sub-system has 4-byte long id, stored as 8 hexadecimal letters, split in the middle by a space (for example 1234 abcd could be a sub-system id). +The first quad of digits is considered a vendor id (from the same list of vendors). The vendor of the sub-system can be different than vendor of the device. + +

See also

+

+You can have a look at PCI device classes. diff --git a/cf/help/pci_class b/cf/help/pci_class new file mode 100644 index 0000000..427932d --- /dev/null +++ b/cf/help/pci_class @@ -0,0 +1,18 @@ +PCI device classes +

Device classes

+

+Device class is identified by a single byte. It is stored as 2 hexadecimal digits (all in lowercase). +They can be examined here. + +

Device subclasses

+

+A device class is divided into subclasses. +Each subclass is identified in a same way as a device class, by single byte represented by 2 hexadecimal letters. + +

Program interface

+

+A subclass can have different program interfaces. +An interface is identified by a single byte represented by 2 hexadecimal letters. + +

See also

+You can have a look at PCI devices. diff --git a/cf/help/profile b/cf/help/profile new file mode 100644 index 0000000..06f0cab --- /dev/null +++ b/cf/help/profile @@ -0,0 +1,25 @@ +User profile +

+When you are logged in, you can find a profile link. +You can set various information about your account. +

+ +

Password protected values

+

+Email, login and new password are protected by the old password. +If you want to change any of these, you must provide the old password to unlock them. + +

See also

+

+You can get a profile by registering it. +

+To receive any notifications, you need to set them up. diff --git a/help/account b/help/account deleted file mode 100644 index e523e02..0000000 --- a/help/account +++ /dev/null @@ -1,57 +0,0 @@ -Your account -

-If you want to edit something or just receive notifications about changes, you need an account. -If you want to only view and browse information here, you do not need one. -

-The account contains your email address and password. -If you want, you can provide a login name and xmpp address as well. -

-Email and xmpp addresses will be used to send you notifications about changes (if you request them). -Email address can be used to reset your password, if you forget it. -Neither your email nor your xmpp address will be showed to anybody but you and admins. -

-Login name is used for your convenience during login (you can log in by either email or login name) and -it is showed with discussion submits you wrote. - -

Obtaining an account

-

-It is possible you account has been created already. -It is created if you submit something using email. -And we created accounts for all submits imported from previous version of this site. -In that case, you need to reset your password (because exists no password for you). -

-If you do not have an account, go to register item in menu (you can find it, when you visit Log in page) and fill your email address. -A message containing confirmation link will be sent to it. -After you follow the link and fill in the rest, your account is ready for use. - -

Reseting password

-

-If your account was created automatically or you forget your password, you need to reset it. -Enter your email address into the reset password page. -A message with confirmation link will be sent to you. -When you follow it, you will be provided with a form where you can change the password. - -

Logging in

-

-When you want to edit some information here or alter your own settings, you need to be logged in. -Fill the form on the log in page. -You can provide either your email address or your login name, they both work. -

-After successful login, you will be redirected either to ID browsing or to any action you tried to perform and it required login. -

-You can log out again by log out menu item. -You will be logged out automatically if you do not do anything in a long time (approx. 30 minutes) or close your browser. - -

Actions requiring login

- - -

Accounts with additional rights

-

-There are accounts with additional rights, like deleting whole items or approving history comments. -If you have one, you probably know it already. -If you think you should have one, contact owners of this site. diff --git a/help/admin b/help/admin deleted file mode 100644 index 9c2788d..0000000 --- a/help/admin +++ /dev/null @@ -1,42 +0,0 @@ -Administration interface - -

Layout

-

-Each item requiring administration has it's own rectangle with few lines. -The first line (either white or grey, depending on the current ID status) contains its path. -The second line (green), if it is present, specifies current name. -

-The following gray lines are new discussion comments. -

-The last, yellow, line is for submitting answer. - -

Actions

-

Deletes

-

-The last column (with square check-boxes) is for deleting. -To delete the whole item, use red one in the first line (present only if it is possible to delete this item). -Each discussion comment has it's own one. -The delete checkbox in the yellow line will delete name of the current item (eg. the history is preserved, but it will not appear in pci.ids or other exports). - -

Selecting

-

-The round boxes (on the left side of the deleting ones) is for selecting active history comment, which specifies the name of the item. -If you leave it as it is, on the first line, nothing changes. -If you select the green one, the name does not change, but the whole history of the item is marked as seen and won't appear again in the administration interface (until someone writes some more). -If you select any history comment, it will become active. - -

Commenting

-

-The yellow line act's similarly to browsing and will not appear in administration interface). -If you do not want to change anything about the item, just use the green selection box to read the history. diff --git a/help/index b/help/index deleted file mode 100644 index e662ca6..0000000 --- a/help/index +++ /dev/null @@ -1,23 +0,0 @@ -Help index -

Read only operations

- -

Account based operations

- -

Editing database

- -

Information about ID types

- diff --git a/help/jump b/help/jump deleted file mode 100644 index 8f58fb0..0000000 --- a/help/jump +++ /dev/null @@ -1,32 +0,0 @@ -Jumping -The jump box (little text box with 'Jump' button by its side) has two functions. - -

Direct ID jump

-

-If you enter an ID and press Jump (or Enter), you are sent directly to that ID. -

-You can use both slashes ('/') and colons (':') as ID segment separators. -If the ID starts with an ID type prefix (eg. 'PC'), it is considered absolute. -If it starts with a segment separator, it is considered absolute inside current ID tree (eg. PCI devices). -Absolute addresses are tried first, if they do not exist, relative search is done. -Otherwise, it is relative and is appended to current ID, then to its parent and so on, until some exists or a root of tree is reached. - -

Name search

-

-If direct ID jump does not succeed, names of items are searched for it. -By default only names of the same ID type are searched (if you browse PCI devices, you will not get results from device classes). -If you want to search all names, prefix the search with an asterisk ('*'). -

-If you want to turn off name search in your query, prefix the query with '#'. - -

Examples

-

-All examples are searches from within ID 'PC:0000:0000'. -

diff --git a/help/list b/help/list deleted file mode 100644 index 6fd6444..0000000 --- a/help/list +++ /dev/null @@ -1,53 +0,0 @@ -Browsing ID list -

-You can examine the current list of IDs. -The IDs are organized into a tree. -

Page anatomy

-

-Page is divided into parts: -

- -You can find menu and hierarchy in most other pages and they have the same function. - -

Colors

-Colors are used both in discussion and list of sub-items to mark status of discussion comments and sub-items respectively. -Green entries are discussion comments which provide current item name. -Grey ones are entries with some problem. They are either items without any assigned name (discussion about non-existing item, new item which was not yet approved by an admin) or discussion comments not yet seen by an admin. -White ones are the rest, usual discussion and valid items. - -

Example

-
-
-
-
-

ID 0000

-
-

Main page -> Parent

-

ID 0000

-

Name: ID name

-

Discussion

-
-

Name: ID name -

This item is here just as an example. -

Author -

1900-01-01 00:00 -

-
-

Sub-items

--
IdNameNote -
1234Sub-itemThis is just example -
-
diff --git a/help/mailsubmit b/help/mailsubmit deleted file mode 100644 index 26033d8..0000000 --- a/help/mailsubmit +++ /dev/null @@ -1,11 +0,0 @@ -Mail submit -

-PCI IDs can be submited and edited using email. -There is a robot at address pci-ids@ucw.cz, which accepts patches sent to it. -Please use unified diffs (diff -u) against the current pci.ids file (preferably the one just downloaded from this page, but the robot tries hard to recognize older versions as well). -Avoid base64 encoding and mail agents converting tabs to spaces, breaking lines and so on. -

-If you do not have an account yet, one is created for your email address. -You will get subscribed to notifications about all the items you changed (if you like to tweak the notifications, look at their documentation. -

-Please note, the robot understands only PCI IDs. Other types of IDs must be entered by the web interface. diff --git a/help/newhistory b/help/newhistory deleted file mode 100644 index 654418d..0000000 --- a/help/newhistory +++ /dev/null @@ -1,34 +0,0 @@ -Discussion -

-If you think some information here is wrong, you know better or want to say something about some item, you can enter discussion. -Browse to the item and click the discuss link. -

-If you do not want to alter current name or note, provide only text. -If you want to change name, provide that one too (in that case, you do not have to provide text, but it is recommended to say why you think the new version is better). -Changing note alone is not possible, you can change it with name only. -If you change just note, enter the same name as before. -

-You can request item deletion here, too. - -

Approval

-

-All submissions are checked by an admin for errors. -Please try to provide valid information. -You should check specific help for corresponding ID type: -

- -

Notification subscription

-

-If the subscribe checkbox is checked, a notification on the new item will be created for you. -For more information about notifications look at their documentation. -

-The checkbox is present only unless you have a notification covering this item already. - -

See also

-

-You can create new items. -

-If you want to know about changes in some item, set up a notification. diff --git a/help/newitem b/help/newitem deleted file mode 100644 index e073b8f..0000000 --- a/help/newitem +++ /dev/null @@ -1,40 +0,0 @@ -Add a new item -

-If you know about an ID not present here, you can submit it. -Browse to the item which should contain it and click add item link. -

-You need to fill in the ID and its name. -The ID is just the last part (without parent part, for example if you have PCI device 1234:5678 and the vendor 1234 already exists, you enter only 5678). -If you know chip name, it is preferred over marketing name. -

-You can add some note to the name, for example, if the ID is not really owned by the company using it. -You can add a discussion comment to it (why you think it is correct). -The difference between note and discussion is that note is additional information to name, while discussion is administrative. -Also, note is sometimes distributed, while discussion isn't. -

-Both note and discussion is optional. -

-After you submit it, it will wait approval of an admin. - -

Approval

-

-Each item is checked and approved by an admin. -It is because not all submissions are correct. -

-If you want to it to get approved, please check you enter valid information into correct place (eg. not an USB ID into PCI devices, Device into its vendor). -You should check help specific for each tree: -

- -

Notification subscription

-

-If the subscribe checkbox is checked, a notification on the new item will be created for you. -For more information about notifications look at their documentation. - -

See also

-

-Once item is submitted, it is not sealed for ever. You can discuss existing items and suggest them new names. -

-If you are interested in changes in some item (or its whole subtree), you can let the system send you notifications. diff --git a/help/notifications b/help/notifications deleted file mode 100644 index a87c8a9..0000000 --- a/help/notifications +++ /dev/null @@ -1,22 +0,0 @@ -Notifications -

-If you are interested in any changes in some item, you can set up a notification to get informed. -Browse to the item and click notifications link (it is visible only when you are logged in. -You can set these things: -

- -

Existing notifications

-

-There is a list of currently existing notifications at the bottom of page. -You can switch to them by clicking on them. - -

See also

-

-This is all your own configuration. You can get an account so you can set it up. -

-You can set up various things (like address, where the notifications are sent) in your profile. diff --git a/help/pci b/help/pci deleted file mode 100644 index 214b462..0000000 --- a/help/pci +++ /dev/null @@ -1,20 +0,0 @@ -PCI devices -

Vendors

-

-The top level of hierarchy is a vendor list. -Each vendor has a 2-byte long id, stored in database as 4 hexadecimal digits (with lowercase letters). -They can be browsed here. - -

Devices

-

-Each vendor contains a list of its devices. -Each device in the list has a 2-byte long id, stored the same way as vendor id (4 hexadecimal letters). - -

Subsystems

-A device can consist of more sub-systems. -Each sub-system has 4-byte long id, stored as 8 hexadecimal letters, split in the middle by a space (for example 1234 abcd could be a sub-system id). -The first quad of digits is considered a vendor id (from the same list of vendors). The vendor of the sub-system can be different than vendor of the device. - -

See also

-

-You can have a look at PCI device classes. diff --git a/help/pci_class b/help/pci_class deleted file mode 100644 index 427932d..0000000 --- a/help/pci_class +++ /dev/null @@ -1,18 +0,0 @@ -PCI device classes -

Device classes

-

-Device class is identified by a single byte. It is stored as 2 hexadecimal digits (all in lowercase). -They can be examined here. - -

Device subclasses

-

-A device class is divided into subclasses. -Each subclass is identified in a same way as a device class, by single byte represented by 2 hexadecimal letters. - -

Program interface

-

-A subclass can have different program interfaces. -An interface is identified by a single byte represented by 2 hexadecimal letters. - -

See also

-You can have a look at PCI devices. diff --git a/help/profile b/help/profile deleted file mode 100644 index 06f0cab..0000000 --- a/help/profile +++ /dev/null @@ -1,25 +0,0 @@ -User profile -

-When you are logged in, you can find a profile link. -You can set various information about your account. -

- -

Password protected values

-

-Email, login and new password are protected by the old password. -If you want to change any of these, you must provide the old password to unlock them. - -

See also

-

-You can get a profile by registering it. -

-To receive any notifications, you need to set them up. diff --git a/index.html b/index.html index 25e4873..a914076 100644 --- a/index.html +++ b/index.html @@ -15,7 +15,7 @@ under the terms of either the GNU General Public License (version 2 or later) or of the 3-clause BSD License. -

You may want to read help before you start using this site. +

You may want to read help before you start using this site.

How to submit new data

If you have any device not listed in our database, we'll be glad to hear @@ -30,8 +30,8 @@ names in device or subsystem names. If you have anything important to mention (especially why are you changing an existing entry), please add a discussion comment.

-You may submit them on this site (for help see this) or +You may submit them on this site (for help see this) or send a patch to pci.ids file to address pci-ids@ucw.cz. -See mail submit help. +See mail submit help.