|
|
| (25 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| ==Overview==
| | <p class="warn"><b>Note:</b> This page preserves the history of the page now known as [[Updating M204wiki]], which apparently was created by a copy and paste instead of a move of this "M204wiki style guide," which would have saved its history. |
| While the most important part of a wiki is the content, following a few simple rules in formatting wiki documentation pages can make it easier for people to use the wiki because the consistent look and feel of each page. In addition, following these rules can make it easier to write the pages, as standard use of wiki and HTML tags makes it possible to convey information in the format of the text rather than having to state it explicitly.
| |
| | |
| Use of HTML tags and attributes that focus on the semantics of text also has some advantages:
| |
| <ul> | |
| <li>It's easier to remember semantic tags and attributes than remembering the physical display characteristics of a certain kinds of text.
| |
| <li>It's easier for Sirius to tweak or customize the look and feel of text based on its semantics if the semantics of the text is explicit in the markup.
| |
| </ul>
| |
| In fact, as a general rule of thumb, if you're coding any explicit physical text attributes in your wiki markup, it's probably a sign that you're doing something wrong or that Sirius needs to expand its list of semantic classes.
| |
| | |
| For example, if you enter <code><nowiki>''Model204''</nowiki></code> or <code><i>Model 204</i></code>, you're doing something wrong. You <strong>should</strong> enter <code><var class="product">Model 204</var></code>. Even if you're trying to emphasize something, like the "should" in the last sentence, you should use <code><strong>should</strong></code> not <code><nowiki>'''should'''</nowiki></code> or <code><b>should</b></code> though, admittedly, <code><strong></code> doesn't tell one a heck of a lot about the semantics of the enclosed word or words.
| |
| | |
| ==Headings==
| |
| The outermost headers on any page should be level two headers so should have two equals sign on either side:
| |
| <p class="code"><nowiki>==This is a heading2==</nowiki>
| |
| </p>
| |
| For a subsection of the heading2:
| |
| <p class="code">===Here is a heading3===</p>
| |
| These headings are included in the page's table of contents at the top of the page
| |
| (if there are enough sections — usually three — to generate one).
| |
| | |
| All of the page and section names are case sensitive.
| |
| | |
| ==Links==
| |
| For cross-references (links) to an article/page, your markup can simply be the exact article title enclosed in pairs of left and right brackets. To link to the article entitled "My target page":
| |
| <p class="code">[[My target page]]</p>
| |
| | |
| If you want the text of the link that the viewer sees to be different from the page title, append to the page name a vertical bar (<tt>|</tt>) followed by the text you want displayed:
| |
| <p class="code">[[My target page|My special link text]]</p>
| |
| | |
| In the wiki page view, the above markup displays as:
| |
| <p class="code">[[My target page|My special link text]]</p>
| |
| | |
| The link text above will display in red to remind that this page has yet to be created. For more information anout creating a page, see [http://www.mediawiki.org/wiki/Help:Starting_a_new_page Help:Starting a new page].
| |
| | |
| For links to a section on a page, where the section is an h2- through h6-level heading, thus automatically indexed by the wiki code,
| |
| follow the page title as above by <code>#<i>sectionName</i></code>, where <var class="term">sectionName</var> is the exact heading title. Then append to the section name a vertical bar followed by the text you want displayed, enclosed in double-quotation marks:
| |
| | |
| <p class="code">[[My target page#My section|"My section"]]</p>
| |
| | |
| In the wiki page view, the above markup displays as:
| |
| <p class="code">[[My target page#My section|"My section"]]</p>
| |
| | |
| Using the quotation marks is arbitrary, but it is the style used in this wiki.
| |
| | |
| For more information about formatting variations of the above types of links as well as other kinds of links, including external links, those to a target outside of the wiki, see [http://www.mediawiki.org/wiki/Help:Links Help:Links]
| |
| | |
| ==Syntax diagrams==
| |
| One of the most common documentation structures is a syntax diagram. Syntax diagrams show the format of a command, statement, or method invocation. While some of the syntax diagrams are generated from the Model 204 code (all methods, for example), much of the work of indicating syntax must be done manually. And there is no macro language for specifying the key elements of a syntax diagrams.
| |
| | |
| The first rule of syntax diagrams is that they must be contained inside a <code><p></code> element with a class of <code>syntax</code>:
| |
| <p class="code"><p class="syntax">
| |
| ... syntax diagram goes here
| |
| </p>
| |
| </p>
| |
| There are other rules that must be observed:
| |
| <ul>
| |
| <li>All keywords that must be typed literally as in the syntax diagram must start with an uppercase character.
| |
| | |
| <li>All syntax terms that are <strong>not</strong> literals should start with lowercase letters.
| |
| | |
| <li>[http://en.wikipedia.org/wiki/Camel_case Camel case] should be used for artifical compound word such as, for example, <code>veryImportantParameter</code>. Of course, keywords can also use this kind of captilization but, because keywords must begin with upper case characters, the casing is, strictly speaking, referred to as [http://en.wikipedia.org/wiki/Pascal_case Pascal case].
| |
| <li>Optional words or phrases must be inside of square brackets. These can be nested if, for example, an optional keyword appears inside an optional clause. Note that for <var>Callable</var> methods, the target (including the equal sign) should be inside square brackets. Note also that, strictly speaking, the syntax diagram for functions is not really correct as a function can be used in a context where its result is not assigned to a variable, but the standard syntax diagram shows an assignment to a variable. It's not obvious how we can make the syntax diagram more accurate without losing information or making it needlessly complex.
| |
| | |
| <li>Similary, methods can apply to variables or the results of expressions. This dichotomy <strong>can</strong> be expressed by not using the percent sign in the syntax term for the method object (nor for parameters). This "rule" is currently not followed everywhere — some places use the percent sign at the start of syntax terms that might be variables or results of expressions and some don't. For now, the recommendation is that the percent sign be used only where a percent variable is required. Perhaps, some day, this will turn into a rule.
| |
| | |
| <li>Use the standard <var class="product">Model 204</var> continuation character, hyphen (<code>-</code>), to continue each line whose syntax is continued on the next line. While more than 90% of the time, syntax diagrams will refer to a single-line statement or a command, it's still good discipline to stick with this rule so that multi-line syntax is obvious.
| |
| </ul>
| |
| | |
| Because syntax diagrams should be inside a <var><p></var> element, rather than, say, a <var><pre></var> element, wiki markup is allowed inside the block. This means, that you can include a link to a section that provides more detail about a word or phrase. For example, if there is a syntax term in a syntax diagram called <code>eve</code>, and a section called <code>All about eve</code>, a syntax diagram might be coded as follows:
| |
| <p class="code"><p class="syntax">object:[[Foo|foo]](<nowiki>[[All about eve|eve]]</nowiki>)
| |
| </p>
| |
| </p>
| |
| <p>
| |
| In current practice, however, a link within syntax is uncommon and the technique is more often used within code examples.
| |
| </p>
| |
| Note that in the above example, the syntax diagram starts on the same line as the <code><p class="syntax"></code> tag. This is because starting the syntax diagram on the following line results in an extra, unnecessary blank line at the top of the box that contains the syntax diagram in the output wiki page. There is no known work-around for this.
| |
| | |
| It is generally a good idea to try to get the terms in a syntax diagram to line up "nicely" if the diagram extends beyond one line. Obviously, "nicely" is a term that leaves a lot of room for interpretation but, since <code><p class="syntax"></code> blocks are always displayed in a monospace font, it shouldn't be a daunting task to make words in multiple lines line up for readability. There are also no guidelines for the width of syntax diagram lines, but making lines too long can result in them running off the end of the page or becoming difficult to scan because of the number of characters on a single line.
| |
| | |
| ==Examples==
| |
| Code examples are much like syntax diagrams but use the <code>code</code> class, like this:
| |
| <p class="code"><p class="code">
| |
| ...
| |
| for %x from 1 to %myStringList:Count
| |
| if %myStringList(%x):subString(1,3) eq ':h2' then
| |
| printText this is a header: {%myStringlist(%x)}
| |
| end if
| |
| end for
| |
| ...
| |
| </p>
| |
| </p>
| |
| | |
| ==Tables==
| |
| M204wiki documentation uses tables extensively, and it uses [http://www.w3.org/TR/REC-html40/struct/tables.html XHTML tags] to create the tables. By default, the M204wiki <code><table></code> tag and attributes are styled to include background shading and solid borderlines, and most notably to italicize (as well as bold) the content of <code><th></code> cells. | |
| | |
| For example, the following table is produced by the code shown below the table:
| |
| | |
| <table>
| |
| <tr><th>%outString</th>
| |
| <td>A variable to receive the string result of the <var>Unspace</var> method.</td></tr>
| |
| | |
| <tr><th>string</th>
| |
| <td>The input method object string</td></tr>
| |
| | |
| <tr><th><var>Spaces</var></th>
| |
| <td><var>Spaces</var> is an optional, [[Notation conventions for methods#Named parameters|name required]], parameter that is a string that specifies the set of characters considered to be whitespace.
| |
| <p>
| |
| If you specify multiple <var>Spaces</var> characters, the first character of the string is the replacement space character.</p>
| |
| </td></tr>
| |
| </table>
| |
| | |
| <p class="code"><table>
| |
| <tr><th>%outString</th>
| |
| <td>A variable to receive the string result of the <var>Unspace</var> method.</td></tr>
| |
| | |
| <tr><th>string</th>
| |
| <td>The input method object string</td></tr>
| |
| | |
| <tr><th><var>Spaces</var></th>
| |
| <td><var>Spaces</var> is an optional parameter that is a string that specifies the set of characters considered <br/>to be whitespace.
| |
| <p>
| |
| If you specify multiple <var>Spaces</var> characters, the first character of the string is the replacement space <br/>character.</p>
| |
| </td></tr>
| |
| </table>
| |
| </p>
| |
| | |
| Notes about the table example:
| |
| <ul>
| |
| <li>As is typical, the <code><table></code> tag is used without any modifying class. If you want to create a table that does not have solid borders, for example, you would code the tag as <code><table class="noBorder"></code> to use the [[MediaWiki:Common.css|M204wiki stylesheet overrides]] <code>noBorder</code> class which specifies a transparent border.
| |
| | |
| <li>Each HTML tag is explicitly started and ended.
| |
| | |
| <li>In this example, the table has no heading row. This is frequently the case with M204wiki tables. To create a heading row, you tag each cell in the row with <code><th></code>.
| |
| | |
| <li>The cells in the first column in the table <b>are</b> tagged with <code><th></code>, which makes the cell content bold and italic. When you don't want cell content to be italic, enclose the non-italic content within <code><var></code> tags (see <code>Spaces</code> in row 3, column 1) . If you don't want cell content to be bold, use the <code><td></code> tag instead of the <code><th></code> tag.
| |
| | |
| <li>To divide a cell's content into blank-separated paragraphs, you explicitly use a starting and ending paragraph tag (<code><p></code>), as in row 3.
| |
| </ul>
| |
| | |
| ==Categories and Lists==
| |
| Sirius has avoided the use of third-party add-on modules to MediaWiki in order to make it easy for sites to take local copies of M204wiki material without having to validate and install extra software.
| |
| | |
| Unfortunately, that leaves out a few useful features, like Dynamic Page Lists (DPL) which make up for some of the shortcomings of the default MediaWiki "Category" technology. Our compromise has been to use both MediaWiki categories ''and'' to create hand-built 'list' pages, buttressed by by some User Language consistency checks.
| |
| | |
| The standard MediaWiki category page is less informative, but updates itself (nearly) automatically. The hand-built list is at risk of being out of date, but it is also more useful as a quick cheat sheet for a set of related methods or functions.
| |
| | |
| For some category/list sets, such as the big table on [[List of $functions|"List of $functions"]] and the tables on the "$Function set" on the top of that page, we have some User Language (here, FUNSCHECK.WIKI) which we <b>should</b> run regularly to ensure all is well.
| |
| | |
| Other cases may not yet have had the User Language built but should be straightforward, for example, the [[List of JANUS WEB subcommands]] and
| |
| the [[:Category:JANUS WEB subcommands|JANUS WEB subcommands category page]].
| |
| | |
| Some will be harder, such as the
| |
| hand-built [[List_of_Fast/Unload_$functions|"List of Fast/Unload $functions"]], because there is no category for it specifically. It is all of the $function entries in the [[Fast/Unload User Language Interface]], and once we convert that page to a hand-built list (with its *CHECK.WIKI!) then the Fast/Unload $function list should be checkable.
| |
| | |
| ===PDFs of the contents of Category pages===
| |
| Most Category pages have a link to create a PDF file that contains all the categories on the page. That PDF will also include any Subcategory entries on the page '''if''' the MediaWiki link that placed the subcategory items onto the Category:Commands page is appropriately edited on the "home Category page" of those subcategories. This is also true for the sidebar link "PDF of this page."
| |
| | |
| For example, the "Operator commands" subcategory on the "Category:Commands" page is ordinarily the result of a <code><nowiki>[[Category:Commands]]</nowiki></code> tag on the "Operator commands" page source. If that markup is changed to <code><nowiki>[[Category:Commands| Operator commands]]</nowiki></code> (note space before "Operator"), the "Operator commands" subcategory on the "Category:Commands" page will display as before and in the same position except without a bold "O" heading for items that begin with the letter "O". If the other subcategories on the "Category:Commands" page are similarly edited, PDFs of the "Category:Commands" page will include the subcategories.
| |
| | |
| ==See also==
| |
| <ul>
| |
| <li>For examples of pages that have "good" formatting, see the individual method pages linked to from [[Lists of classes and methods]].
| |
| | |
| <li>For a more comprehensive editing guide, see MediaWiki's [http://www.mediawiki.org/wiki/Help:Contents Help page].
| |
| </ul>
| |