From: Michal Vaner <vorner@ucw.cz>
Date: Sat, 30 Aug 2008 14:29:56 +0000 (+0200)
Subject: Help for editation
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=da3d2fd5f193554a13450929a5e3a2febfac3b83;p=pciids.git

Help for editation
---

diff --git a/PciIds/Html/Changes.pm b/PciIds/Html/Changes.pm
index d442744..2fa3d2c 100644
--- a/PciIds/Html/Changes.pm
+++ b/PciIds/Html/Changes.pm
@@ -16,7 +16,7 @@ sub genNewItemForm( $$$$$$ ) {
 	my $prettyAddr = encode( $address->pretty() );
 	genHtmlHead( $req, "$prettyAddr - add new item", undef );
 	print "<h1>$prettyAddr - add new item</h1>\n";
-	genLocMenu( $req, $args, [ logItem( $auth ), $address->canDiscuss() ? [ 'Discuss', 'newhistory' ] : (), [ 'Notifications', 'notifications' ] ] );
+	genLocMenu( $req, $args, [ logItem( $auth ), $address->canDiscuss() ? [ 'Discuss', 'newhistory' ] : (), [ 'Notifications', 'notifications' ], [ 'Help', 'help', 'newitem' ] ] );
 	print "<div class='error'>$error</div>\n" if( defined $error );
 	print "<form name='newitem' id='newitem' method='POST' action=''>\n<table>";
 	genFormEx( [ [ 'input', 'Id:', 'text', 'id', 'maxlength="50"' ],
@@ -89,7 +89,7 @@ sub genNewHistoryForm( $$$$$$ ) {
 	my $prettyAddr = encode( $address->pretty() );
 	genHtmlHead( $req, "$prettyAddr - discuss", undef );
 	print "<h1>$prettyAddr - discuss</h1>\n";
-	genLocMenu( $req, $args, [ logItem( $auth ), $address->canAddItem() ? [ 'Add item', 'newitem' ] : (), [ 'Notifications', 'notifications' ] ] );
+	genLocMenu( $req, $args, [ logItem( $auth ), $address->canAddItem() ? [ 'Add item', 'newitem' ] : (), [ 'Notifications', 'notifications' ], [ 'Help', 'help', 'newhistory' ] ] );
 	print "<div class='error'>$error</div>\n" if( defined $error );
 	print "<form name='newhistory' id='newhistory' method='POST' action=''>\n<table>";
 	genFormEx( [ [ 'textarea', 'Text:', undef, 'text', 'rows="5" cols="50"' ],
diff --git a/help/newhistory b/help/newhistory
new file mode 100644
index 0000000..b2fbd85
--- /dev/null
+++ b/help/newhistory
@@ -0,0 +1,27 @@
+Discussion
+<p>
+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 <a href='$AC_URL$newhistory'>discuss</a> link.
+<p>
+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.
+<p>
+You can request item deletion here, too.
+
+<h2>Approval</h2>
+<p>
+All submissions are checked by an admin for errors.
+Please try to provide valid information.
+You should check specific help for corresponding ID type:
+<ul class='navigation'>
+	<li><a href='$HELP_URL$pci'>PCI devices</a>
+	<li><a href='$HELP_URL$pci_class'>PCI device classes</a>
+</ul>
+
+<h2>See also</h2>
+<p>
+You can create <a href='$HELP_URL$newitem'>new items</a>.
+<p>
+If you want to know about changes in some item, set up <a href='$HELP_URL$notifications'>a notification</a>.
diff --git a/help/newitem b/help/newitem
new file mode 100644
index 0000000..c98f0e4
--- /dev/null
+++ b/help/newitem
@@ -0,0 +1,35 @@
+Add a new item
+<p>
+If you know about an ID not present here, you can submit it.
+Browse to the item which should contain it and click <a href='$AC_URL$newitem'>add item</a> link.
+<p>
+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 <tt>1234:5678</tt> and the vendor <tt>1234</tt> already exists, you enter only <tt>5678</tt>).
+If you know chip name, it is preferred over marketing name.
+<p>
+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.
+<p>
+Both note and discussion is optional.
+<p>
+After you submit it, it will wait approval of an admin.
+
+<h2>Approval</h2>
+<p>
+Each item is checked and approved by an admin.
+It is because not all submissions are correct.
+<p>
+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:
+<ul class='navigation'>
+	<li><a href='$HELP_URL$pci'>PCI devices</a>
+	<li><a href='$HELP_URL$pci_class'>PCI device classes</a>
+</ul>
+
+<h2>See also</h2>
+<p>
+Once item is submitted, it is not sealed for ever. You can <a href='$HELP_URL$newhistory'>discuss</a> existing items and suggest them new names.
+<p>
+If you are interested in changes in some item (or its whole subtree), you can let the system send you <a href='$HELP_URL$notifications'>notifications</a>.