References

Markup and general information

Secret Life of Markup, The, http://hotwired.lycos.com/webmonkey/02/42/index4a.html, Steve Champeon.

Progressive Enhancement and the Future of Web Design: Where We Are Now , http://hotwired.lycos.com/webmonkey/03/21/index3a_page2.html, Steve Champeon.

SGML, http://www.w3.org/MarkUp/SGML/.

DocBook References

DocBook XML 4.1.2 Quick Start Guide, http://www.jimweller.net/jim/dbxmlqs/index.html, Jim Weller.

 

Describes how to install, configure and use the tools and resources for DocBook XML 4.1.2. The purpose of this quick start guide is to get new docbook authors, editors, and contributors up and running fast with the DoocBook tools. These are powerful tool in the hands of an author. It assumes a fair knowledge of building and installing source packages. There are probably a million and one ways to accomplish my ultimate goal of installing and using these tools. This one works well for me.

 
--Jim Weller 

Installing And Using An XML/SGML DocBook Editing Suite Setting Up A Free XML/SGML DocBook Editing Suite For Windows And Unix/Linux/BSD, http://supportweb.cs.bham.ac.uk/documentation/tutorials/docsystem/build/tutorials/docbooksys/docbooksys.html , Ashley J.S. Mills, 2002.

Getting Upto Speed With DocBook, http://supportweb.cs.bham.ac.uk/documentation/tutorials/docsystem/build/tutorials/UniDocBook/UniDocBook.html, Ashley J.S. Mills, 2002.

DocBook: The Definitive Guide, http://www.docbook.org/, Norman Walsh, Leonard Muellner, 1999, 1-56592-580-7, O'Reilly & Associates, Inc..

This book was released by O'Reilly in October 1999, and is a great reference to DocBook. I have not found it to be a great practical book. You can pick it up at the book vendor of choice, and the entire book is also available online (in HTML and SGML formats) at the above URL.

Simplified DocBook: The Definitive Guide, http://www.docbook.org/tdg/simple/en/html/sdocbook.html, Norman Walsh, Leonard Muellner, 1999.

Simplified DocBook, http://www.oasis-open.org/docbook/xml/simple/.

XML Matters: Getting started with the DocBook XML dialect, http://www-106.ibm.com/developerworks/xml/library/xml-matters3.html.

FAQ for DocBook markup, http://www.dpawson.co.uk/docbook/markup.html.

Single-Source Publishing with DocBook XML, , http://www.lodestar2.com/people/dyork/talks/2002/ols/docbook-tutorial/frames/frames.html, Dan York, 2002.

DocBook Install mini-HOWTO, http://tldp.org/HOWTO/mini/DocBook-Install/, Robert Easter.

Exploring SGML DocBook, http://lwn.net/2000/features/DocBook/, Giorgio Zoppi.

LinuxDoc

Howtos-with-LinuxDoc-mini-HOWTO, http://www.tldp.org/HOWTO/Howtos-with-LinuxDoc.html, David Lawyer.

LinuxDoc-SGML User's Guide, http://www.nmt.edu/tcc/doc/guide.html.

Converting Other Formats to DocBook

Converting HTML to Docbook SGML/XML Using html2db, http://www.cise.ufl.edu/~ppadala/tidy/.

5-Minute Review: Using LyX for Creating DocBook, http://www.teledyn.com/help/XML/lyx2db/t1.html.

Document processing with LyX and SGML, http://www.karakas-online.de/mySGML/.

LDP templates, tools & links

LDP Templates, , http://www.tldp.org/authors/index.html#resources .

Contains links to SGML templates and their resulting HTML output to help you see what your document will look like. Many of the tags just need to be replaced with information unique to your HOWTO. Also contains links to tools and other useful information.

Linux Documentation Project HOWTO Generator, The, http://www.nyx.net/~sgjoen/The_LDP_HOWTO_Generator.html.

This is a standalone web page with a number of fields to fill in and a few buttons. When ready the compile button starts the compilation of all the input fields and wraps it all in proper LinuxDoc SGML, ready to process with the LinuxDoc SGML tools.

The compiled output is outputted to a read-only text area near the bottom of the webpage, so the text has to be copied and pasted into a file for compilation.

DocBook is not currently supported.

DocBook Transformations

DocBook XML/SGML Processing Using OpenJade, , http://tldp.org/HOWTO/DocBook-OpenJade-SGML-XML-HOWTO/, Saqib Ali.

General Writing Links and Style Guides

Guide to Grammar and Style, http://newark.rutgers.edu/~jlynch/Writing/, Jack Lynch.

Purdue's Online Writing Lab, http://owl.english.purdue.edu/.

Chicago Manual of Style, http://www.chicagomanualofstyle.org/.

Plain Language Resources, http://www.plainlanguagenetwork.org/Resources/.

Writing User-Friendly Documents, http://www.blm.gov/nhp/NPR/pe_toc.html.

This is quite useful. It includes before and after writing samples.

PlainTrain Writing Tutorial, http://www.web.net/~plain/PlainTrain/IntroducingPlainLanguage.html.

Writing for the Web, http://www.useit.com/papers/webwriting/.

Information Pollution, http://useit.com/alertbox/20030811.html.

Be Succinct! (Writing for the Web), http://useit.com/alertbox/9703b.html.

Politics and the English Language, http://www.k-1.com/Orwell/index.cgi/work/essays/language.html, George Orwell.

A classic text on writing.

Elements of Style, The, http://www.bartleby.com/141/, Strunk and White.

A classic text on writing.

A Short Handbook and Style Sheet, http://newark.rutgers.edu/~jlynch/Writing/m.html#mechanics, Thomas Pinney.

Technical Writing Links, http://www.techcomplus.com/tips.htm.

Technical Writing Tutorial, http://psdam.mit.edu/rise/tutorials/writing/technical-writing.html.

Strategies to succeed in technical writing, http://www.school-for-champions.com/techwriting.htm.

User Guides Online Tutorial, http://www.klariti.com/technical-writing/User-Guides-Tutorial.shtml.

DMOZ Technical Writing Links, http://dmoz.org/Arts/Writers_Resources/Non-Fiction/Technical_Writing/.

techwr-L, http://www.raycomm.com/techwhirl/magazine/.

Technical Writing Links, http://academic.middlesex.cc.ma.us/PeterHarbeson/links.html.

An omnibus of links--scrounge for goodies.

Related TLDP Documents

Linux Documentation Project (LDP) FAQ, http://tldp.org/FAQ/LDP-FAQ/index.html, Rahul Sundaram.

LDP HOWTO-INDEX, http://tldp.org/HOWTO/HOWTO-INDEX/, Guylhem Aznar, Joshua Drake, Greg Ferguson.

Software: CVS

CVS: Project Management, http://doc.cs.byu.edu/programming/cvs/, Byron Clark.

CVS, http://supportweb.cs.bham.ac.uk/documentation/tutorials/docsystem/build/tutorials/cvstute/cvstute.html, Ashley J.S. Mills, Alan P. Sexton.

CVS--Concurrent Versions System, http://www.loria.fr/~molli/cvs/doc/cvs_toc.html, Pascal Molli.

Learning About CVS , http://cvshome.org/docs/.

Software: Emacs

Information about PSGML , http://www.lysator.liu.se/~lenst/about_psgml/.

Emacs: The Free Software IDE, http://www.linuxjournal.com/article.php?sid=576.

Emacs/PSGML Quick Reference, http://www.snee.com/bob/sgmlfree/psgmqref.html, Bob Ducharme.

NT Emacs Installation, http://www.charlescurley.com/emacs.html, Charles Curley.

Cygwin Packages for DocBook Authoring, http://www.docbook.org/wiki/moin.cgi/CygwinPackages/.

SGML for Windows NT: Setting up a free SGML/XML editing and publishing system on Windows/Cygwin , http://ourworld.compuserve.com/homepages/hoenicka_markus/cygbook1.html, Markus Hoenicka, 2000.

Vim, http://www.newriders.com/books/opl/ebooks/0735710015.html, Steve Oualline.

XML Authoring Tools

Saqib's list of XML Authoring Tools, http://www.xml-dev.com/xml/editors.html.

Documentation Licenses

Licensing HOWTO, http://www.catb.org/~esr/Licensing-HOWTO.html, Eric Raymond, Catherine Raymond.

 

This document explains how U.S. copyright and licensing law applies to open-source software projects. It compares the strengths and weaknesses of the existing open-source licenses, and gives guidance on how to choose a license for your project. It also explains the legalities of changing a project's license. It suggests new practice for coping with today's high-threat legal environment--this part is a must-read for all project leaders.

 
--Eric Raymond and Catherine Raymond 

OPL, http://www.opencontent.org/openpub/.

OpenContent officially closed June 30, 2003.

Creative Commons, http://creativecommons.org/licenses/by-sa/1.0/.

GNU Free Documentation License, http://www.gnu.org/copyleft/fdl.html.

GNU General Public License, http://www.gnu.org/licenses/licenses.html#GPL.

If you would like your documents to be included in the main Debian distribution, you should use this license. It is not, however, the LDP's license of choice.