Guide to Converting Documents to MediaWiki

This document provides a guide for how to copy content from a PDF to the Analytica Wiki. Documents should ideally open to a Table of Contents page which links to a separate page for each chapter within the document. This document refers to each chapter page and the pages contained within those chapters.

General Guidelines

Chapter pages will each have their own pages, as well as any Chapter Subsections (listed within each PDF documents' Table or Contents page and denoted within the text with Red Titles). Chapter pages should be titled "Chapter Name" and not "Chapter X: Chapter Name".

Headings for Media Wiki pages begin with second level headings (listed as Heading 1 in the Visual Editor, but denoted with 2 equal signs "==" in Wikimarkup).

What to Copy Over

• Formatting
  • Bold
  • Italics
  • Fixed-width text/code: This should be placed within <code> tags.
• Tips: Tips are denoted in the text with the text Tip on the left-hand side and are contained within two horizontal red bars. There are custom tip tags that can be used on the Analytica Wiki to highlight these:
  • <tip name="Tip">This is the tip text</Tip>, which displays as:
  • Tip

    This is the tip text
• Images
• Tables: Screenshots of Analytica results should be copied into the Wiki as images, but actual tables in the Wiki should be entered in as Wiki Tables .Tables of results should have the corresponding function above the table in fixed-width text. Tables can either be formatted as the default table style or using the Wiki Table formatting (default in the Visual Editor). Examples of both are shown below:

Default Table Example

MDTable(T,Rows,Cols,[Car_type,Mpg],'average','n/a') →

	Mpg ▶
Car_type ▼	26	30	35
VW	2185	1705	n/a
Honda	2330	n/a	2210
BMW	n/a	2955	2835

Wikitable Table Example

MDTable(T,Rows,Cols,[Car_type,Mpg],'average','n/a') →

	Mpg ▶
Car_type ▼	26	30	35
VW	2185	1705	n/a
Honda	2330	n/a	2210
BMW	n/a	2955	2835

What to Add to Each Page

• Category: Each page should be located in the document category. For example, any page in the Analytica User Guide should also be located in the Category:Analytica User Guide page.
• Breadcrumbs: The top of each page should include breadcrumbs for where the page is located in the document. For example, a page named Bananas located in the Fruits category of the Food document would have the following breadcrumbs at the top of the page's wiki-markup:
  • <breadcrumbs> Food > Fruits > {{PAGENAME}}</breadcrumbs>
• See Also: After the last section in each page, a See Also section should also be added in.
  • ==See Also
• Footer: The bottom of each page should also include breadcrumbs linking to the previous and next pages in the document. It should only link to pages within the same level and not pages contained within that page (i.e. for a page Fruits containing Banana, the footer's previous and next pages might be Vegetables or Dairy, not Banana). If the preceeding pages were indeed Vegetables and Dairy, the footer would appear in the bottom of the page's wiki-markup:
  • <footer>Vegetables / {{PAGENAME}} / Dairy</footer>

Sample Page Template

[[Category: Doc Name]]
<breadcrumbs> Doc Name > Chapter Name > {{PAGENAME}}</breadcrumbs>

This is page content.

==Subheading==
Subheading content goes here.

===Subsection under Subheading==
Any text in a subsection within the subheading should go under here.

==Subheading 2==
Subheading 2 content goes here.

==See Also==
*Any appropriate links go here.

<footer>Number formats / {{PAGENAME}} / Next</footer>

Example Documents

• Analytica Tutorial
• ADE User Guide