Differences between revisions 1 and 2
Revision 1 as of 2007-10-25 15:40:28
Size: 2879
Editor: OsamuAoki
Comment:
Revision 2 as of 2007-10-27 05:52:53
Size: 3285
Editor: OsamuAoki
Comment:
Deletions are marked like this. Additions are marked like this.
Line 36: Line 36:
Please follow few basic rules when updating: Please follow few special rules when updating contents:
Line 40: Line 40:
 * Tell osamu@debian.org before making major changes.  * Tell "osamu at debian . org" or debian-doc@lists.debian.org before making major changes.
  * Having alternative page proposal linked from the bottom of this wiki page will be good idea.
Line 45: Line 46:
  * popcon and package sizes are autogenerated by script. (Values in wiki are ignored)
  * @@@tag@@@ in wiki are converted to &tag;. You need to update source to use it.
  * popcon and package sizes are autogenerated by script if specified here. (Values in wiki are ignored)
Line 50: Line 50:
 * @@@tag@@@ in wiki are converted to &tag;. You need to update source to use it.
 * @{@ and @}@ in wiki are converted to {{{<}}} and {{{>}}} in DocbookXML to enable arbitual tags.
Line 55: Line 57:
Thw Wiki --> Docbook conversion examples The Wiki --> Docbook conversion examples
Line 57: Line 59:
   * [http://people.debian.org/~osamu/pub/getwiki/DRTest/xml Docbook]    * [http://people.debian.org/~osamu/pub/getwiki/test/debian-reference.dbk Docbook]
Line 67: Line 69:

= The alternative contents proposals =

 * [:WikiSandBox: Title of the document] -- indication of what does this replace.

The next version of Debian Reference will focus on things not documented in each packages or elsewhere else. Mostly big pictures specific to the Debian user. This way every new updates will not require updating document.

Do not use GUI editing if you are copying contents to the latest MoinMoin in upcoming etch (buggy).

Think twice before describing in long text. It is usually good to shorten text down to half as much as what you initially wrote.

New Debian Reference (rewrite)

The following web page is draft of new Debian Reference.

The parent directory contains all scripts used.

Debian Reference (rewrite) wiki contents

The followings are used as the source of the web page.

  • [:DRCopy: Copy]
  • [:DRAbstract: Abstract]
  • [:DRPreface: Preface]
  • [:DRBasics: Tutorial]
  • [:DRPackage: Package management]
  • [:DRSystem: System initialization]
  • [:DRAuth: Authentication]
  • [:DRNetwork: Network]
  • [:DRXwindow: X window]
  • [:DRI18NL10N: I18N and L10N]
  • [:DRTips: System tips]
  • [:DRApplication: Iternet application]
  • [:DRData: Data management]
  • [:DRConversion: Data manuplation]
  • [:DRProgram: Programming]
  • [:DRAppendix: Appendix]

Please follow few special rules when updating contents:

  • The code names are always in the lower case (sid, etch, ...)
  • Do not use FootNote.

  • Do not make a complicated table with connected cells spanning rows or columns.
  • Tell "osamu at debian . org" or debian-doc@lists.debian.org before making major changes.

    • Having alternative page proposal linked from the bottom of this wiki page will be good idea.
  • Indent 1 character for * and 1. started lines.

  • The index section in each wiki page will be dropped when converted to XML.
    • (Wiki is just easy way for creating XML.)
  • The 1st line of table is used as: <title>, [package column, popcon column].

    • popcon and package sizes are autogenerated by script if specified here. (Values in wiki are ignored)
  • The 2nd line of table is used as: <thead>.

  • Some face marks are converted to marking for para. (See test page.)
    • Do not indent for lines started with face marks.
  • @@@tag@@@ in wiki are converted to &tag;. You need to update source to use it.

  • @{@ and @}@ in wiki are converted to < and > in DocbookXML to enable arbitual tags.

  • Do not indent line started with : ||,  { { { (without spaces) too.

  • Precede with ! to avoid wiki linking.

If funny things happen, suspect single quote repeart etc in wiki source.

The Wiki --> Docbook conversion examples

These allow eventual clean conversion to DocBook XML and my work easy :-)

This document

The alternative contents proposals

  • [:WikiSandBox: Title of the document] -- indication of what does this replace.