Your account
<p>
-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.
+If you want to edit something or to receive notifications about changes, you need an account.
+It is however not needed for simple browsing of the list.
<p>
-The account contains your email address and password.
-If you want, you can provide a login name and xmpp address as well.
+The account is identified by your email address and a password.
+If you want, you can provide a login name and a xmpp address as well.
<p>
-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.
+Email and xmpp addresses will be used to send notifications about changes to you (if you request them).
+An email address can be also used to reset your password, in case you forget it.
+Neither your email nor your xmpp address will be shown to anybody but you and the admins.
<p>
-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.
+The login name is used for your convenience during login (you can log in by either your email or
+your login name) and it is also publicly shown in the discussion items you wrote.
<h2>Obtaining an account</h2>
<p>
-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 <a href='$AC_URL$respass'>reset your password</a> (because exists no password for you).
+It is quite possible that your account has been already created. This happens if you
+have submitted an entry using the email robot, or if you have used the address in the previous
+incarnation of this web interface.
+In that case, you need to <a href='$AC_URL$respass'>reset your password</a>, because the account
+does not have a password yet.
<p>
-If you do not have an account, go to <a href='$AC_URL$register'>register</a> item in menu (you can find it, when you visit <a href='$AC_URL$login'>Log in</a> 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.
+If you do not have an account, click on <a href='$AC_URL$register'>register</a> item in the menu (you can find it when you visit the <a href='$AC_URL$login'>Log in</a> page) and fill in your email address.
+A message containing a confirmation link will be sent to you.
+After you follow the link and fill in some more information, your account will be ready for use.
-<h2>Reseting password</h2>
+<h2>Resetting password</h2>
<p>
If your account was created automatically or you forget your password, you need to reset it.
Enter your email address into the <a href='$AC_URL$respass'>reset password</a> page.
-A message with confirmation link will be sent to you.
+A message with a confirmation link will be sent to you.
When you follow it, you will be provided with a form where you can change the password.
<h2>Logging in</h2>
<p>
-When you want to edit some information here or alter your own settings, you need to be logged in.
-Fill the form on the <a href='$AC_URL$login'>log in</a> page.
+When you want to edit any entries in the lists or to alter your personal settings, you need to be logged in.
+Fill
in the form on the <a href='$AC_URL$login'>log in</a> page.
You can provide either your email address or your login name, they both work.
<p>
-After successful login, you will be redirected either to <a href='$HELP_URL$list'>ID browsing</a> or to any action you tried to perform and it required login.
+After a successful login, you will be redirected either to <a href='$HELP_URL$list'>ID browsing</a> or to the action
+you tried to perform which required login.
<p>
You can log out again by <a href='$AC_URL$logout'>log out</a> 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.
+You will be logged out automatically after approximately 30 minutes of inactivity
+or when you close your browser.
<h2>Actions requiring login</h2>
<ul class='navigation'>
<h2>Accounts with additional rights</h2>
<p>
-There are accounts with additional rights, like deleting whole items or approving history comments.
+Some accounts are gifted with extra powers that are not available to ordinary users.
+These include deleting items from the discussion, approving entries and other administrative
+actions.
If you have one, you probably know it already.
-If you think you should have one, contact owners of this site.
+If you think you should have one, contact the maintainers of this site.
Help index
-<h2>Read only operations</h2>
+<h2>Read-only operations</h2>
<ul class='navigation'>
<li><a href='$HELP_URL$list'>Browsing</a>
<li><a href='$HELP_URL$jump'>Jumping</a>
Jumping
-The jump box (little text box with 'Jump' button by its side) has two functions.
+The jump box (the little text box with the 'Jump' button by its side) has two functions.
<h2>Direct ID jump</h2>
<p>
If you enter an ID and press Jump (or Enter), you are sent directly to that ID.
<p>
-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.
+The ID can be either an absolute path (with segments separated by slashes
+and/or colons). The exact rules for matching the paths are as follows, but
+maybe you want to see the examples at the end of this page first.
+<p>
+If the ID starts with an ID type prefix (e.g., 'PC'), it is considered absolute.
+<p>
+If it starts with a segment separator, it is considered absolute inside current ID tree (e.g., PCI devices).
+<p>
+Otherwise, it is relative and it is appended to the current ID, then to its parent and so on,
+until an existing entry or the root of the tree is reached.
+<p>
+If the absolute address is not found, we try to interpret it as relative instead.
<h2>Name search</h2>
<p>
-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 the direct ID jump does not succeed, we search entry names for the given string.
+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 ('*').
<p>
If you want to turn off name search in your query, prefix the query with '#'.
<p>
All examples are searches from within ID 'PC:0000:0000'.
<ul>
- <li><tt>PD:00</tt> ‒ jumps to <tt>PD:00</tt>, if it exist.
- <li><tt>:1234</tt> ‒ jumps to <tt>PC:1234</tt>, if it exist.
+ <li><tt>PD:00</tt> ‒ jumps to <tt>PD:00</tt> (PCI class <tt>00</tt>), if it exists.
+ <li><tt>:1234</tt> ‒ jumps to <tt>PC:1234</tt> (PCI device vendor <tt>1234</tt>), if it exists.
<li><tt>abcd</tt> ‒ tries <tt>PC:0000:0000:abcd</tt>, then <tt>PC:0000:abcd</tt>, then <tt>PC:abcd</tt>. Then searches in names.
- <li><tt>#abcd</tt> ‒ same as above, but does not continue searching in names.
- <li><tt>Some text</tt> ‒ all id searches will fail, names of PCI devices are searched for <tt>Some text</tt>.
- <li><tt>*Some text</tt> ‒ same, but the search is trough all devices in database.
+ <li><tt>#abcd</tt> ‒ same as above, but does not switch to searching in names.
+ <li><tt>Some text</tt> ‒ all ID searches will fail, so names of PCI devices are searched for <tt>Some text</tt>.
+ <li><tt>*Some text</tt> ‒ same, but the search is through all items in the database.
</ul>
Browsing ID list
<p>
-You can examine the current list of IDs.
-The IDs are organized into a tree.
+You can browse the list of ID's, including the history of the entries.
+<p>
+The ID's are organized in the form of a tree. The top level lists vendors,
+the next level enumerates their devices and the bottommost level shows the
+subsystems. Other lists, like the list of classes, are organized in a similar
+way.
<h2>Page anatomy</h2>
<p>
-Page is divided into parts:
+The page is divided into several parts:
<ul>
- <li><strong>Menu</strong> ‒ you can perform actions, both in connection with current item (like <a href='$HELP_URL$newitem'>adding a new sub-item</a>, in top left corner) and global (<a href='$HELP_URL$profile'>editing your profile</a>, in top right corner).
- <li><strong>Hierarchy</strong> ‒ lists all parental items.
- <li><strong>Item status</strong> ‒ contains current name and comment.
- <li><strong>Discussion</strong> ‒ contains history of suggested names, notes and general talk about current item.
- <li><strong>List of sub-items</strong> ‒ all direct sub-items are listed here and you can browse into them.
+ <li><strong>Menu</strong> ‒ you can perform actions, both in connection with current item (like <a href='$HELP_URL$newitem'>adding a new sub-item</a>, in the top left corner) and global (<a href='$HELP_URL$profile'>editing your profile</a>, in the top right corner).
+ <li><strong>Hierarchy</strong> ‒ lists all parent items.
+ <li><strong>Item status</strong> ‒ contains the current name and the attached comment.
+ <li><strong>Discussion</strong> ‒ contains the history of suggested names, notes and general talk about the current item.
+ <li><strong>List of sub-items</strong> ‒ all direct sub-items of the current item are listed here and you can descend into them.
</ul>
-You can find menu and hierarchy in most other pages and they have the same function.
+You can find the menu and the hierarchy in most other pages; they work in similar way there.
<h2>Colors</h2>
-Colors are used both in discussion and list of sub-items to mark status of discussion comments and sub-items respectively.
-<span class='main-history'>Green entries</span> are discussion comments which provide current item name.
-<span class='unseen-history'>Grey ones</span> 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.
-<span class='history'>White ones</span> are the rest, usual discussion and valid items.
+
+<p>Colors are used in both the discussion and the list of sub-items to mark status of discussion comments and sub-items respectively.
+
+<p><span class='main-history'>Green entries</span> are discussion comments that provide the current item name
+– the "active" ones.
+
+<p><span class='unseen-history'>Grey entries</span> are those which need attention: They are either items without
+any assigned name (either discussion about a not-yet-existing item, or a new item which was not yet approved by
+an admin), or discussion comments not yet seen by an admin.
+
+<p><span class='history'>White ones</span> are the rest: regular discussion and approved items.
<h2>Example</h2>
<div class='help-example'>
projects / pciids.git / commitdiff