mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-03-04 06:55:45 +01:00
fixed small help issue
This commit is contained in:
@@ -37,12 +37,11 @@ HEADER=<span style="float: right; padding-top: 10px;"><form action="https://www.
|
|||||||
|
|
||||||
# maximum 3 tags for now
|
# maximum 3 tags for now
|
||||||
[section-inlinemacro]
|
[section-inlinemacro]
|
||||||
<a id="{target}" />
|
|
||||||
<table style="border-bottom: 1px solid silver; width: 100%">
|
<table style="border-bottom: 1px solid silver; width: 100%">
|
||||||
<tr width="100%"><td width="50%"><h2>{target}</h2></td><td width="50%">
|
<tr width="100%"><td width="50%"><h2>{target}</h2></td><td width="50%">
|
||||||
{3? <span class="tag section">{3}</span>}
|
{3? <a id="{3}"/><span class="tag section">{3}</span>}
|
||||||
{2? <span class="tag section">{2}</span>}
|
{2? <a id="{2}"/><span class="tag section">{2}</span>}
|
||||||
{1? <span class="tag section">{1}</span>}
|
{1? <a id="{1}"/><span class="tag section">{1}</span>}
|
||||||
</td></tr>
|
</td></tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|||||||
@@ -6,10 +6,10 @@ For every new feature, writing documentation is _mandatory_ for the patch to
|
|||||||
be accepted. The docs are written in
|
be accepted. The docs are written in
|
||||||
http://www.methods.co.nz/asciidoc/userguide.html[asciidoc] version 8.x or
|
http://www.methods.co.nz/asciidoc/userguide.html[asciidoc] version 8.x or
|
||||||
newer. The are placed in the _src/locale/en-US/_ directory and compiled with
|
newer. The are placed in the _src/locale/en-US/_ directory and compiled with
|
||||||
{{make doc}}. Please refer to the asciidoc documentation above for details.
|
_make doc_. Please refer to the asciidoc documentation above for details.
|
||||||
Usually you can just write text as is, and mostly it will be interpreted
|
Usually you can just write text as is, and mostly it will be interpreted
|
||||||
correctly. The only difficult part is to write special sections like for
|
correctly. The only difficult part is to write special sections like for
|
||||||
help::help[various.html,:help].
|
help::help[various.html#:help].
|
||||||
|
|
||||||
|
|
||||||
|<F1>| |:help| |:h| |help|
|
|<F1>| |:help| |:h| |help|
|
||||||
@@ -40,6 +40,11 @@ vimperator documentation:
|
|||||||
|
|
||||||
- *$$section:Writing{nbsp}Documentation[writing-docs,documentation]$$* Creates
|
- *$$section:Writing{nbsp}Documentation[writing-docs,documentation]$$* Creates
|
||||||
a new section like _Writing Documentation_ in this help file with 2 tags.
|
a new section like _Writing Documentation_ in this help file with 2 tags.
|
||||||
- *$$help:developer{nbsp}information[developer.html,documentation]$$* creates
|
- *$$help:developer{nbsp}information[developer.html#documentation]$$* creates
|
||||||
a link with text _developer information_ to the tag _documentation_ in
|
a link with text _developer information_ to the tag _documentation_ in
|
||||||
the file _developer.html_.
|
the file _developer.html_.
|
||||||
|
|
||||||
|
If you don't know in which file/section you should put some documentation, ask
|
||||||
|
on the mailing list or on #vimperator. Usually help should be grouped together
|
||||||
|
in logically connected subject areas like
|
||||||
|
help:opening{nbsp}web{nbsp}pages[browsing.html#opening].
|
||||||
|
|||||||
Reference in New Issue
Block a user