Project:Style guide

From Manual - MMFC. Medieval Manuscripts in Flemish Collections

Tools Mediawiki Formatting Guide Mediawiki Content Guide


Rules and tips for editing the MMFC manual.

1 Creating pages

  • Create all manual pages within the MMFC namespace. So start your page name with MMFC: (no space): MMFC:Lists/Record types.
  • Create new pages as a subpage within one of the manual's trees. Current roots are:
    • MMFC:Method
    • MMFC:Elements
    • MMFC:Lists
  • To make a page part of a tree, you need to inlude the full path in its name: MMFC:Elements/Identifier/Title.
  • Use Sentence case for page names: MMFC:Lists/Decoration types (not MMFC:Lists/Decoration Types). Note that page names (and the corresponding URLs) are case sensitive!

1.1 How to

Via the address bar (preferred):
This is the preferred method because it ensures that the new page is correctly placed within the hierarchy.

  1. Go to the page under which you want to create a subpage.
  2. In the browser address bar, add /New_page_name to the address of the current page, immediately after the current page name: https://manual.mmfc.be/p/MMFC:Root/Existing_page_name/New_page_name.
  3. Hit enter.
  4. Click on the link 'create this page' in the message 'There is currently no text in this page. You can search for this page title in other pages, search the related logs, or create this page.'

Via a 'dead' link on a page:

  1. In any page from which you want to reference the new page, add a link to the page: [[MMFC:Root_page/Sub_page/New_page|New_page]].
  2. Save the page.
  3. Click on the link you just created. This link is gray, an indication that the page does not yet exist.
  4. Click on the link 'create this page' in the message 'There is currently no text in this page. You can search for this page title in other pages, search the related logs, or create this page.'

2 Required page elements

Certain elements should always be present on certain types of pages.

2.1 On pages with subpages

  • Always add the MMFCSubpages template at the bottom of the page: {{MMFCSubpages}}

2.2 On Element pages

  • Always start your Element page with the MMFCElementsBasic template.
    • For basic elements:

      {{MMFCElementsBasic
      |name=
      |label=
      |definition=
      }}

    • For elements with subfields (containers):

      {{MMFCElementsBasic
      |name=
      |label=
      |definition=
      |subfields=
         {{MMFCElementsBasic
         |name=
         |label=
         |definition=
         }}
         {{MMFCElementsBasic
         |name=
         |label=
         |definition=
         }}
      }}

    • This template also adds [[Category:MMFC Elements]] and __NUMBEREDHEADINGS__ to the page.
  • Always mention the correct category to which the Element page belongs. Different categories are possible:
Type Definition Template
Imported The Element page has been creating by automatically importing the content from the data scheme documentation. [[Category:Imported]]
Created The Element page has been manually created by one of the editors. [[Category:Created]]
Edited The content of an existing Element page has been edited by one of the editors. [[Category:Edited]]
Checked The content of the Element page has been checked by another editor than the creating/editing editor. [[Category:Checked]]
Copy-edited The content of the Element page has been checked for language and style by another editor than the creating/editing editor. [[Category:Copy-edited]]
Obsolete The Element page has lost his importance for further use and can be deleted by one of the administrators. [[Category:Obsolete]]

3 Optional page elements

3.1 Table of contents

A table of content is added automatically when more than three headers exists in a page.

  • To remove the table of contents on a page, add __NOTOC__ to the page.
  • To add the table of contents to a page with only a few headers, add __TOC__.

3.2 Numbered headings

Heading numbering is a user setting. In this wiki it is on by default. It is also possible to force or disable the numbering on a page, regardless of user preference.

If you add one of these 'magic words' anywhere on a page, every user will see the same thing:

  • __NUMBEREDHEADINGS__: automatic numbering of the headings in the page is forced
  • __NONUMBEREDHEADINGS__:automatic numbering of the headings in the page is inhibited

For a manual, having heading numbering has added value. It also helps to keep the overview on long pages.

As such, numbered headings should be the rule rather than the exception. On element pages they are forced via the {{MMFCElementBasic}} template, which includes the __NUMBEREDHEADINGS__ magic word. On other pages, adding __NUMBEREDHEADINGS__ is recommended.

3.3 'See also' buttons

Add buttons for relevant other pages to the top of a page to aid navigation. For instance, if a supporting lists exists for an instruction set, add a button to the list. If a list is relevant to specific element pages, add buttons to these elements. Etc.

  • Use the available templates:
Type Purpose Template Example
See element Refer to specific elements related to the topic of a page {{SeeElement|[[PageName|PageLabel]]}} MMFC ID
See list Refer to pages in this wiki that contain lists of things {{SeeList|[[PageName|PageLabel]]}} Decoration types
See also Point to any other additional information within this wiki {{SeeAlso|[[PageName|PageLabel]]}} Data schema
See external Point to additional information outside of this wiki {{SeeExternal|[url label]}} MMFC