Merge branch 'master' of /home/vorner/pciids

[pciids.git] / help / list

diff --git a/help/list b/help/list
index b403c85cb408a5b2afe95f5bc138bb37dd4b1d3f..cd7865e0ce1c4676c540f4c1df396ebbfadece14 100644 (file)
--- a/help/list
+++ b/help/list
@@ -1,38 +1,51 @@
 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.
+<p>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
+&ndash; 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'>
 <div class='top'>
-<h1>ID 0000</h1>
 <div class='lmenu'><ul>
        <li><a href='$HELP_URL$newitem'>Add item</a>
        <li><a href='$HELP_URL$newhistory'>Discuss</a>
-       <li><form class='jump' method='POST' action='$HELP_URL$jump'><p><input type='text' class='jump' disabled='disabled'><input type='submit' value='Jump'></form>
 </ul></div>
 <div class='rmenu'><ul>
        <li><a href='$HELP_URL$account'>Log in</a>
 </ul></div>
+<div class='bluesquare-example'>
+<h1>The PCI ID Repository</h1>
+<p class='home'>The home of the pci.ids file
+</div>
 <div class='clear'></div></div>
 <div class='path'><p><a href='$HELP_URL$index'>Main page</a>&nbsp;-&gt;&nbsp<a href='$HELP_URL$index'>Parent</a></div>
 <h2>ID 0000</h2>
@@ -47,7 +60,7 @@ Colors are used both in discussion and list of sub-items to mark status of discu
 </div>
 <h2>Sub-items</h2>
 <table class='subnodes'><col class='id-col'><col class='name-col'><col class='note-col'>
-<th>Id<th>Name<th>Note
+<tr><th>Id<th>Name<th>Note
 <tr class='item'><td>1234<td>Sub-item<td>This is just example
 </table>
 </div>