gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2025-12-22 23:07:59 +01:00
Code Issues Projects Releases Wiki Activity

merge some minor documentation improvements

Browse Source
This commit is contained in:
Doug Kearns
2007-10-19 15:54:12 +00:00
parent bb7becfe41
commit 774f52064e
3 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
content/commands.js
View File

@@ -324,7 +324,7 @@ function Commands() //{{{
{ {
usage: ["bma[rk] [-t {title}] [url]"], usage: ["bma[rk] [-t {title}] [url]"],
short_help: "Add a bookmark", short_help: "Add a bookmark",
help: "If you don't add a custom title, either the title of the web page or the URL will be taken as the title.<br/>" + help: "If you don't add a custom title, either the title of the web page or the URL is taken as the title.<br/>" +
"You can omit the optional <code class=\"argument\">[url]</code> argument, so just do <code class=\"command\">:bmark</code> to bookmark the currently loaded web page with a default title and without any tags.<br/>" + "You can omit the optional <code class=\"argument\">[url]</code> argument, so just do <code class=\"command\">:bmark</code> to bookmark the currently loaded web page with a default title and without any tags.<br/>" +
" -t \"custom title\"<br/>" + " -t \"custom title\"<br/>" +
"The following options will be interpreted in the future:<br/>" + "The following options will be interpreted in the future:<br/>" +
@@ -339,7 +339,7 @@ function Commands() //{{{
usage: ["bmarks [filter]", "bmarks!"], usage: ["bmarks [filter]", "bmarks!"],
short_help: "Show bookmarks", short_help: "Show bookmarks",
help: "Open the message window at the bottom of the screen with all bookmarks which match <code class=\"argument\">[filter]</code> either in the title or URL.<br/>" + help: "Open the message window at the bottom of the screen with all bookmarks which match <code class=\"argument\">[filter]</code> either in the title or URL.<br/>" +
"The special version <code class=\"command\">:bmarks!</code> will open the default Firefox bookmarks window.<br/>" + "The special version <code class=\"command\">:bmarks!</code> opens the default Firefox bookmarks window.<br/>" +
"The following options WILL be interpreted in the future:<br/>" + "The following options WILL be interpreted in the future:<br/>" +
" -T comma,separated,tag,list<br/>", " -T comma,separated,tag,list<br/>",
completer: function(filter) { return vimperator.completion.get_bookmark_completions(filter); } completer: function(filter) { return vimperator.completion.get_bookmark_completions(filter); }
@@ -451,9 +451,9 @@ function Commands() //{{{
usage: ["delm[arks] {marks}", "delm[arks]!"], usage: ["delm[arks] {marks}", "delm[arks]!"],
short_help: "Delete the specified marks", short_help: "Delete the specified marks",
help: "Marks are presented as a list. Example:<br/>" + help: "Marks are presented as a list. Example:<br/>" +
"<code class=\"command\">:delmarks Aa b p</code> will delete marks A, a, b and p<br/>" + "<code class=\"command\">:delmarks Aa b p</code> deletes marks A, a, b and p<br/>" +
"<code class=\"command\">:delmarks b-p</code> will delete all marks in the range b to p<br/>" + "<code class=\"command\">:delmarks b-p</code> deletes all marks in the range b to p<br/>" +
"<code class=\"command\">:delmarks!</code> will delete all marks for the current buffer" "<code class=\"command\">:delmarks!</code> deletes all marks for the current buffer"
} }
)); ));
@@ -481,9 +481,9 @@ function Commands() //{{{
usage: ["delqm[arks] {marks}", "delqm[arks]!"], usage: ["delqm[arks] {marks}", "delqm[arks]!"],
short_help: "Delete the specified QuickMarks", short_help: "Delete the specified QuickMarks",
help: "QuickMarks are presented as a list. Example:<br/>" + help: "QuickMarks are presented as a list. Example:<br/>" +
"<code class=\"command\">:delqmarks Aa b p</code> will delete QuickMarks A, a, b and p<br/>" + "<code class=\"command\">:delqmarks Aa b p</code> deletes QuickMarks A, a, b and p<br/>" +
"<code class=\"command\">:delqmarks b-p</code> will delete all QuickMarks in the range b to p<br/>" + "<code class=\"command\">:delqmarks b-p</code> deletes all QuickMarks in the range b to p<br/>" +
"<code class=\"command\">:delqmarks!</code> will delete all QuickMarks" "<code class=\"command\">:delqmarks!</code> deletes all QuickMarks"
} }
)); ));
addDefaultCommand(new Command(["downl[oads]", "dl"], addDefaultCommand(new Command(["downl[oads]", "dl"],
@@ -557,7 +557,7 @@ function Commands() //{{{
{ {
usage: ["exe[cute] {expr1} [ ... ]"], usage: ["exe[cute] {expr1} [ ... ]"],
short_help: "Execute the string that results from the evaluation of {expr1} as an Ex command.", short_help: "Execute the string that results from the evaluation of {expr1} as an Ex command.",
help: "<code class=\"command\">:execute echo test</code> would show a message with the text &#34;test&#34;.<br/>" help: "Example: <code class=\"command\">:execute echo test</code> shows a message with the text &#34;test&#34;.<br/>"
} }
)); ));
addDefaultCommand(new Command(["exu[sage]"], addDefaultCommand(new Command(["exu[sage]"],
@@ -628,7 +628,7 @@ function Commands() //{{{
"<li><code class=\"command\">:help 'complete'</code> for options (surrounded by ' and ')</li>" + "<li><code class=\"command\">:help 'complete'</code> for options (surrounded by ' and ')</li>" +
"<li><code class=\"command\">:help o</code> for mappings (no pre- or postfix)</li>" + "<li><code class=\"command\">:help o</code> for mappings (no pre- or postfix)</li>" +
"</ul>" + "</ul>" +
"You can however use partial stings in the tab completion, so <code class=\"command\">:help he&lt;Tab&gt;</code> will complete <code class=\"command\">:help :help</code>.", "You can however use partial stings in the tab completion, so <code class=\"command\">:help he&lt;Tab&gt;</code> completes <code class=\"command\">:help :help</code>.",
completer: function(filter) { return vimperator.completion.get_help_completions(filter); } completer: function(filter) { return vimperator.completion.get_help_completions(filter); }
} }
)); ));
@@ -638,7 +638,7 @@ function Commands() //{{{
usage: ["hist[ory] [filter]", "history!"], usage: ["hist[ory] [filter]", "history!"],
short_help: "Show recently visited URLs", short_help: "Show recently visited URLs",
help: "Open the message window at the bottom of the screen with all history items which match <code class=\"argument\">[filter]</code> either in the title or URL.<br/>" + help: "Open the message window at the bottom of the screen with all history items which match <code class=\"argument\">[filter]</code> either in the title or URL.<br/>" +
"The special version <code class=\"command\">:history!</code> will open the default Firefox history window.", "The special version <code class=\"command\">:history!</code> opens the default Firefox history window.",
completer: function(filter) { return vimperator.completion.get_history_completions(filter); } completer: function(filter) { return vimperator.completion.get_history_completions(filter); }
} }
)); ));
@@ -682,9 +682,9 @@ function Commands() //{{{
usage: ["javas[cript] {cmd}", "javascript <<{endpattern}\\n{script}\\n{endpattern}", "javascript[!]"], // \\n is changed to <br/> in the help.js code usage: ["javas[cript] {cmd}", "javascript <<{endpattern}\\n{script}\\n{endpattern}", "javascript[!]"], // \\n is changed to <br/> in the help.js code
short_help: "Run any JavaScript command through eval()", short_help: "Run any JavaScript command through eval()",
help: "Acts as a JavaScript interpreter by passing the argument to <code>eval()</code>.<br/>" + help: "Acts as a JavaScript interpreter by passing the argument to <code>eval()</code>.<br/>" +
"<code class=\"command\">:javascript alert('Hello world')</code> would show a dialog box with the text \"Hello world\".<br/>" + "<code class=\"command\">:javascript alert('Hello world')</code> shows a dialog box with the text \"Hello world\".<br/>" +
"<code class=\"command\">:javascript &lt;&lt;EOF</code> would read all the lines until a line starting with 'EOF' is found, and will <code>eval()</code> them.<br/>" + "<code class=\"command\">:javascript &lt;&lt;EOF</code> reads all the lines until a line starting with 'EOF' is found, and interpret them with the JavaScript <code>eval()</code> function.<br/>" +
"The special version <code class=\"command\">:javascript!</code> will open the JavaScript console of Firefox.<br/>" + "The special version <code class=\"command\">:javascript!</code> opens the JavaScript console of Firefox.<br/>" +
"Rudimentary <code class=\"mapping\">&lt;Tab&gt;</code> completion is available for <code class=\"command\">:javascript {cmd}&lt;Tab&gt;</code> (but not yet for the " + "Rudimentary <code class=\"mapping\">&lt;Tab&gt;</code> completion is available for <code class=\"command\">:javascript {cmd}&lt;Tab&gt;</code> (but not yet for the " +
"<code class=\"command\">:js &lt;&lt;EOF</code> multiline widget). Be aware that Vimperator needs to run {cmd} through eval() " + "<code class=\"command\">:js &lt;&lt;EOF</code> multiline widget). Be aware that Vimperator needs to run {cmd} through eval() " +
"to get the completions, which could have unwanted side effects.", "to get the completions, which could have unwanted side effects.",
@@ -908,7 +908,7 @@ function Commands() //{{{
{ {
usage: ["norm[al][!] {commands}"], usage: ["norm[al][!] {commands}"],
short_help: "Execute Normal mode commands", short_help: "Execute Normal mode commands",
help: "<code class=\"command\">:normal 20j</code> would scroll 20 lines down." help: "Example: <code class=\"command\">:normal 20j</code> scrolls 20 lines down."
} }
)); ));
// TODO: remove duplication in :map // TODO: remove duplication in :map
@@ -988,20 +988,20 @@ function Commands() //{{{
"<ol>" + "<ol>" +
"<li>Transformed to a relative URL of the current location if it starts with . or .. or ...;<br/>" + "<li>Transformed to a relative URL of the current location if it starts with . or .. or ...;<br/>" +
"... is special and moves up the directory hierarchy as far as possible." + "... is special and moves up the directory hierarchy as far as possible." +
"<ul><li><code class=\"command\">:open ...</code> with current location <code>\"http://www.example.com/dir1/dir2/file.html\"</code> will open <code>\"http://www.example.com\"</code></li>" + "<ul><li><code class=\"command\">:open ...</code> with current location <code>\"http://www.example.com/dir1/dir2/file.html\"</code> opens <code>\"http://www.example.com\"</code></li>" +
"<li><code class=\"command\">:open ./foo.html</code> with current location <code>\"http://www.example.com/dir1/dir2/file.html\"</code> will open <code>\"http://www.example.com/dir1/dir2/foo.html\"</code></li></ul></li>" + "<li><code class=\"command\">:open ./foo.html</code> with current location <code>\"http://www.example.com/dir1/dir2/file.html\"</code> opens <code>\"http://www.example.com/dir1/dir2/foo.html\"</code></li></ul></li>" +
"<li>Opened with the specified search engine if the token looks like a search string " + "<li>Opened with the specified search engine if the token looks like a search string " +
"and the first word is the name of a search engine (<code class=\"command\">:open wikipedia linus torvalds</code> " + "and the first word is the name of a search engine (<code class=\"command\">:open wikipedia linus torvalds</code> " +
"will open the wikipedia entry for linus torvalds). The short name of a search engine is automatically guessed from its name. " + "opens the wikipedia entry for linus torvalds). The short name of a search engine is automatically guessed from its name. " +
"If you want to set a custom name, open the $FIREFOX_PROFILE/searchplugins/*.xml file of the search engine, and add/change " + "If you want to set a custom name, open the <var>$FIREFOX_PROFILE</var>/searchplugins/*.xml file of the search engine, and add/change " +
"&lt;Alias&gt;myalias&lt;/Alias&gt;</li>" + "&lt;Alias&gt;myalias&lt;/Alias&gt;</li>" +
"<li>Opened with the default search engine or keyword (specified with the <code class=\"option\">'defsearch'</code> option) " + "<li>Opened with the default search engine or keyword (specified with the <code class=\"option\">'defsearch'</code> option) " +
"if the first word is no search engine (<code class=\"command\">:open linus torvalds</code> will open a Google search for linux torvalds).</li>" + "if the first word is no search engine (<code class=\"command\">:open linus torvalds</code> opens a Google search for linux torvalds).</li>" +
"<li>Passed directly to Firefox in all other cases (<code class=\"command\">:open www.osnews.com, www.slashdot.org</code> will " + "<li>Passed directly to Firefox in all other cases (<code class=\"command\">:open www.osnews.com, www.slashdot.org</code> " +
"open OSNews in the current, and Slashdot in a new background tab).</li>" + "opens OSNews in the current, and Slashdot in a new background tab).</li>" +
"</ol>" + "</ol>" +
"You WILL be able to use <code class=\"command\">:open [-T \"linux\"] torvalds&lt;Tab&gt;</code> to complete bookmarks " + "You can use <code class=\"command\">:open -tags linux torvalds&lt;Tab&gt;</code> to complete bookmarks " +
"with tag \"linux\" and which contain \"torvalds\". Note that -T support is only available for tab completion, not for the actual command.<br/>" + "with tag \"linux\" and which contain \"torvalds\". Note that -tags support is only available for tab completion, not for the actual command.<br/>" +
"The items which are completed on <code class=\"mapping\">&lt;Tab&gt;</code> are specified in the <code class=\"option\">'complete'</code> option.<br/>" + "The items which are completed on <code class=\"mapping\">&lt;Tab&gt;</code> are specified in the <code class=\"option\">'complete'</code> option.<br/>" +
"Without argument, reloads the current page.<br/>" + "Without argument, reloads the current page.<br/>" +
"Without argument but with <code class=\"command\">!</code>, reloads the current page skipping the cache.", "Without argument but with <code class=\"command\">!</code>, reloads the current page skipping the cache.",
@@ -1308,8 +1308,8 @@ function Commands() //{{{
"<code class=\"command\">:set option!</code> and <code class=\"command\">:set invoption</code> invert the value of a boolean option.<br/>" + "<code class=\"command\">:set option!</code> and <code class=\"command\">:set invoption</code> invert the value of a boolean option.<br/>" +
"<code class=\"command\">:set option?</code> or <code class=\"command\">:set option</code>(for string and list options) shows the current value of an option.<br/>" + "<code class=\"command\">:set option?</code> or <code class=\"command\">:set option</code>(for string and list options) shows the current value of an option.<br/>" +
"<code class=\"command\">:set option&amp;</code> resets an option to its default value.<br/>" + "<code class=\"command\">:set option&amp;</code> resets an option to its default value.<br/>" +
"<code class=\"command\">:set option+={value}</code> and <code class=\"command\">:set option-={value}</code> will add/subtract {value} to a number option and append/remove {value} to a string option.<br/>" + "<code class=\"command\">:set option+={value}</code> and <code class=\"command\">:set option-={value}</code> adds/subtracts {value} to a number option and append/remove {value} to a string option.<br/>" +
"<code class=\"command\">:set all</code> will show the current value of all options and <code class=\"command\">:set all&amp;</code> will reset all options to their default values.<br/>", "<code class=\"command\">:set all</code> shows the current value of all options and <code class=\"command\">:set all&amp;</code> resets all options to their default values.<br/>",
completer: function(filter) { return vimperator.completion.get_options_completions(filter); } completer: function(filter) { return vimperator.completion.get_options_completions(filter); }
} }
)); ));
@@ -1386,7 +1386,7 @@ function Commands() //{{{
"NOTE: In both cases you must add functions to the global window object like shown above, functions written as:<br/>" + "NOTE: In both cases you must add functions to the global window object like shown above, functions written as:<br/>" +
"<code class=\"code\">function hello2() {<br/>&nbsp;&nbsp;alert(\"Hello world\");<br/>}<br/></code>are only available within the scope of the script. <br/><br/>" + "<code class=\"code\">function hello2() {<br/>&nbsp;&nbsp;alert(\"Hello world\");<br/>}<br/></code>are only available within the scope of the script. <br/><br/>" +
"The .vimperatorrc file in your home directory and any files in ~/.vimperator/plugin/ are always sourced at startup.<br/>" + "The .vimperatorrc file in your home directory and any files in ~/.vimperator/plugin/ are always sourced at startup.<br/>" +
"~ is supported as a shortcut for the $HOME directory.<br/>" + "~ is supported as a shortcut for the <var>$HOME</var> directory.<br/>" +
"If <code class=\"command\">!</code> is specified, errors are not printed.", "If <code class=\"command\">!</code> is specified, errors are not printed.",
completer: function(filter) { return vimperator.completion.get_file_completions(filter); } completer: function(filter) { return vimperator.completion.get_file_completions(filter); }
} }

8
content/help.js
View File

@@ -169,12 +169,12 @@ vimperator.help = function(section, easter) //{{{
'<li>Unix and Mac - ~/.vimperator/plugin</li>' + '<li>Unix and Mac - ~/.vimperator/plugin</li>' +
'<li>Windows - ~/vimperator/plugin</li>' + '<li>Windows - ~/vimperator/plugin</li>' +
'</ul>' + '</ul>' +
'<p>The user\'s $HOME(~) directory is determined as follows:</p>' + '<p>The user\'s <var>$HOME</var>(~) directory is determined as follows:</p>' +
'<ul>' + '<ul>' +
'<li>Unix and Mac - $HOME is used.</li>' + '<li>Unix and Mac - <var>$HOME</var> is used.</li>' +
'<li>Windows - if $HOME is set then this is used, otherwise $USERPROFILE or finally $HOMEDRIVE$HOMEPATH.</li>' + '<li>Windows - if <var>$HOME</var> is set then this is used, otherwise <var>$USERPROFILE</var> or finally <var>$HOMEDRIVE</var><var>$HOMEPATH</var>.</li>' +
'</ul>' + '</ul>' +
'$VIMPERATOR_HOME can be used to override the calculated $HOME directory.'; '<var>$VIMPERATOR_HOME</var> can be used to override the calculated <var>$HOME</var> directory.';
var mappings = '<span style="float: right"><code class="tag">mappings</code></span><h2 id="mappings">Mappings</h2>' + var mappings = '<span style="float: right"><code class="tag">mappings</code></span><h2 id="mappings">Mappings</h2>' +
'<p>The denotion of modifier keys is like in Vim, so C- means the Control key, M- the Meta key, A- the Alt key and S- the Shift key.</p>'+ '<p>The denotion of modifier keys is like in Vim, so C- means the Control key, M- the Meta key, A- the Alt key and S- the Shift key.</p>'+

4
content/mappings.js
View File

@@ -970,7 +970,7 @@ function Mappings() //{{{
short_help: "Search forward for a pattern", short_help: "Search forward for a pattern",
usage: ["/{pattern}[/]<CR>"], usage: ["/{pattern}[/]<CR>"],
help: "Search forward for the first occurance of <code class=\"argument\">{pattern}</code>.<br/>" + help: "Search forward for the first occurance of <code class=\"argument\">{pattern}</code>.<br/>" +
"When \"\\c\" appears anywhere in the pattern the whole pattern is handled as though <code class=\"option\">'ignorecase'</code> is on. " + "If \"\\c\" appears anywhere in the pattern the whole pattern is handled as though <code class=\"option\">'ignorecase'</code> is on. " +
"\"\\C\" forces case-sensitive matching for the whole pattern.<br/>" + "\"\\C\" forces case-sensitive matching for the whole pattern.<br/>" +
"If \"\\l\" appears in the pattern only the text of links is searched for a match as though <code class=\"option\">'linksearch'</code> is on. " + "If \"\\l\" appears in the pattern only the text of links is searched for a match as though <code class=\"option\">'linksearch'</code> is on. " +
"\"\\L\" forces the entire page to be searched for a match." "\"\\L\" forces the entire page to be searched for a match."
@@ -982,7 +982,7 @@ function Mappings() //{{{
short_help: "Search backwards for a pattern", short_help: "Search backwards for a pattern",
usage: ["?{pattern}[?]<CR>"], usage: ["?{pattern}[?]<CR>"],
help: "Search backward for the first occurance of <code class=\"argument\">{pattern}</code>.<br/>" + help: "Search backward for the first occurance of <code class=\"argument\">{pattern}</code>.<br/>" +
"When \"\\c\" appears anywhere in the pattern the whole pattern is handled as though <code class=\"option\">'ignorecase'</code> is on. " + "If \"\\c\" appears anywhere in the pattern the whole pattern is handled as though <code class=\"option\">'ignorecase'</code> is on. " +
"\"\\C\" forces case-sensitive matching for the whole pattern.<br/>" + "\"\\C\" forces case-sensitive matching for the whole pattern.<br/>" +
"If \"\\l\" appears in the pattern only the text of links is searched for a match as though <code class=\"option\">'linksearch'</code> is on. " + "If \"\\l\" appears in the pattern only the text of links is searched for a match as though <code class=\"option\">'linksearch'</code> is on. " +
"\"\\L\" forces the entire page to be searched for a match.<br/>" + "\"\\L\" forces the entire page to be searched for a match.<br/>" +