Online Editing, Wiki-style
We are working to provide simple online editing functions for authors
who desire to use it, something similar to a WikiWikiWeb. It won't
have all the functionality that a true Wiki has, but it will provide tracking
of recent changes and the ability to diff between versions as well as a diff
from the authoritative cvs version.
Because we have had feedback from authors who are concerned about having to
learn something new, or having to track changes to two versions,
the web interface will be completely optional at the request of the author.
Authors who like using the cvs or mailing
their updates by email may continue to do so as usual.
I hope to have at least some minimal functionality to report in next week's
LDPWN.
Thanks go to Martin Wheeler for the original idea.
Is It DocBook, Or Is It Text?
A side project that came out of the original "Wiki" idea
is a utility that converts from a very simple Wiki-style text format into DocBook,
the very large and complex XML DTD that we use to store our documentation.
It's hard to explain, so here is an example. Here is a trivial DocBook fragment
in standard DocBook format:
<sect1><title id='intro'>Introduction</title>
<para>
Welcome to the
<ulink url='http://www.linuxdoc.org'>
<citetitle>Linux Documentation Project</citetitle>
</ulink>
</para>
</sect1>
Even in this extremely simple example, you can see that DocBook can be verbose.
Some would say that is a great understatement. :-)
That's one of the reasons many
authors continue to work in LinuxDoc, which is simpler but less powerful.
In the simplified text format, this becomes:
=Introduction|intro=
Welcome to the [[http://www.linuxdoc.org|Linux Documentation Project]]
The simplified text format will not even begin to cover all of the many tags
that DocBook provides. That would be a losing battle. Rather than fight that losing
battle, we're allowing for DocBook to be inserted inline into the text.
Unfortunately we have not yet figured out a way to do it the other way around --
you won't be able to insert the text hints inside any DocBook structures.
New Documents
Updated Documents
- Apache Compile HOWTO (Linux edition)
http://www.linuxdoc.org/HOWTO/Apache-Compile-HOWTO/
Version 1.9.7, Luc de Louw, luc@delouw.ch
- C++ Programming HOW-TO
http://www.linuxdoc.org/HOWTO/C++Programming-HOWTO.html
Version 40.9, Al Dev, alavoor@yahoo.com
- C-C++ Beautifier HOW-TO
http://www.linuxdoc.org/HOWTO/C-C++Beautifier-HOWTO.html
Version 15.3, Al Dev, alavoor@yahoo.com
- CDServer-HOWTO
http://www.linuxdoc.org/HOWTO/CDServer-HOWTO/
Version 1.40, Randolph Tata, randy@talcon.com
- CPU Design HOW-TO
http://www.linuxdoc.org/HOWTO/CPU-Design-HOWTO.html
Version 12.0, Al Dev, alavoor@yahoo.com
- CVS-RCS- HOW-TO document for Linux (Source Code Control System)
http://www.linuxdoc.org/HOWTO/CVS-RCS-HOWTO.html
Version 21.7, Al Dev, alavoor@yahoo.com
- Diskless Nodes HOW-TO document for Linux
http://www.linuxdoc.org/HOWTO/Diskless-HOWTO.html
Version 22.4, Al Dev, alavoor@yahoo.com, Gero Kuhlmann, gero@gkmniix.han.de, Ken Yap, ken.yap@acm.org, Markus Gutschke, markus+etherboot@gutschke.com, Robert Nemkin, buci@math.klte.hu
- Java Decompiler HOW-TO
http://www.linuxdoc.org/HOWTO/Java-Decompiler-HOWTO.html
Version 4.0, Al Dev, alavoor@yahoo.com
- LILO, Linux Crash Rescue HOW-TO
http://www.linuxdoc.org/HOWTO/LILO-crash-rescue-HOWTO.html
Version 10.1, Al Dev, alavoor@yahoo.com
- Linux Assembly HOWTO
http://www.linuxdoc.org/HOWTO/Assembly-HOWTO/
Version 2002/01/12, Konstantin Boldyshev, konst@linuxassembly.org
- Linux Frequently Asked Questions with Answers
http://www.linuxdoc.org/FAQ/Linux-FAQ/
Version 1.20, Robert Kiesling, rkiesling@mainmatter.com
- Linux IP Masquerade HOWTO
http://www.linuxdoc.org/HOWTO/IP-Masquerade-HOWTO.html
Version 2.00.010502, David Ranch, dranch@trinnet.net
- Linux RAID FAQ
http://www.linuxdoc.org/FAQ/Linux-RAID-FAQ/
Version 0.0.10, Gregory Leblanc, gleblanc (at) cu-portland.edu
- Modem Dialup NT HOWTO
http://linuxdoc.org/HOWTO/Modem-Dialup-NT-HOWTO.html
Version 1.2, Al Dev, alavoor@yahoo.com
- PHP HOW-TO
http://www.linuxdoc.org/HOWTO/PHP-HOWTO.html
Version 25.9, Al Dev, alavoor@yahoo.com
- Process Monitor HOW-TO for Linux
http://www.linuxdoc.org/HOWTO/Process-Monitor-HOWTO.html
Version 11.1, Al Dev, alavoor@yahoo.com
- RPM for Unix HOW-TO
http://linuxdoc.org/HOWTO/RPM-for-Unix-HOWTO.html
Version 1.5, Al Dev, alavoor@yahoo.com
- Secure Programming for Linux and Unix HOWTO
http://www.linuxdoc.org/HOWTO/Secure-Programs-HOWTO/
Version 2.92, David A. Wheeler
- The Linux Bootdisk HOWTO
http://www.linuxdoc.org/HOWTO/Bootdisk-HOWTO/
Version 4.5, Tom Fawcett, bootdisk-howto@linuxdoc.org
- The Linux Gamers HOWTO
http://www.linuxdoc.org/HOWTO/Linux-Gamers-HOWTO/
Version 0.9.4, Peter Jay Salzman, p@dirac.org
- The Linux Kernel HOWTO
http://www.linuxdoc.org/HOWTO/Kernel-HOWTO.html
Version 3.1, Brian Ward, bri@cs.uchicago.edu
- Transparent Proxy with Linux and Squid mini-HOWTO
http://linuxdoc.org/HOWTO/mini/TransparentProxy.html
Version 1.13, Daniel Kiracofe, drk@unxsoft.com
- Vim Color Editor HOW-TO (Vi Improved with syntax color highlighting
http://www.linuxdoc.org/HOWTO/Vim-HOWTO.html
Version 17.3, Al Dev, alavoor@yahoo.com
Unmaintained Documents
These documents have been abandoned by their maintainers and many of them
have not been updated in some time.
If you're willing to become the maintainer for one of them, please
join the LDP discussion list at
lists.linuxdoc.org
and post a message indicating your interest.
About the LDP
The Linux Documentation Project is developing free, high quality documentation
for the GNU/Linux operating system. This includes the creation of HOWTOs and Guides,
and collaboration with other documentation groups.
If you've always wanted to help Linux reach
Total World Domination(tm), but you're not a programmer,
there's still something you can do. Help the LDP!
The LDP keeps a page of resources for authors at
http://www.linuxdoc.org/authors/.
Contributions are always welcome.
For more LDP Weekly News, go to
http://www.linuxdoc.org/ldpwn/
|