LDP
/
LDP
mirror of https://github.com/tLDP/LDP
0
1
Fork 0
Code Releases Activity

Adding command prompt detailed information.

This commit is contained in:
emmajane 2003-12-08 01:34:52 +00:00
parent 96ed5ced6d
commit 4351c68248
2 changed files with 68 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
LDP/guide/docbook/LDP-Author-Guide/references.xml
View File

@ -327,6 +327,14 @@ IDE" http://www.linuxjournal.com/article.php?sid=576
Vim book by Steve Oualline published by O'Reilly
http://www.newriders.com/books/opl/ebooks/0735710015.html
<section id="ref-transform">
These tools are used with the TLDP-XSL stylesheets and there
> is a short HOWTO on usage included in that package that gives
> examples
> of processing with Saxon and Apache FOP. ~ David Horton
http://my.core.com/~dhorton/docbook/tldp-xsl/
</section>
<section id="ref-licenses">
<title>Documentation Licenses</title>

65
LDP/guide/docbook/LDP-Author-Guide/using-docbook.xml
View File

@ -456,7 +456,7 @@ class="starttag">xref linkend="secao" /</sgmltag> for more information.</program
</section>
<section id="section">
<title>section and sectN: what's the difference?</title>
<title><sgmltag>section</sgmltag> and <sgmltag>sectN</sgmltag>: what's the difference?</title>
<note><para>
These notes were provided by:
@ -509,6 +509,59 @@ structured data, by using querying languages for XML (XPath and XQuery).
</section> <!-- section and sectN -->
<section id="commandprompt">
<title>Command Prompts</title>
<para>
There are likely as many ways of doing this as there are DocBook
authors; however, here are two ways that you might find useful.
Thanks to <ulink url="http://www.pratapgarh.com/appaji">Y Giridhar Appaji Nag</ulink>
<ulink url="http://www.wonderfrog.net">Martin Brown</ulink>
for the markup used here.
</para>
<example id="example-markup-command-1">
<title>Command Prompt--Version One</title>
<sgmltag>programlisting</sgmltag>
<sgmltag>prompt</sgmltag># <sgmltag class="endtag">prompt</sgmltag><sgmltag>userinput</sgmltag>cd /some/dir<sgmltag class="endtag">userinput</sgmltag>
<sgmltag>prompt</sgmltag># <sgmltag class="endtag">prompt</sgmltag><sgmltag>userinput</sgmltag>ls -l<sgmltag class="endtag">userinput</sgmltag>
<sgmltag class="endtag">programlisting<sgmltag>
<programlisting>
<prompt># </prompt><userinput>cd /some/dir</userinput>
<prompt># </prompt><userinput>ls -l</userinput>
</programlisting>
</example>
<example id="example-markup-command-2">
<title>Command Prompt--Version Two</title>
<para>
First make an <quote>entity</quote> which is a shortcut
for the longer prompt which is used.
&lt;!ENTITY prompt "&lt;prompt&gt;[user@machine
~/dir]$&lt;/prompt&gt;"&gt;
</para>
<note><para>
For more information about entities, read <xref
linkend="tools-entities" />.
</para></note>
<sgmltag>screen</sgmltag>
<sgmltag>prompt</sgmltag>&amp;prompt; <sgmltag
class="endtag">prompt</sgmltag><sgmltag>userinput</sgmltag>cd
/some/dir<sgmltag class="endtag">userinput</sgmltag>
<sgmltag>prompt</sgmltag>&amp;prompt; <sgmltag
class="endtag">prompt</sgmltag><sgmltag>userinput</sgmltag>ls
-l<sgmltag class="endtag">userinput</sgmltag> <sgmltag
class="endtag">screen<sgmltag>
<screen>
<prompt>[user@machine ~/dir]$ </prompt><userinput>cd /some/dir</userinput>
<prompt>[user@machine ~/dir]$ </prompt><userinput>ls -l</userinput>
</screen>
</example>
</section>
<section id="encoding-index">
<title>Encoding Indexes</title>
@ -1004,9 +1057,11 @@ e</sgmltag></programlisting>
Entities</title> <screen>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ &lt;-- I can
add comments here --&gt; &lt;!ENTITY shortcut "Replace 'shortcut' with
this text."&gt; &lt;!ENTITY sc-to-a-file SYSTEM "anotherfile.xml"&gt;
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
&lt;-- I can add comments here --&gt;
&lt;!ENTITY shortcut "Replace 'shortcut' with this text."&gt;
&lt;!ENTITY sc-to-a-file SYSTEM "anotherfile.xml"&gt;
&lt;-- note: the square bracket on the third line is closed on the next
line--&gt; ]&gt;
</screen> </example>
@ -1031,7 +1086,7 @@ line--&gt; ]&gt;
<example id="ex-entity-parameters">
<title>Use of parameter entities</title> <programlisting>
<sgmltag class="starttag">!entity % review "INCLUDE"</sgmltag> ...
<sgmltag class="starttag">!ENTITY % review "INCLUDE"</sgmltag> ...
<sgmltag class="starttag">![%review;[ &lt;para&gt;This paragraph will
be included on the draft when the entity "review" is defined with the
value "INCLUDE". &lt;/para&gt; ]]</sgmltag>