mirror of https://github.com/tLDP/LDP
88 lines
2.7 KiB
HTML
Executable File
88 lines
2.7 KiB
HTML
Executable File
<html>
|
|
<head>
|
|
<title>LDP Document Database</title>
|
|
<link rel=stylesheet href="/ldp.css" type="text/css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h2>Wiki Help</h2>
|
|
|
|
<a href="/index.html">Index</a>
|
|
<a href="/cgi-bin/document_list.pl">Documents</a>
|
|
<a href='/cgi-bin/topic_list.pl'>Topics</a>
|
|
<a href='/cgi-bin/maintainer_list.pl'>Maintainers</a>
|
|
<a href='/cgi-bin/editor_list.pl'>Editors</a>
|
|
<a href='/cgi-bin/ldp_stats.pl'>Statistics</a>
|
|
<a href='/help/'>Help</a>
|
|
|
|
<p>The LDP is currently experimenting with Wiki-style editing for selected documents.
|
|
The Wiki functionality allows permitted users to edit documents online, using
|
|
a web interface.
|
|
|
|
<p>To edit your document, click the "Edit" link in the upper right of the Meta-data
|
|
area on your document's edit page. Only the administrators and the author of a given
|
|
document can edit it.
|
|
|
|
<p>You can use a simplified text based format to write your documentation, so you
|
|
do not need to use DocBook. It uses a utility called txt2db. The following excerpt
|
|
from the README for txt2db explains how to use it:
|
|
|
|
<pre>
|
|
TEXT FORMAT DOCBOOK OUTPUT
|
|
|
|
=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>
|
|
|
|
<foo></foo> <foo></foo>
|
|
|
|
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.
|
|
</pre>
|
|
|
|
</body>
|
|
</html>
|