View source for Guide to Converting Documents to MediaWiki

This document provides a guide for how to copy content from existing PDF (generated from Framemaker) documents to the Analytica Wiki, which uses Mediawiki (of which this page is an example). We are converting these documents:
* [[ADE User Guide|''ADE User Guide'']]: Completed.
* [[Analytica Tutorial|''Analytica Tutorial'']]: Completed, although may need to add some cross-references/links.
* ''[[Analytica User Guide]]'': first 150 pp of 477 pages complete. Needs editing and cross-references.
* ''Analytica Optimizer Guide'': 104 pp

==General Guidelines==
=== Dividing into wiki pages === 
The Framemaker/PDF source documents are divided into Chapters, sections (bold red headings) and subsections (black headings).  For the ''Tutorial'', each Chapter was converted into a page in the wiki.  For the ''User Guide'', normally each section becomes a page. Sometimes, if sections are very short, it may make sense to combine them with a preceding or following section with closely related topic into the same page.

Headings for Media Wiki pages begin with second level headings, listed as '''Heading 1''' in the ''Visual Editor'', and denoted with 2 equal signs "==" in Wikimarkup. Since each section (bold red heading) is the page title, this means that subsections (bold black heading) are second level headings (==), and call-out section headings where the heading title is on the left of the text are third level headings (===).   

=== Chapters === 
Each Chapter from the ''User Guide'' should have its own main page, containing an introduction or overview, if there is one in the PDF, and a list of the section pages (links) in that chapter. Chapter pages should be titled "Chapter Name" and not "Chapter X: Chapter Name".

=== Table of Contents === 
The table of contents should always be placed at the top or near the top of each page. Only generic information or introductory text should come before a Table of Contents. The Wiki automatically generates the Table of Contents and places it before the first heading in the page, however, the Table of Contents can be inserted in any location using the Wiki Markup text <code><nowiki>__TOC__</nowiki></code>. Table of Contents should be manually moved to the top of pages that have a large amount of content before the first heading.

== What to Add to Each Page ==
Each wiki page should contain these elements (in addition to content copied from original document):
*'''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|Category: Analytica User Guide]] page. Some pages may also be in additional categories, such as function types.
*'''Breadcrumbs''': The top of each page should include breadcrumbs that indicate where the page is located in the document, with links to its Chapter and 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:
**<code><nowiki><breadcrumbs> Food > Fruits > {{PAGENAME}}</breadcrumbs></nowiki></code>
*'''Table of Contents:''' Manually insert the Table of Contents on pages that have a large amount of content before the first heading using the following markup:
**<code><nowiki>__TOC__</nowiki></code>
*'''See Also:''' After the last section in each page, add a '''See Also''' section with links to related pages: 
**<code><nowiki>==See Also==</nowiki></code>
*'''Footer:''' The bottom of each page should also include breadcrumbs linking to the previous and next page in this document. It should only link to pages within the same level and not pages contained within that page -- e.g. 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:
**<code><nowiki><footer>Vegetables / {{PAGENAME}} / Dairy</footer></nowiki></code>

==Formats==
Preserve standard character formats, including:
*Formatting
**Bold
**Italics
**Code snippets: Use <nowiki><code></nowiki> 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:
**<code><nowiki><tip title="Tip">This is the tip text</Tip></nowiki></code>, which displays as:
**<tip title="Tip">This is the tip text</tip>
*'''Images or screenshots:''' It may be easiest to copy these using Snagit (or similar app to copy selected image from the original document), save them as png, and then upload them to the wiki. There is a facility to upload multiple images by dragging them into an area at the top of the section you are editing with the Source editor. (Not available in Visual editor.)
*'''Analytica result Tables:''' Copy screenshots of Analytica results into the Wiki as images.
*'''Tables of information:'''  Enter actual tables in the Wiki should as Wiki Tables. You can format Tables either as the default table style or using the Wiki Table formatting (the default in the Visual Editor). See examples of both below:

===Default Table Example===
<tt>MDTable(T,Rows,Cols,[Car_type,Mpg],'average','n/a')</tt> &rarr;
{| border="1" 
! !! colspan="3" style="text-align: left;" | Mpg &#9654;
|-
! style="width:100px;" |'''Car_type &#9660; '''
! style="width:100px;" |'''26            '''
! style="width:100px;" |'''30             '''
! style="width:100px;" |'''35           '''
|-
!'''VW''' 
| | 2185 
| |1705 
|n/a
|-
!'''Honda '''
||2330 
||n/a 
| |2210
|-
!'''BMW''' 
|n/a 
||2955 
||2835
|}

===Wikitable Table Example===
<tt>MDTable(T,Rows,Cols,[Car_type,Mpg],'average','n/a')</tt> &rarr;
{| class="wikitable"
! !! colspan="3" | Mpg &#9654;
|-
| '''Car_type &#9660;'''
| '''26'''
|'''30'''
|'''35'''
|-
|'''VW'''
|2185
|1705
|n/a
|-
|'''Honda'''
|2330
|n/a
|2210
|-
|'''BMW'''
|n/a
|2955
|2835
|}

==Sample Page Template==
<pre>[[Category: Doc Name]]
<breadcrumbs> Doc Name > Chapter Name > {{PAGENAME}}</breadcrumbs>

This is introductory page content.
__TOC__

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></pre>

==Example Documents==
*[[Analytica Tutorial]]
*[[ADE User Guide]]

==See Also==
*[[How to combine function descriptions]]
*[[Document style guide]]