mirror of https://github.com/tLDP/LDP
updated
This commit is contained in:
gferg
parent
ec5bfaffef
commit
6ab94acedb
|
|
@ -15,13 +15,16 @@
|
|||
|
||||
<!--
|
||||
<revhistory>
|
||||
<revision>
|
||||
<revnumber>1.1.5</revnumber>
|
||||
<date>2002-01-27</date>
|
||||
</revision>
|
||||
|
||||
<revision>
|
||||
<revnumber>1.1.2pre2</revnumber> <date>2001-11-20</date> <authorinitials>dag</authorinitials>
|
||||
<revremark>Usual updates and fixes</revremark>
|
||||
</revision>
|
||||
</revhistory>
|
||||
|
||||
<revhistory>
|
||||
<revision>
|
||||
<revnumber>1.1.1</revnumber> <date>2001-06-01</date> <authorinitials>dag</authorinitials>
|
||||
<revremark>Converted to DocBook v4.1</revremark>
|
||||
|
|
|
|||
|
|
@ -252,7 +252,7 @@ described are windows-1251, iso-8859-5 and koi8-ru.
|
|||
Belgian-HOWTO</ULink>,
|
||||
<CiteTitle>The Belgian HOWTO</CiteTitle>
|
||||
</Para><Para>
|
||||
<CiteTitle>Updated: May 2001</CiteTitle>.
|
||||
<CiteTitle>Updated: January 2002</CiteTitle>.
|
||||
How to tweak Linux for Belgian users; lists Linux user groups,
|
||||
businesses and other resources in Belgium. </Para>
|
||||
</ListItem>
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ described are windows-1251, iso-8859-5 and koi8-ru.
|
|||
Belgian-HOWTO</ULink>,
|
||||
<CiteTitle>The Belgian HOWTO</CiteTitle>
|
||||
</Para><Para>
|
||||
<CiteTitle>Updated: May 2001</CiteTitle>.
|
||||
<CiteTitle>Updated: January 2002</CiteTitle>.
|
||||
How to tweak Linux for Belgian users; lists Linux user groups,
|
||||
businesses and other resources in Belgium. </Para>
|
||||
</ListItem>
|
||||
|
|
|
|||
|
|
@ -10,19 +10,26 @@
|
|||
|
||||
</abstract>
|
||||
<author>
|
||||
<firstname>David Merrill</firstname>
|
||||
<affiliation>
|
||||
<address>
|
||||
<firstname>David Merrill</firstname>
|
||||
<email><ulink url='mailto:david@lupercalia.net'><citetitle>david@lupercalia.net</citetitle></ulink></email>
|
||||
</address>
|
||||
</affiliation>
|
||||
</author>
|
||||
<revhistory>
|
||||
<revision>
|
||||
<revnumber>1.1</revnumber>
|
||||
<date>2002-01-25</date>
|
||||
<authorinitials>dcm</authorinitials>
|
||||
<revremark>Added QandASet section.</revremark>
|
||||
</revision>
|
||||
</revhistory>
|
||||
<revision>
|
||||
<revnumber>1.0</revnumber>
|
||||
<date>2002-01-23</date>
|
||||
<authorinitials>dcm</authorinitials>
|
||||
<revremark>Initial release.</revremark>
|
||||
</revision>
|
||||
</revhistory>
|
||||
</articleinfo>
|
||||
<sect1 id='legal'><title id='legal-title'>Legalities</title>
|
||||
|
|
@ -34,6 +41,7 @@
|
|||
</sect1>
|
||||
<sect1 id='whats-a-wiki'><title id='whats-a-wiki-title'>What Is a Wiki?</title>
|
||||
<para>A Wiki is a kind of a website, where anyone who is reading the site can also edit it. While the LDP isn't going to implement that kind of permissive editing, we do really like the way the Wiki editing works. Instead of having to learn html tags, you enter your information in plain text. The Wiki software takes that plain text, and converts it into html to display it. </para>
|
||||
<para>In our case, we convert not into html, but into DocBook. Then that DocBook gets fed into our regular publication systems just as if you had written it in DocBook originally. </para>
|
||||
<para>If you've never used a WikiWikiWeb, see <ulink url='http://www.wikipedia.com'><citetitle>http://www.wikipedia.com</citetitle></ulink> for a good example of a thriving Wiki. </para>
|
||||
<para>Common functions like creating a link, a bulleted list, a numbered list, and section headings are made quick and easy. We wanted to provide that same level of ease for LDP authors, so I wrote a utility that would take a text format similar to the one used in Wikis (we call it WikiText), and combine it with the meta-data in the <ulink url='http://db.linuxdoc.org'><citetitle>LDP Database</citetitle></ulink> to generate DocBook. </para>
|
||||
</sect1>
|
||||
|
|
@ -54,14 +62,12 @@
|
|||
<listitem><para>It's WYSIWYG. There's a "Preview" feature, so you can click the "Preview" button and see how your document will look on the LDP site. There are no utilities to run, nothing to learn, no DTDs to install or catalog files to munge with. If you've ever tried to get a working DocBook system on your machine, you will appreciate this! :-) </para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</sect1>
|
||||
</sect1>
|
||||
<sect1 id='how-does-it-work'><title id='how-does-it-work-title'>How Does It Work?</title>
|
||||
<para>We tried to use the same text hints that are used on the Wikipedia, which came from UseModWiki. There are some differences between different Wiki systems, but most of them are quite similar to this one, and it has proved itself through use. </para>
|
||||
<para>A blank line separates paragraphs, and there are other hints for making sections, bulleted lists, links, filenames, etc. </para>
|
||||
<sect2 id='sections'><title id='sections-title'>Sections</title>
|
||||
<programlisting>
|
||||
|
||||
|
||||
=Introduction|intro=
|
||||
</programlisting>
|
||||
<para>creates a new top level section. See the pipe character followed by "intro"? Many hints provide for an "id", and this is how you supply it. For sections, the id will become the output filename (intro.html, in the first example), or the html "tag" used for intradocument linking. </para>
|
||||
|
|
@ -80,8 +86,9 @@
|
|||
#one
|
||||
#two
|
||||
#three
|
||||
/#
|
||||
</programlisting>
|
||||
<para>The "#" prefix says to make a numbered list. If you leave a blank line anywhere, the numbered list "ends", so hitting another "#" will begin numbering over again at "1". If you need to put blank lines (paragraphs) inside the list, you have to do your paragraphs manually. </para>
|
||||
<para>The "#" prefix says to make a numbered list. The numbered list continues until the end of the current section, or until it hits a line with only "/#", which closes the list. After opening another "#" list, the numbering will begin over again at "1". </para>
|
||||
<para>Here is how the above block will appear in the final document: </para>
|
||||
|
||||
<orderedlist>
|
||||
|
|
@ -92,13 +99,14 @@
|
|||
<listitem><para>three </para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</sect3>
|
||||
</sect3>
|
||||
<sect3 id='bulleted-lists'><title id='bulleted-lists-title'>Bulleted Lists</title>
|
||||
<para>Bulleted lists work almost the same, except you use the "*" hint, and you don't have to worry about renumbering issues: </para>
|
||||
<programlisting>
|
||||
*one
|
||||
*two
|
||||
*three
|
||||
/*
|
||||
</programlisting>
|
||||
<para>Here's how the above block will appear in the final document: </para>
|
||||
|
||||
|
|
@ -110,7 +118,7 @@
|
|||
<listitem><para>three </para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect3>
|
||||
</sect3>
|
||||
</sect2>
|
||||
<sect2 id='links'><title id='links-title'>Links</title>
|
||||
<para>Use the square brackets to identify links, like this: </para>
|
||||
|
|
@ -125,9 +133,10 @@
|
|||
<para>When you use the "ldp:" namespace, WikiText will look up the document that you named in the LDP database, and generate a link to it. </para>
|
||||
<para>Note: we're still working on entering the correct "name" in all of our database records, so only a few are working. But don't worry. Just let us know if you need to use a link that isn't correct yet and we'll fix it right away. </para>
|
||||
<para>The second special namespace is the "wiki:" namespace. It will generate a link to the article on the Wikipedia, an open source encyclopedia project. We hope to mirror some of the most appropriate articles from the Wikipedia right on the LDP. Wikipedia has many great articles on computer related topics that aren't the kind of information we do at the LDP, but which would complement our documents very well. For instance, there are articles on virtual memory, operating systems, and so on. For now, your link will go to the live Wikipedia site. Eventually, it will go to a mirror on our site, but with a link to the "real" site. </para>
|
||||
<para>The following link goes to the article called "Operating System" on the Wikipedia: </para>
|
||||
<para>The following links go to articles called "Operating system" and "Linux kernel" on the Wikipedia: </para>
|
||||
<programlisting>
|
||||
[[wiki:Operating System]]
|
||||
[[wiki:Operating system]]
|
||||
[[wiki:Linux kernel]]
|
||||
</programlisting>
|
||||
<para>Wikipedia is a great resource for all Netizens. Both the software they use and their content are open source. </para>
|
||||
</sect2>
|
||||
|
|
@ -145,6 +154,30 @@
|
|||
</programlisting>
|
||||
<para>That will render like: <emphasis>Wow!</emphasis> </para>
|
||||
</sect2>
|
||||
<sect2 id='qandasets'><title id='qandasets-title'>QandASets</title>
|
||||
<para>You can create question and answer sets if you're writing a FAQ, or if you have a FAQ section in your document. Just make "Q:" and "A:" the first characters on a new line, and the QandASet tags will automatically be created. </para>
|
||||
<programlisting>
|
||||
Q: What if you want to do DocBook that isn't supported by WikiText?
|
||||
|
||||
A: Mu.
|
||||
</programlisting>
|
||||
<para>And this is how the example renders. Notice that a list of questions appears right before the first question. This looks a bit silly in this example, since there is only one question and it just gets repeated twice. If you're working on the <ulink url='http://www.linuxdoc.org/FAQ/Linux-FAQ/'><citetitle>Linux-FAQ</citetitle></ulink>, though, it's really nice. </para>
|
||||
<qandaset defaultlabel='qanda'>
|
||||
<qandaentry>
|
||||
<question><para>What if you want to do DocBook that isn't supported by WikiText?</para></question>
|
||||
<answer><para>Mu. See the next section. </para>
|
||||
</answer>
|
||||
</qandaentry>
|
||||
</qandaset>
|
||||
</sect2>
|
||||
<sect2 id='fancy'><title id='fancy-title'>Fancy Stuff</title>
|
||||
<para>There is no DocBook structure that is not supported by WikiText. Why? Because if there is no WikiText for it, you can just put the tags you need directly into the document, and they will work. </para>
|
||||
<para>There are a few "special" tags that are not inline DocBook, but section structures, among them the "programlisting" and "screen" tags. You should keep in mind that none of the WikiText functions will work inside these tags. You don't want commented lines in your code sample converted into numbered lists, do you? </para>
|
||||
<programlisting>
|
||||
# this is a comment
|
||||
# it is NOT a numbered list!
|
||||
</programlisting>
|
||||
</sect2>
|
||||
</sect1>
|
||||
<sect1 id='meta-data'><title id='meta-data-title'>But What About the Meta-Data?</title>
|
||||
<para>You do not need to enter any articleheader or articleinfo information into your document. That information is pulled directly from the database itself. Go to your document's edit page, and enter the appropriate information there. </para>
|
||||
|
|
|
|||
Loading…
Reference in New Issue