Differences between revisions 29 and 30
Revision 29 as of 2008-03-21 16:24:00
Size: 9416
Editor: OsamuAoki
Comment:
Revision 30 as of 2008-03-21 16:25:37
Size: 9419
Editor: OsamuAoki
Comment:
Deletions are marked like this. Additions are marked like this.
Line 189: Line 189:
|| List of tiny editor package and friends || 1 || 2 || 3 ||
|| '''package''' || '''popcon''' || '''package size''' || '''depends''' || '''UTF-8/C, WIDE''' || 
|| List of tiny editor package and friends || 1 || 2 || 3 || - ||
|| '''package''' || '''popcon''' || '''package size''' || '''depends''' || '''UTF-8/C, WIDE''' ||
Line 196: Line 196:
|| {{{vim-tiny}}} || - || - || {{{libc6}}} {{{libncurses5}}} {{{vim-common}}} || ?  || || {{{vim-tiny}}} || - || - || {{{libc6}}} {{{libncurses5}}} {{{vim-common}}} || ? ||

Do not use Edit(GUI) button.

?TableOfContents(4)

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

Guide for contributing to Debian Reference

Rules

Here are the rules.

  • Do not use Edit(GUI) button of MoinMoin.

  • Follow the existing style.
  • Make sure you are reachable via e-mail from me by :
  • Think twice before doing anything.
    • Spelling and grammar 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 the description
      • to half its draft length.
    • Make alternative page proposals 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.
    • @ { @ tag @ } @ (without spaces between @s) markup on wiki pages is converted to an internal link.

    • Do not use overly fancy wiki features not supported by XML conversion backend, available from the git repo. (Your help to remove fancy features in moinmoin is welcome.)
      • 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 space per level of nesting.

      • Do not indent lines 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.
    • Wiki table markup is processed in special ways:
      • The first line of a table is used as: <title> [, package column, popcon column].

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

    • @ @ @tag@ @ @ (without spaces between @s) in wiki are converted to &tag; in XML.

      • The final tag contents in HTML is determined by the HTML generation script.
    • 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.
      • one word reference should chose mostly wikipedia
      • No % or & usage in URL address reference until I fix moin2urls.xsl.

    • Try to keep contents in

 ... commands examples ...
  • language neutral so translation will not affect them.
  • Do not bloat this document.
    • It is already getting too big for me (osamu) to maintain .
    • If you want to make an XML document for a particular topic from the wiki, please use the code I use and start a new document. (GPL).

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.

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


This Wiki page to Docbook conversion examples step-by-step:

Hints for tools to help updating this document

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

Special paragraphs

Here are examples of Wiki marking used.

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

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

{*}  {*}  for "Important" (star_on) "rslash-n": "\n"

'rslash-n': '\n'

{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 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

-

-

-

These entry let you access these values in main text of generated html.

List of editor packages

1

2

3

package

popcon

package size

dummy

emacsen-common

-

-

-

emacs22

-

-

-

emacs22-gtk

-

-

-

emacs22-bin-common

-

-

-

emacs22-common

-

-

-

xemacs21

-

-

-

xemacs21-bin

-

-

-

xemacs21-mule

-

-

-

xemacs21-support

-

-

-

xemacs21-mulesupport

-

-

-

nvi

-

-

-

exuberant-ctags

-

-

-

vim

-

-

-

vim-common

-

-

-

vim-addon-manager

-

-

-

vim-gnome

-

-

-

vim-gtk

-

-

-

vim-full

-

-

-

vim-gui-common

-

-

-

vim-scripts

-

-

-

vim-runtime

-

-

-

vim-vimoutliner

-

-

-

elvis

-

-

-

elvis-common

-

-

-

elvis-console

-

-

-

elvis-tools

-

-

-

vile

-

-

-

vile-common

-

-

-

vile-filters

-

-

-

xvile

-

-

-

fte

-

-

-

fte-console

-

-

-

fte-docs

-

-

-

fte-terminal

-

-

-

fte-xwindow

-

-

-

jed

-

-

-

jed-common

-

-

-

jed-extra

-

-

-

joe

-

-

-

jove

-

-

-

ne

-

-

-

le

-

-

-

the

-

-

-

List of tiny editor package and friends

1

2

3

-

package

popcon

package size

depends

UTF-8/C, WIDE

e3

-

-

no library dependencies

UTF-8

ee

-

-

libc6 {libncurses5

C

elvis-tiny

-

-

libc6 libncurses5

C

nano-tiny

-

-

libc6 libncursesw5

?

nano

-

-

libc6 libncursesw5

?

vim-tiny

-

-

libc6 libncurses5 vim-common

?

vim-common

-

-

libc6

YES

libc6

-

-

-

UTF-8

libncurses5

-

-

-

NO WIDE

libncursesw5

-

-

-

WIDE

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

Escape confusion

MoinMoin conversion bug for " \n " needs to be worked around by placing space around it.

srslash-n:  \n rslash-ns: \n  rslash-n: \n : this

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

  • All characters converted to lower cases.
  • 0-9 converted to a-j
  • Drop all special characters and spaces.
  • For longer reference name, it trim center parts and make it first and last 16 characters each.
  • See HTML link name as quick check after generation.

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.