["FrontPage"] > ["DebianWiki"] > Editor Guide

Translation(s): none

[:?DebianWikiConventionsDiscussion#editor-guide:Discussion]||

This page provides instructions for people willing to edit the content of wiki.debian.org.

There's a [:DebianWiki/EditorQuickStart:?QuickStart] for new editors.

/!\ Work in progress. If you disagree with any statement below, comment it out, then start a new discussion thread in the [:?DebianWikiConventionsDiscussion#editor-guide:Discussion] page

Your Account

Your WikiHomePage

Some ideas for your home page, grabbed from various existing home pages.

make sure you add CategoryHomepage at the bottom of your homepage.

Subscribe

Formating

This wiki has some formating conventions. Here are the most used ones.

moinmoin Help

For generic help on formating under moinmoin wiki, read moinmoin's ["?SyntaxReference"], ["HelpOnEditing"]. You can experiment in ["WikiSandBox"].

Page Header

See ["DefaultTemplate"].

Format an FAQ sections

A typical FAQ section could be formated like :

Q. How do I do XXXX
A1) You can do XXXX by doing X.
A2) You can do XXXX by doing Y

sample: (notice the space at the beginning of the lines 

 Q. How do I do XXXX :: A1) You can do XXXX by doing X.
 :: A2) You can do XXXX by doing Y.

Table of Contents

If a page gets long, you might want to add a Table of contents. See a sample at the top of this page !

sample : (note how the table is indented with one space) 

 ||<style="font-size:smaller">'''Table of Contents'''[[TableOfContents(2)]]||

ToDo : we should use a CSS style instead + custom stylesheet..

Disambiguation page header

Sometimes, a pages name can be ambiguous. If this can't be avoided, you could insert this at the top of the page :

disambiguation : This page is about Debian Conferences.?BR For Debian configuration management system, see ["debconf"].

Debian Official stuff

Often, the content of a Debian wiki page is also covered by some "official" Debian Documentation (or other "reference" location). The wiki page can still be useful for collaboration. It's a good idea to add a link to the reference location.

Sample link presentation to some official page, related to current subject.

inline:FranklinPiat/official-doc.png

http://www.debian.org/somewhere - Sample topic

Links

Rule #1 would be : Don't overuse linking. The reader wouldn't know which links are useful if there are too many. You can use a "See Also" section at the bottom of your page.

moinmoin wiki's help : [:HelpOnLinking:using links].

Internal Links (within this wiki)

External Links (to and from external sites, ["InterWiki"], etc....)

The preferred notation to external sites is :

An alternate option is

(avoid the notation  [http://www.foo.com link label]  because the target is obscure for visitors.)

If an (important) page is linked from outside Debian, it's a good idea to tag it with CategoryPermalink. So nobody removes it inadvertently.

Image and Media

moinmoin wiki's help : [:HelpOnLinking:using images].

Credits and Copyright consideration
It's a good idea to add Credits and Copyright information at the bottom of the page where you attach image.
To which page should one attach an image ?
Sometime, it's a good idea to attach the image to the parent page (in case the image is reused in other sub pages).
For Translated pages, attach the image to the English version (internationalized/localized images should be attached to the internationalized/localized pages).

Categories

moinmoin wiki's help : [:HelpOnCategories :using categories].

The list of categories used on this wiki ["CategoryCategory"].

Advertise a wikipage

You can promote the use wiki.debian.org by making use of it.

Page Fragments

  • A page meant to be included should be names */!PageFragment/*

  • Add a comment ## at the top of the page so people understand why it's 'incomplete' (a fragment!)

  • See [[Include()]] macro in ["HelpOnMacros"])

a sample is available at ["Installing Debian On/FrontPage"] and ["Installing_Debian_On/PageFragments/Philosophy"]. Also note how the page is included inside a table (but don't use this hack to bypass moinmoin formating limitation : see [#complex-formating Complex Formating).

Keeping track of changes.

  • Page History
  • User contributions

Technical Information

?Anchor(complex-formating)

Advanced Formating / Complex Formating

AVOID using advanced formating using table, include, etc.

  • It's difficult to understand and maintain for you and other wiki editors.

  • It's difficult to read the diff of such complex formating.