LDP/LDP/wt2db/README

This is wt2db version 0.1.

wt2db is a utility to convert text files in WikiText format into
DocBook.  It generates a DocBook fragment, not valid DocBook.


Reporting Bugs
--------------

Bugs should be reported at sourceforge.net/projects/linuxdoc. Select
'wt2db' in the 'Category' field.


WikiText Tags
-------------

The following constructs are currently supported.

Foo			<para>Foo</para>

=Title=			<sect1><title>Title</title>
			</sect1>

=Title|id=		<sect1 id='id'><title>Title</title>
			</sect1>

			works for other sect levels as well, and many other
			tags. It is either the "id" value, or the "title"
			value, depending on the semantics of the particular
			tag. Usage should be obvious in context.

==Title==		<sect2><title>Title</title>
			</sect2>

===Title===		<sect3><title>Title</title>
			</sect3>


#Foo			<orderedlist>
#Bar			<listitem><para>Foo</para></listitem>
#Baz			<listitem><para>Bar</para></listitem>
/#			<listitem><para>Baz</para></listitem>
			</orderedlist>

*Foo			<simplelist>
*Bar			<listitem><para>Foo</para></listitem>
*Baz			<listitem><para>Bar</para></listitem>
/*			<listitem><para>Baz</para></listitem>
			</simplelist>

[[http://foo.org]]	<ulink url='http://foo.org'>
			  <citetitle>http://foo.org</citetitle>
			</ulink>

[[http://foo.org Foo]]	<ulink url='http://foo.org'>
			  <citetitle>Foo</citetitle>
			</ulink>

[http://foo.org|Foo]]	You can also delimit with the pipe character "|".
			This works on any of these [[]] tags.

[[file:Foo]]		<filename>Foo</filename>

'''Foo'''		<emphasis>Foo</emphasis>

A few DocBook structures do not have <para> tags wrapped around them. They
are <para> itself (duh!), <sect?> and <programlisting>. If you insert anything
using these tags, no <para> tags will be wrapped around it or inserted into it.
So if you want fine control over your <para> tags, insert them yourself.

These tags include:

<programlisting/>
<screen/>