Editing On Moin Master

See also: MoinDev/Translation.

If you want to contribute to the MoinMoin help and system pages, you have to do the work on the master wikis. Before you edit pages there, please read this page completely.

The pages in the master wikis go directly into the MoinMoin distribution archive, so please edit them carefully.

Remember, we have multiple wikis:

• this wiki, the MoinMoin wiki

• depending on the targetted moin version, we have multiple MoinMaster wikis, currently there are:

  • master18 for moin 1.8.x content: http://master18.moinmo.in/

  • master19 for moin 1.9.x content: http://master19.moinmo.in/

  • (same thing for future moin versions)

The pages in MoinMaster are help and system pages ONLY; wiki user homepages and moinmoin discussion are neither wanted nor allowed there. The MoinI18n/* pages are the base for the PO files used in moin (we have a sync script for that).

If you are a moin newbie, please do not edit those pages except to correct typos - gather some experience with moin before you try to help.

If you edit pages there, try to make them better, but keep in mind that some of those pages are translated to other languages and that translating is much work - so keep your changes to the necessary minimum.

When creating new pages, try to follow the naming schemes and structures you already see there.

Do not rename pages without a very good reason.

Generally, THINK first, then change. If you have questions, please use the MoinMoin wiki, not MoinMaster.

Before being able to edit, create a wiki user account and then add yourself to the page MoinPagesEditorGroup on the master wiki where you want to work. See the explanation there.

Style Guidelines

Use these style guidelines to maintain a consistent look to the underlay pages.

Headings

If a page has any headings within the page, then it should begin with an H1 heading. There should be only one H1 heading defined within the wiki page content. Additional headings should use H2, H3, etc. to indicate lower levels of detail.

Not every page requires a heading. Some of the system pages such as RecentChanges do not require a heading.

Table Of Contents

Pages having more than 4 headings should have a table of contents macro immediately after the H1 heading. Pages with 4 or fewer headings may have a table of contents macro.

The table of contents macro should not have any special formatting such as embedding it in a table to float it left or right.

Pragmas

The use of #pragma section-numbers on to turn section numbering on, off, or start at a specified level should be avoided. Underlay pages should not override local the wiki standard for show_section_numbers.

Navigation Macro

When used, the navigation macro (see HelpOnMacros) should either be placed at the top of the page above the H1 heading or at the bottom of the page.

Embedded Navigation

Use of extra navigation links such as:

• HelpForUsers > HelpOnEditing

at or near the top of the page should be avoided.

Example / Display

Pages showing examples of wiki markup followed by the resulting display should enclose the display portion of the example using a wiki parser with a CSS class of dashed -- {{{#!wiki dashed ... }}}.

= Page Title - Heading Level 1 =
== Heading Level 2 ==
=== Heading Level 3 ===

Pseudo Headings

Avoid using Bold text to make pseudo headings when a normal heading will function just as well.