DescriptionMarkup

Not logged in - Log In / Register

Summary

Launchpad should support two subsets of MoinMoin markup: a simple subset for use in descriptions of things, and a larger subset for use in specifications.

Rationale

Use cases

Design

Compare: HelpOnEditing

There should be two markup modes: one for specifications ("advanced"), and one for everything else ("simple"). This is because specifications can expect to have most of a page to themselves, and often need to explain complex ideas using tables and images; these are needed much less by anything else (except maybe bug reports).

Formatting

Compare: HelpOnFormatting

For simple mode:

A new line also ends any of these.

For advanced mode, all that plus:

Not supported:

Compare: HelpOnLinking

For simple mode:

For advanced mode, all that plus:

Not supported:

Headings

Compare: HelpOnHeadlines

For advanced mode only:

Horizontal rules

Compare: HelpOnRules

Not supported.

Lists and indenting

Compare: HelpOnLists

For advanced mode only:

Not supported:

Tables

Compare: HelpOnTables

Should be supported for specifications only: All the features described in HelpOnTables.

Variables

Compare: HelpOnPageCreation#variablesubstitution''

Not supported.

Icons

Compare: HelpOnSmileys

Not supported.

Macros

Compare: HelpOnMacros

Not supported.

Processors

Compare: HelpOnProcessors

Not supported.

Processing instructions

Compare: HelpOnProcessingInstructions

Not supported.

Advertising formatting ability

Fields that accept simple-mode formatting should have text underneath describing what formatting you can use:

Implementation

Code changes

Schema changes

Each thing with a description may need a flag to indicate whether the description is using the markup or not.

Data migration

The "I am using markup" flag should default to off.

Unresolved issues

  • Should we allow lists in simple mode too?

DescriptionMarkup (last edited 2009-06-26 14:01:45 by mpt)