Difference between revisions of "Docbook Conventions"
From GnuCash
(First Draft with section No Direct Formating) |
m (→No Direct Formating: <Syntaxhighlight) |
||
| Line 2: | Line 2: | ||
==No Direct Formating== | ==No Direct Formating== | ||
Like for HTML you can use CSS, Docbook delegates the formating to xsl stylesheets. | Like for HTML you can use CSS, Docbook delegates the formating to xsl stylesheets. | ||
| − | <emphasis role="bold">Fat text</emphasis> | + | Markups like <Syntaxhighlight lang="xml"> |
| + | <emphasis role="bold">Fat text</emphasis> | ||
| + | </Syntaxhighlight> | ||
| + | are a bad idea. How should a screenreader interpret this? Do other elements exist which tell about the semantic of your string? A few examples: <Syntaxhighlight lang="xml"> | ||
<para> | <para> | ||
The <keycap>F1</keycap> key on an IBM PC keyboard generates the | The <keycap>F1</keycap> key on an IBM PC keyboard generates the | ||
Revision as of 05:55, 31 March 2019
Conventions to use while writing Documentation in Docbook
No Direct Formating
Like for HTML you can use CSS, Docbook delegates the formating to xsl stylesheets.
Markups like<emphasis role="bold">Fat text</emphasis>
<para>
The <keycap>F1</keycap> key on an IBM PC keyboard generates the
scan code <keycode>0x3B</keycode> when pressed. This value
is defined as <keysym>KEY_F1</keysym> in
<filename class="headerfile">keyboard.h</filename>.
</para>
<itemizedlist>
<title>Fields in the xyz Dialog</title>
<listitem><para><guilabel>Encoding</guilabel>: This is usually the UTF-8 variant.</para</listitem>
<listitem><para><guilabel>Magic</guilabel>: Mages will know.</para>
<warning><para>Do not use it!</para></warning>
</listitem>
<itemizedlist>
<para>
Typing <userinput>Ex</userinput> will match the <computeroutput>Expenses</computeroutput> section of the account list.
</para>
<para>
You can exit from GNU Emacs with
<menuchoice>
<shortcut>
<keycombo><keysym>C-x</keysym><keysym>C-c</keysym></keycombo>
</shortcut>
<guimenu>Files</guimenu>
<guimenuitem>Exit Emacs</guimenuitem>
</menuchoice>.
</para>
- See also
- Docbook Links
