From: Michal Vaner <vorner@ucw.cz>
Date: Mon, 1 Sep 2008 13:46:12 +0000 (+0200)
Subject: Jump help
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=1aa252965ad119a48a360f905377a452904d210c;p=pciids.git

Jump help
---

diff --git a/PciIds/Html/Handler.pm b/PciIds/Html/Handler.pm
index dfb518a..aa38876 100644
--- a/PciIds/Html/Handler.pm
+++ b/PciIds/Html/Handler.pm
@@ -54,7 +54,8 @@ my %handlers = (
 		'profile' => \&PciIds::Html::Users::profileFormSubmit,
 		'admin' => \&PciIds::Html::Admin::submitAdminForm,
 		'notifications' => \&PciIds::Html::Notifications::notifFormSubmit,
-		'jump' => \&PciIds::Html::Jump::jump
+		'jump' => \&PciIds::Html::Jump::jump,
+		'help' => \&PciIds::Html::Help::getHelp
 	}
 );
 
diff --git a/help/index b/help/index
index e8983c5..b5a10a3 100644
--- a/help/index
+++ b/help/index
@@ -2,6 +2,7 @@ Help index
 <h2>Read only operations</h2>
 <ul class='navigation'>
 	<li><a href='$HELP_URL$list'>Browsing</a>
+	<li><a href='$HELP_URL$jump'>Jumping</a>
 </ul>
 <h2>Account based operations</h2>
 <ul class='navigation'>
diff --git a/help/jump b/help/jump
new file mode 100644
index 0000000..8f58fb0
--- /dev/null
+++ b/help/jump
@@ -0,0 +1,32 @@
+Jumping
+The jump box (little text box with '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.
+
+<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 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 '#'.
+
+<h2>Examples</h2>
+<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>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.
+</ul>
diff --git a/help/list b/help/list
index 3b37d5c..b403c85 100644
--- a/help/list
+++ b/help/list
@@ -28,6 +28,7 @@ Colors are used both in discussion and list of sub-items to mark status of discu
 <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>