Improving the Docs Project workflow - References

References

Fedora Docs Project

• "Canonical Source" on FDP Documentation:

Fedora Documentation Guide

• Toolset Idea (Fedora-docs-list posting by Paul Frields):

https://www.redhat.com/archives/fedora-docs-list/2006-November/msg00068.html

• How Fedora Release Notes are Produced:

Fedora Documentation Beats

• Document Project Tools - the FDP place to discuss our tools:

DocsProject/Tools

Wiki Editing

• Writing Documents using the MoinMoin Wiki:

Writing using the Wiki

• MoinMoin Wiki Converter Project:

MoinDocBookProject

• MoinMoin Migration Issues:

Infrastructure/WikiMigration

• Wikipedia reference article on text editor support, very adaptable to MoinMoin wiki editing:

[1]

DocBook XML

• Paul W. Frields' articles on DocBook XML in Red Hat Magazine (Feb/Mar 2006):

Introduction to DocBook XML Introduction to DocBook XML, Part 2

• Linux Documentation Project's Author Guide:

LDP Author Guide

• Writing Documentation Using DocBook - A Crash Course (in English & French):

http://opensource.bureau-cornavin.com/crash-course/en/index.html

• Eric Raymond's LDP DocBook HOWTO (2004):

DocBook Demystification HOWTO

• DocBook Authoring Tools:

http://wiki.docbook.org/topic/DocBookAuthoringTools

Emacs as a Writing Tool

• The Woodnotes Guide to Emacs for Writers (by Randall Wood):

http://therandymon.com/woodnotes/emacs-for-writers/emacs-for-writers.html

• PDF Version:

http://therandymon.com/papers/emacs-for-writers.pdf

• The Woodnotes Emacs Cheat Sheet for Writers (not Coders):

http://www.therandymon.com/papers/emacs-writers-cheatsheet.pdf

Vim as an XML Editor

• Vim as XML Editor:

http://www.pinkjuice.com/howto/vimxml/

GNOME

• The GNOME Handbook of Writing Software Documentation:

http://developer.gnome.org/projects/gdp/handbook.html

KDE

• The KDE Documentation Primer:

http://l10n.kde.org/docs/doc-primer/index.html

• The KDE DocBook XML Toolchain:

http://l10n.kde.org/docs/tools.php

• Quanta as a Docbook Editor:

http://quanta.kdewebdev.org/tutorials/quanta-docbook/quanta.html

Plone CMS

• Plone Test Site for the Fedora Project:

http://fpserv.fedoraproject.org/

• The Definitive Guide to Plone:

http://plone.org/documentation/manual/definitive-guide

• Issues Surrounding the Fedora Project's use of Plone:

FDP Plone Issues

PDF Conversion and Output

• Current Issues with PDF Conversion:

About PDF Conversion

• Generating PDF versions of the KDE documentation

http://people.fruitsalad.org/phil/kde/pdf-stuff/pdf-instructions.html

OpenDocument Format (ODF)

Note: Great source of information on ODF along with links to ODF applications and viewer.

• OpenDocument Fellowship:

http://opendocumentfellowship.org/

• "This is the official community gathering place and information resource for the OpenDocument OASIS Standard (ISO/IEC 26300)":

http://opendocument.xml.org/

FOSS Documentation Workflow

• "The Flow of Knowledge in Free and Open Source Communities" (PDF document), by Daniel M. German:

http://l3d.cs.colorado.edu/kcsd2006/papers/German.pdf

DocBook Tools: An Overview

Note: This excellent reference describes commercial packages, which are purposely excluded in the FOSS Doc Toolchain, as well as FOSS packages.

• "DocBook Tools: An Overview" (PDF document), by Scott Nesbitt:

http://www.scottnesbitt.net/techdocs/docbook_tools.pdf

Previous Page - Appendix D - Another View

Table of Contents

---