M204wiki style guide - Revision history

JAL: Replaced content with "
Note: 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 ..."

2014-01-01T01:17:16Z

Replaced content with "<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 ..."

Show changes

JAL: /* Pages that contain auto-generated content */

2013-09-04T00:32:19Z

Pages that contain auto-generated content

← Older revision		Revision as of 00:32, 4 September 2013
Line 333:		Line 333:

	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.		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.

	~~==Pages that contain auto-generated content==~~
	~~Some content on some pages is auto-generated by SOUL operating on information in the <var class="product">Model 204</var> load module. Many of the "List of ..." pages are examples of this, like:~~
	~~<p class="code">[http://m204wiki.rocketsoftware.com/index.php/List_of_Arraylist_methods List of Arraylist methods] </p>~~

	~~When you are in edit mode on such an auto-generated page, you see a warning at the top of the page:~~
	~~<p class="code"><!-- This page was automatically generated and will be automatically~~
	~~replaced, so any manual edits will be lost. You've been warned. --> </p>~~
	You should heed this warning, and, instead of updating the page, copy the URL of of the wiki section most closely containing the wiki content that you want to update, and paste the URL into an email to the most relevant people describing the update you had in mind. Further discussion will likely ensue.

	==Graphics and PDFs==		==Graphics and PDFs==

JAL: /* Overview */

2013-09-04T00:31:48Z

Overview

← Older revision		Revision as of 00:31, 4 September 2013
Line 10:		Line 10:

	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 convey a lot about the semantics of the enclosed word or words.		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 convey a lot about the semantics of the enclosed word or words.

			==Adding, editing, or discussing a page==
			M204wiki is a collection of named pages to which you are invited to contribute. Once you have an authorized ID, you can add new pages to the wiki collection; you can edit the content of existing pages; and you can discuss the content of existing pages.

			===Adding a new page===
			There are multiple ways to add a new page to m204wiki:
			<ul>
			<li>[[#Manually composing a page name\|Manually composing a page name]]
			<p>This is the typical approach. </p>

			<li>Using a link to a wanted page
			<p>If there is already a link (colored red) for the page, someone else probably felt such a page was needed but didn't have time to define it. </p>
			<p>
			Simply click this link and you enter the wiki editor, where you add and save the new page content. </p>

			<li>One-time User Language generation of new page
			<p>This is limited to wiki administrators and explained further in the behind-the-firewall M204 internal wiki (M204int; see "Wiki tips").</p>
			</ul>

			====Manually composing a page name====
			Type the page name in the M204wiki search box, and click the <tt>Go</tt> button.
			You see the following on the search result:

			<table><tr><td>Create the page <i>[[pagename]]</i> on this wiki!</td></tr></table>

			Click <i><code>pagename</code></i> (red link) to enter the wiki editor and create that new page.

			<blockquote class="note">
			<b>Note:</b> Choose page names wisely (they are the principal means of search):
			<ul>
			<li>Select names that are consistent with other pages in the wiki.

			<li>Pay close attention to capitalization. Usually <i>only the initial letter</i> is capitalized.

			<li>Page names can be "changed," using the <tt>Move</tt> tab, but doing so properly then requires
			a wiki administrator to delete the old page and modify any links to the deleted page.

			<li>Some characters (underscore ( <tt>_</tt> ), for example) do not display in the page title; for them you can put <code><nowiki>{{DISPLAYTITLE</nowiki>:<i>correct_name</i>}}</code> at the top of the editor page (as in all $function pages).
			</ul>
			</blockquote>

			When you create the page content, specify at the bottom of the editor page the category to which the page belongs.
			A category is a collection of similar pages, and a category page contains links to each of its member pages.
			For example, here is the markup to add a page to the [[:Category:Parameters\|Parameters]] category:

			<p class="code"><nowiki>[[Category:Parameters]]</nowiki></p>

			If an existing category (see the [[Special:Categories\|Categories]] page) is not appropriate, name a new one with some care.

			===Editing a page===
			To edit a page, simply click the <tt>Edit</tt> tab that is usually at the top of each page. The editing page will appear, containing the existing markup. When you have finished making modifications, click the <tt>Show preview</tt> button to view the effect of your changes without committing them; then click the <tt>Save page</tt> button to commit your changes.

			For information about the conventions for markup of M204wiki pages, use the page you are currently reading, including the [[#See also\|See also]] section.

			====Handling pages that contain auto-generated content====
			Some pages contain content that is programmatically <b>generated</b> and meant <i>to be edited only by wiki administrators</i>. Such content is discernible when you view the content within the page editor. Typically you see that the content source is a <b>template</b> page (<code>{{Template:<i>Built_from_code</i>}}</code> markup), and often you see a comment like the following:
			<p class="code"><!-- This page was automatically generated and will be automatically
			replaced, so any manual edits will be lost. You've been warned. --> </p>
			The auto-generation is by [[:Category:SOUL\|SOUL]] operating on information in the <var class="product">Model 204</var> load module. Many of the wiki's "List of ..." pages are examples of this, for example, <code>[http://m204wiki.rocketsoftware.com/index.php/List_of_Arraylist_methods List of Arraylist methods]</code>.

			An alternative to personally updating such content is to copy the page or section's URL, then email it to the most relevant people or simply to <code>M204Support@rocketsoftware.com</code>, including a description of the update you had in mind.

			====Renaming a page====
			Use the page's <tt>Move</tt> tab to create a new page that contains the old page's content. The old page content gets replaced with the <code>#REDIRECT [[newpagename]]</code> markup which sends to the new page any links to the old page.

			If the old page name is no longer useful, it should be deleted:
			<ol>
			<li>Go to the page that contains the actual <code>REDIRECT</code> — a good way is to click the <tt>Recent changes</tt> link in the sidebar "toolbox," find your <code><b>Moved page</b> <i>oldName</i> <b>to</b> <i>newName</i></code> change, and click the <i>oldName</i> link.

			<li>From the old page, click the <tt>What links here</tt> link on the navigation sidebar. Then click each of those pages, and change the links to point to the new page name.

			<li>Ask a wiki administrator to delete the old page.
			</ol>

			===Discussing a page===
			If you want to inquire or comment about some of a page's content, you can click the <tt>Discussion</tt> tab at the top of the page. Because such pages are not heavily used, the tab is often colored red, which changes once you explicitly "create" the page, as the page's initial text advises. Often called a talk page because its name contains the prefix <code>Talk:</code>, you can edit a discussion page as you would a normal page, link to it, and view its editing history.

			To start a new discussion thread with its own heading on an already-created talk page, click the <tt>+</tt> or <tt>New section</tt> tab. For general tips concerning talk pages, see http://www.mediawiki.org/wiki/Help:Talk_pages.

	==Headings==		==Headings==

JAL: /* Examples */

2013-08-29T23:02:33Z

Examples

← Older revision		Revision as of 23:02, 29 August 2013
Line 88:		Line 88:
	end if		end if
	end for		end for
	~~.~~..		...
	</p>		</p>
	</p>		</p>
	~~Notes~~:		Of note in this example:
	<ul>		<ul>
	<li>M204wiki practice is to put the first line in the example on the same line as the <code><p class="code"></code> tag, and, by default, to start immediately after (no blanks) the closing angle bracket of that tag		<li>M204wiki practice is to put the first line in the example on the same line as the <code><p class="code"></code> tag, and, by default, to start immediately after (no blanks) the closing angle bracket of that tag
Line 100:		Line 100:
	<li>Put a blank in position one and the character in position two.		<li>Put a blank in position one and the character in position two.

	<li>Specify their equivalent [http://ascii.cl/htmlcodes.htm HTML decimal or entity code] (for example, for an asterisk, use <code>&#42;</code>)		<li>Specify their equivalent [http://ascii.cl/htmlcodes.htm HTML decimal or entity code] (for example, for an asterisk, use <code>&#42;</code>). In this example, you could omit the blank before the three-period ellipsis and replace the first period with <code>&#46;</code>.

	<li>Enclose the character in the <code><nowiki></code> tag (for example, for an asterisk, use <code><nowiki>*</nowiki></code>)		<li>Enclose the character in the <code><nowiki></code> tag (for example, for an asterisk, use <code><nowiki>*</nowiki></code>).
	</ul>		</ul>
	</ul>		</ul>

JAL at 22:47, 29 August 2013

2013-08-29T22:47:04Z

← Older revision		Revision as of 22:47, 29 August 2013
Line 5:		Line 5:
	<ul>		<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 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.		<li>It's easier for someone to edit or customize the look and feel of text based on its semantics if the semantics of the text is explicit in the markup.
	</ul>		</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.		In fact, as a general rule of thumb, if you're coding any explicit physical text attributes in your wiki markup, it is probably a sign that you are doing something wrong or that M204wiki 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.		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 convey a lot about the semantics of the enclosed word or words.

	==Headings==		==Headings==

JAL: /* Headings */

2013-08-21T21:33:56Z

Headings

← Older revision		Revision as of 21:33, 21 August 2013
Line 12:		Line 12:

	==Headings==		==Headings==
	The outermost headers on any page should be level two headers so should have two ~~equals sign~~ on either side:		The outermost headers on any page should be level two headers so should have two equal signs on either side:
	<p class="code"><nowiki>==This is a heading2==</nowiki>		<p class="code"><nowiki>==This is a heading2==</nowiki>
	</p>		</p>

JAL: /* Graphics and PDFs */

2013-08-01T18:05:22Z

Graphics and PDFs

← Older revision		Revision as of 18:05, 1 August 2013
Line 268:		Line 268:
	Model 204 documentation on M204wiki contains few graphics (images). For information about using graphics on an M204wiki page, see [http://www.mediawiki.org/wiki/Help:Images Help:Images]. For an M204wiki example, see [[Datetime string formats#Using CENTSPAN\|Using CENTSPAN]].		Model 204 documentation on M204wiki contains few graphics (images). For information about using graphics on an M204wiki page, see [http://www.mediawiki.org/wiki/Help:Images Help:Images]. For an M204wiki example, see [[Datetime string formats#Using CENTSPAN\|Using CENTSPAN]].

	To locate a .pdf file that has been uploaded to M204wiki, you can search for File:<i>filename</i>, where <i>filename</i> is the full name of the PDF file. Or you can specify the URL <code>http://m204wiki.rocketsoftware.com/index.php/File:filename</code>. Both methods will bring you to the "home page" of the file, from which you can invoke the PDF.		To locate a <code>.pdf</code> file that has been uploaded to M204wiki, you can search for <code>File:<i>filename</i></code>, where <i>filename</i> is the full name of the PDF file. Or you can specify the URL <code>http://m204wiki.rocketsoftware.com/index.php/File:filename</code>. Both methods will bring you to the "home page" of the file, from which you can invoke the PDF.

	From the PDF's home page, you can also hover your mouse over the link to the PDF, which will reveal the URL of the file. You can then use that URL to code links to directly invoke the PDF without having first to go to its home page.		From the PDF's home page, you can also hover your mouse over the link to the PDF, which will reveal the URL of the file. You can then use that URL to code links to directly invoke the PDF without having first to go to its home page.

JAL: /* Graphics */

2013-08-01T18:02:09Z

Graphics

← Older revision		Revision as of 18:02, 1 August 2013
Line 265:		Line 265:
	You should heed this warning, and, instead of updating the page, copy the URL of of the wiki section most closely containing the wiki content that you want to update, and paste the URL into an email to the most relevant people describing the update you had in mind. Further discussion will likely ensue.		You should heed this warning, and, instead of updating the page, copy the URL of of the wiki section most closely containing the wiki content that you want to update, and paste the URL into an email to the most relevant people describing the update you had in mind. Further discussion will likely ensue.

	==Graphics==		==Graphics and PDFs==
	Model 204 documentation on M204wiki contains few graphics (images). For information about using graphics on an M204wiki page, see [http://www.mediawiki.org/wiki/Help:Images Help:Images]. For an M204wiki example, see [[Datetime string formats#Using CENTSPAN\|Using CENTSPAN]].		Model 204 documentation on M204wiki contains few graphics (images). For information about using graphics on an M204wiki page, see [http://www.mediawiki.org/wiki/Help:Images Help:Images]. For an M204wiki example, see [[Datetime string formats#Using CENTSPAN\|Using CENTSPAN]].

			To locate a .pdf file that has been uploaded to M204wiki, you can search for File:<i>filename</i>, where <i>filename</i> is the full name of the PDF file. Or you can specify the URL <code>http://m204wiki.rocketsoftware.com/index.php/File:filename</code>. Both methods will bring you to the "home page" of the file, from which you can invoke the PDF.

			From the PDF's home page, you can also hover your mouse over the link to the PDF, which will reveal the URL of the file. You can then use that URL to code links to directly invoke the PDF without having first to go to its home page.

	==Section numbering==		==Section numbering==

JAL: /* Tables */

2013-07-18T19:32:42Z

Tables

@@ Line 179: / Line 179: @@
 <p class="note"><b>Note:</b> Tag <i>heading</i> rows with &lt;tr class="head">.</p></td></tr>
 </table>
 </ul>

JAL: /* Tables */

2013-06-29T00:49:29Z

Tables

← Older revision		Revision as of 00:49, 29 June 2013
Line 149:		Line 149:
	<li>In this example, the table has no column headings and no preceding caption. This is frequently the case with M204wiki tables.		<li>In this example, the table has no column headings and no preceding caption. This is frequently the case with M204wiki tables.
	<ul>		<ul>
	<li>To create a '''heading row''', tag each cell in the row with <code><th></code>. ~~To prevent~~ text in such headings from wrapping (probably what you want), ~~you can tag~~ the ~~row with the "head" class~~. For example:		<li>To create a '''heading row''', tag the row (<tr>) with the "head" class, and tag each cell in the row with <code><th></code>. The "head" class prevents text in such headings from wrapping (probably what you want), and it makes the heading text non-italic. For example:
	<p class="code"><tr class="head"><th>A wordy column-heading title</th><th>Another wordy column-heading title<th></tr> </p>		<p class="code"><tr class="head"><th>A wordy column-heading title</th><th>Another wordy column-heading title<th></tr> </p>

Line 167:		Line 167:

	<table>		<table>
	<tr><th>Desired effect </th><th>Technique</th></tr>		<tr class="head"><th>Desired effect </th><th>Technique</th></tr>

	<tr><td nowrap>Some non-italic (but still auto-bold) items</td>		<tr><td nowrap>Some non-italic (but still auto-bold) items</td>
Line 177:		Line 177:
	<tr><td>All not auto-italic (but still auto-bold)</td>		<tr><td>All not auto-italic (but still auto-bold)</td>
	<td>Use the <code><table class="thJustBold"></code> tag, and keep the first-column <code><th></code> tags.		<td>Use the <code><table class="thJustBold"></code> tag, and keep the first-column <code><th></code> tags.
	<p class="note"><b>Note:</b> ~~In this case, to keep <i>heading</i> <th> content italic (the default), tag~~ <i>heading</i> rows with <tr class="head">.</p></td></tr>		<p class="note"><b>Note:</b> Tag <i>heading</i> rows with <tr class="head">.</p></td></tr>
	</table>		</table>
	</ul>		</ul>

M204wiki style guide - Revision history

JAL: Replaced content with "Note: 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 ..."

JAL: /* Pages that contain auto-generated content */

JAL: /* Overview */

JAL: /* Examples */

JAL at 22:47, 29 August 2013

JAL: /* Headings */

JAL: /* Graphics and PDFs */

JAL: /* Graphics */

JAL: /* Tables */

JAL: /* Tables */

JAL: Replaced content with "
Note: 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 ..."