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.

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

Interesting info found by googling

Fonts on the Debian system

This is based on system just around lenny release.

Here is a list of references for fonts on the Debian system.

The fonts in the X window

The defoma package, which stands for "DEbian FOnt MAnager", provides a framework for automatic font configuration including X.

The aptitude will help you find required font easily

The standard xfs in the X server works fine with TrueType fonts.

Since Free fonts are sometimes limited, installing or sharing some commercial TrueType fonts is an option for a Debian users. In order to make this process easy for the user, some convenience packages have been created:

You'll have a really good selection of TrueType fonts at the expense of contaminating your Free system with non-Free fonts.

All these font packages in Debian should work without any efforts and appear available to all X programs that use the regular "core" font system. This includes things like Xterm, Emacs, and most other non-KDE and non-GNOME applications.

Basic fonts

There are 2 major types of [http://en.wikipedia.org/wiki/Computer_font computer fonts]:

While scaling of bitmap fonts causes jugged image, scaling of outline/stroke fonts produces smooth image.

Bitmap fonts on the Debian system are provided by [http://fontforge.sourceforge.net/pcf-format.html X11 pcf bitmap font files] having their file extension ".pcf".

Outline fonts on the Debian system are provided by:

Table of corresponding [http://en.wikipedia.org/wiki/PostScript ?PostScript] Type 1 fonts.

1

2

3

font package

popcon

size

sans-serif font

serif font

monospace font

source of font

(?PostScript)

Helvetica

Times

Courier

Adobe

gsfonts

Nimbus Sans L

Nimbus Roman No9 L

Nimbus Mono L

[http://en.wikipedia.org/wiki/URW URW] (Adobe compatible size)

gsfonts-x11

Nimbus Sans L

Nimbus Roman No9 L

Nimbus Mono L

X font support with ?PostScript Type 1 fonts.

t1-cyrillic

Free Helvetian

Free Times

Free Courier

URW extended (Adobe compatible size)

lmodern

LMSans*

LMRoman*

LMTypewriter*

scalable ?PostScript and ?OpenType fonts based on Computer Modern (from TeX)

Table of corresponding [http://en.wikipedia.org/wiki/TrueType TrueType] fonts.

1

2

3

font package

popcon

size

sans-serif font

serif font

monospace font

source of font

ttf-mscorefonts-installer

[http://en.wikipedia.org/wiki/Arial Arial]

[http://en.wikipedia.org/wiki/Times_New_Roman Times New Roman]

[http://en.wikipedia.org/wiki/Courier_(typeface) Courier New]

Microsoft (Adobe compatible size)

ttf-liberation

Liberation Sans

Liberation Serif

Liberation Mono

[http://en.wikipedia.org/wiki/Liberation_fonts Liberation Fonts project] (Microsoft compatible size)

ttf-freefont

?FreeSans

?FreeSerif

?FreeMono

[http://savannah.gnu.org/projects/freefont/ GNU freefont] (Microsoft compatible size)

ttf-bitstream-vera

Bitstream Vera Sans

Bitstream Vera Serif

Bitstream Vera Sans Mono

[http://www.gnome.org/fonts/ Bitstream, Inc.]

ttf-dejavu

?DejaVu Sans

?DejaVu Serif

?DejaVu Sans Mono

[http://dejavu.sourceforge.net/], Bitstream extended code support

ttf-dejavu-core

?DejaVu Sans

?DejaVu Serif

?DejaVu Sans Mono

[http://dejavu.sourceforge.net/] basic font variants

ttf-dejavu-extra

?DejaVu Sans

?DejaVu Serif

?DejaVu Sans Mono

[http://dejavu.sourceforge.net/] extra font vaiants

ttf-unifont

N/A

N/A

unifont

[http://Unifoundry.com], GNU Unifont cover all code

CJK fonts

To provide [http://unifont.org/ complete information about Unicode fonts, Unicode-enabled software, internationalization, and Unicode usability issues] on [http://en.wikipedia.org/wiki/Free_and_open_source_software free/libre/open source (FLOSS)] operating systems is beyond the scope of this document. Here are some key points mostly focused on CJK issues.

Table of key words used in CJK font names.

font type

Japanese font

Chinese font

Korean font

sans-serif

gothic, ゴチック

hei, gothic

dodum, gulim, gothic

serif

mincho, 明朝

song, ming

batang

Usually, font name with "P" is proportional fonts.

Double width: e.g., in Shift_JIS code table comprises 7070 characters:

double-byte characters occupy double width on console terminals.

In order to cope with special needs of CJK, there are some special fonts and supporting files.

For fixed fonts covering single-byte and double-byte characters, [http://www.ibiblio.org/pub/packages/ccic/software/info/HBF-1.1/ Hanzi Bitmap Font (HBF) File] with file extension ".hbf" is used.

In order to save space for [http://en.wikipedia.org/wiki/TrueType TrueType] font files, [http://en.wikipedia.org/wiki/TrueType TrueType] font collection file is used.

I order to cover complicated code space of characters, CID keyed Type 1 [http://en.wikipedia.org/wiki/PostScript ?PostScript] font is used with CMap files starting themselves with "%!PS-Adobe-3.0 Resource-CMap".

Font configuration and rendering

All these fonts described above (@{@basicfonts@}@, @{@cjkfonts@}@) are equally supported for displaying and printing using "libfreetype6", "libxft2", "ghostscript" and "fontconfig" packages on the Debian system.

Table of packages to support displaying and printing of fonts.

1

2

3

package

popcon

size

description

libfreetype6

[http://freetype.sourceforge.net/index.html ?FreeType] 2 font engine, shared library files

fontconfig

[http://en.wikipedia.org/wiki/Fontconfig generic font configuration library] - support binaries

fontconfig-config

generic font configuration library - configuration

defoma

Debian Font Manager -- automatic font configuration framework

ghostscript

[http://en.wikipedia.org/wiki/Ghostscript The GPL Ghostscript PostScript/PDF interpreter]

ghostscript-x

The GPL Ghostscript PostScript/PDF interpreter - X Display support

libxft2

?FreeType-based font drawing library for X

x-ttcidfont-conf

TrueType and CID fonts configuration for X (for CJK support)

libpoppler3

PDF rendering library

poppler-data

Encoding data for the poppler PDF rendering library (for CJK support)

cmap-adobe-cns1

CMaps for Adobe-CNS1 (for traditional Chinese support)

cmap-adobe-gb1

CMaps for Adobe-GB1 (for simplified Chinese support)

cmap-adobe-japan1

CMaps for Adobe-Japan1 (for Japanese standard support)

cmap-adobe-japan2

CMaps for Adobe-Japan2 (for Japanese extra support)

cmap-adobe-korea1

CMaps for Adobe-Korea1 (for Korean support)

Font path check method

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)

{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

-

-

-

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

Escape confusion

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

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.