Differences between revisions 41 and 42
Revision 41 as of 2007-12-11 16:05:42
Size: 5052
Editor: OsamuAoki
Comment: This is new URL etc
Revision 42 as of 2007-12-11 16:30:24
Size: 5194
Editor: OsamuAoki
Comment:
Deletions are marked like this. Additions are marked like this.
Line 9: Line 9:
The generated HTML is available at [http://people.debian.org/~osamu/pub/getwiki/html/index.en.html Debian Reference (v2) HTML] The generated HTML is available at:
 *
[http://people.debian.org/~osamu/pub/getwiki/html/index.en.html Debian Reference (v2) HTML - multipage]
 * [http://people.debian.org/~osamu/pub/getwiki/html/index-one.en.html Debian Reference (v2) HTML - single page]
Line 83: Line 85:
   * [http://people.debian.org/~osamu/pub/getwiki/test-all.en.xml Docbook XML parent]
   * [http://people.debian.org/~osamu/pub/getwiki/test.en.xml Docbook XML child]
   * [http://people.debian.org/~osamu/pub/gwtwiki/test-all.en.html HTML from Docbook]
   * [http://people.debian.org/~osamu/pub/getwiki/en/test-all.en.xml Docbook XML parent]
   * [http://people.debian.org/~osamu/pub/getwiki/en/test.en.xml Docbook XML child]
   * [http://people.debian.org/~osamu/pub/gwtwiki/html/test-all.en.html HTML from Docbook]

Do not use Edit(GUI)

Edit(GUI) will break some wiki contents as reported in ([http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=409482 GUI editing to text breaks contents], and some wiki link formats).

Debian Reference (v2)

The wiki pages under this page are the upstream source of the new "Debian Reference (v2)".

The generated HTML is available at:

This "Debian Reference (v2)" 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.

Debian Reference (v2) source wiki

The following pages are used as the source of the web page.

  • [:/Copy: Copyright]
  • [:/Abstract: Abstract]
  • [:/Preface: Preface]
  • [:/Tutorial: Tutorial]
  • [:/Package: Package management]
  • [:/SystemInit: System initialization]

  • [:/Auth: Authentication]
  • [:/Network: Network]
  • [:/InternetApp: Internet application]

  • [:/Xwindow: X window]
  • [:/I18NL10N: I18N and L10N]
  • [:/SystemTips: System tips]

  • [:/DataManagement: Data management]

  • [:/DataConversion: Data manipulation]

  • [:/Program: Programming]
  • [:/Appendix: Appendix]

The Debian Reference wiki rule

I welcome your contribution to update above pages.

Here are the rules.

  • Make sure you are reachable via e-mail from me by :
  • Think twice before doing anything.
    • Spell and grammer correction should be done immediately.
    • Tell "osamu at debian . org" or debian-doc@lists.debian.org before making major / global changes.

    • It is usually good to place only the pointer to the original information.
    • Even if new contents are required, please shorten description down to the half as much as your initial draft.
    • Make alternative page proposal linked from the bottom of this wiki page for significant changes.
  • This wiki will be post processed by XSLT/XML tools and should be written accordingly:
    • The content in the index section at the top of each wiki page will be dropped when converted to XML.
    • Do not use too fancy wiki features not supported by XML conversion backend. (You are wellcomed to fix those in moinmoin)
      • Do not make a complicated table with connected cells spanning rows or columns.
      • Do not use FootNote nor face marks such as :) for :) .

    • Follow the wiki style:
    • The codenames are always in the lower case (sid, etch, lenny, ...)
      • Indent only for * and 1. started lines one character by one.

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

      • Some graphic marks such as /!\ for /!\ are converted to marking for para. (See test page.)

        • Do not indent for lines started with these graphic marks.
    • The table wiki be processed in special ways
      • The 1st line of table is used as: <title>, [package column, popcon column].

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

    • @@@tag@@@ in wiki are converted to &tag; in XML.

      • The final tag contents in HTML is determined by the HTML generation script.
      • @{@ and @}@ in wiki are converted to < and > in DocbookXML to enable arbitrary tags.

    • All internal wiki links will be removed when converted to XML.
    • For the same text with URL link, external URL link should match if it repeats.
    • Try to keep contents in {{{ commands examples ... }}} language neutral so translation will not affects them.

  • Do not bloat this document.
    • It is already getting too bit to maintain for me (osamu).
    • If you want to make XML document for some particular topic from the wiki, please use the code I use and start the another document. (GPL).

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


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


The Wiki --> Docbook conversion examples

This document

The alternative contents proposals

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


CategorySystemAdministration