mirror of https://github.com/tLDP/LDP
7183e6ad49 | ||
---|---|---|
.. | ||
README | ||
sample.txt | ||
txt2db.pl |
README
This is a utility to convert text files in a specific format into valid DocBook. Just pass it the input filename on the commmand line and you'll get a .sgml file out. It won't be a complete valid document, as it will have no header information or dtd specification. It's just a DocBook fragment, not a complete document. The following constructs are currently supported. If you need support for an addition construct, write discuss@linuxdoc.org if you're subscribed, or feedback@linuxdoc.org if you're not. Or just add it in the cvs. :-) =Title= <sect1><title>Title</title> <sect1> =Title|id= <sect1 id='id'><title>Title</title> <sect1> (works for other sect levels as well) ==Title== <sect2><title>Title</title> </sect2> ===Title=== <sect3><title>Title</title> </sect3> Foo <para>Foo</para> #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> [Foo] <filename>Foo</filename> '''Foo''' <emphasis>Foo</emphasis> Or, you can insert arbitrary DocBook. It cannot be embedded within anything else, though. In other words, you cannot have DocBook and one of the constructs above in the same line. Any text that starts with "<" is considered docbook, until the close tag is found. Tags can be nested arbitrarily deep. It won't be wrapped with <para> tags or anything, so you'll need to do that manually if you insert DocBook. <foo></foo> <foo></foo>