Do not use Edit(GUI) button.

?TableOfContents(4)

Copyright 2007, 2008 Osamu Aoki GPL, (Please agree to GPL, GPL2, and any version of GPL which is compatible with DSFG if you update any part of wiki page)

Guide for contributing to Debian Reference

Debian Reference upstream source is http://wiki.debian.org/DebianReference .

Rules

Here are the rules.

I use this moinmoin platform for its ability for table and XML export.

This wiki will be post-processed by XSLT/XML tools and should be written accordingly:

 ... commands examples ...

This ensures (eventually) clean conversion to DocBook XML and makes my work easy. :-)


If funny things happen, look for single quote repeats, etc. in wiki source.

Code sections marked as "{ { { \n } } }" without using spaces will cause XML export errors; thus, always use spaces around "\n" or "{ { { \ } } } { { { n } } }" without space in this.

List export has <para> markup bugs; after conversion, review and correct them, please.

Hints for tools to help updating this document

Build scripts and xml sources are available via Git repository at:

For example, this wiki page is converted step-by-step as follows:

  1. [http://wiki.debian.org/DebianReference/Test?action=raw wiki source in raw text mode]

  2. [http://people.debian.org/~osamu/pub/getwiki/en/test-all.en.xml Docbook XML (cover page)]

  3. [http://people.debian.org/~osamu/pub/getwiki/en/test.en.xml Docbook XML (contents)]

  4. [http://people.debian.org/~osamu/pub/getwiki/html/test.en.html HTML created from Docbook XML files]

Examples

This section contains examples and scratch pad contents.

Table

Always assumes the first line is <title>, the second line is <thead> and the rest lines are <tbody> <row>s. (hello)

Example of table 1

TITLE1

TITLE2

DATA 11

DATA 12

DATA 21

DATA 22

Character format

NORMAL: italic strong

TYPE: ''italic in type'' '''strong in type'''

Special paragraphs

Here are examples of Wiki marking used.

/!\  /!\  for "Warning" (alert)

<!>  <!>  for "Caution" (attention)

{*}  {*}  for "Important" (star_on)

{i}  {i}  for "Tip" (icon-info)

(!)  (!)  for "Note" (idea)

{OK}  {OK}  for "Note" (thumbs-up)

(./)  (./)  for "Note" (check-mark)

Line foldings

line1 starting line break examples line2 w/o space from previous line

line3 w 1 line space from previous line

line2 w 2 space from previous line

line2 w 3 space from previous line line with ampersand & &

Data for popcon data and package size

The calculated popcon and size can be checked at: [http://people.debian.org/~osamu/pub/getwiki/html/test.en.html#dataforpopcondataandpackagesize Data for popcon data and package size].

The following packages are referred in the main text.

List of packages whose popcon and/or package size were referred in the main text

1

2

3

package

popcon

package size

dummy

gksu

-

-

-

screen

-

-

-

rutebook

-

-

-

The following packages are meant to evaluate backup utilities.

List of packages possibly mentioned in the main text for backup

1

2

3

package

popcon

package size

dummy

sbackup

-

-

-

amanda-common

-

-

-

amanda-client

-

-

-

amanda-server

-

-

-

cdrw-taper

-

-

-

par2

-

-

-

parchive

-

-

-

backup-manager

-

-

-

backup2l

-

-

-

backupninja

-

-

-

bacula

-

-

-

bacula-common

-

-

-

bacula-client

-

-

-

bacula-console

-

-

-

bacula-server

-

-

-

cdbackup

-

-

-

cedar-backup2

-

-

-

faubackup

-

-

-

flexbackup

-

-

-

mondo

-

-

-

afbackup

-

-

-

afbackup-client

-

-

-

afbackup-common

-

-

-

backuppc

-

-

-

boxbackup-client

-

-

-

boxbackup-server

-

-

-

chiark-backup

-

-

-

storebackup

-

-

-

keep

-

-

-

The following packages are meant to evaluate office utilities.

List of GUI packages possibly mentioned in the main text for office

1

2

3

package

popcon

package size

description

type

scribus-ng

-

-

desktop page layout editor

KDE

scribus

-

-

desktop page layout editor

KDE

The following assorted packages are meant to evaluate inclusion to the main text.

List of assorted packages possibly mentioned in the main text

1

2

3

traceroute

-

-

Traces the route taken by packets over an IPv4/IPv6 network (included)

tcptraceroute

-

-

Traces the route taken by packets over an IPv4/IPv6 network using TCP SYN packets (excluded)

See http://wiki.debian.org/UTF8BrokenApps

Escape confusion

MoinMoin conversion bug for " \n " needs to be worked around by placing space around it or as "{ { { \ } } } { { { n } } } " (w/ospaces).

can be referred as @{@internallinks@}@ which will create correct reference in HTML.

Do not use " [[Anchor(internalLinks)]] " for now in the main text used by building final HTML files. (It may be a good idea but you need to do it for entire document.)

The normal anchor feature of MoinMoin wiki is not supported by the XML conversion tool now.