Updating M204wiki - Revision history

JAL: /* Categories and Lists */ mention WIKIPROC

2018-08-14T18:45:34Z

Categories and Lists: mention WIKIPROC

← Older revision		Revision as of 18:45, 14 August 2018
Line 428:		Line 428:
	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 [http://www.mediawiki.org/wiki/Help:Categories Category] technology. Our compromise has been to use both MediaWiki categories ''and'' to create hand-built 'list' pages, buttressed by some <var class="product">SOUL</var> consistency checks.		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 [http://www.mediawiki.org/wiki/Help:Categories Category] technology. Our compromise has been to use both MediaWiki categories ''and'' to create hand-built 'list' pages, buttressed by some <var class="product">SOUL</var> consistency checks.

	The standard MediaWiki category page is less informative than a hand-built list, but it 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.		The standard MediaWiki category page is less informative than a hand-built list, but it 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.

	Some lists, such as the [[List of $functions#List of standard $functions\|List of standard $functions]], are generated by <var class="product">SOUL</var> code (in this case, by the FUNSCHECK.WIKI procedure, which operates against the underlying $functions category page) for greater accuracy. Other lists have not yet had the <var class="product>SOUL</var> built to generate them from their associated category pages (for example, the [[List of JANUS WEB subcommands]] and the [[:Category:JANUS WEB subcommands\|JANUS WEB subcommands category page]]). And some lists, such as the		Some lists, such as the [[List of $functions#List of standard $functions\|List of standard $functions]], are generated by <var class="product">SOUL</var> code (in this case, by the FUNSCHECK.WIKI procedure (in WIKIPROC file on ULSPFWIK), which operates against the underlying $functions category page) for greater accuracy. Other lists have not yet had the <var class="product>SOUL</var> built to generate them from their associated category pages (for example, the [[List of JANUS WEB subcommands]] and the [[:Category:JANUS WEB subcommands\|JANUS WEB subcommands category page]]). And some lists, such as the
	hand-built [[List of Fast/Unload $functions]], do not have specific category pages to reference so they are harder to generate with SOUL.		hand-built [[List of Fast/Unload $functions]], do not have specific category pages to reference so they are harder to generate with SOUL.

ELowell: /* Links */

2018-04-18T21:26:51Z

Links

← Older revision		Revision as of 21:26, 18 April 2018
Line 156:		Line 156:
	<p class="code" style="Color:#BA0000">My special link text</p>		<p class="code" style="Color:#BA0000">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].		The link text above will display in red to remind you that this page has yet to be created. For more information about 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,		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,
Line 164:		Line 164:

	In the wiki page view, the above markup displays as:		In the wiki page view, the above markup displays as:
	<p class="code"><nowiki>[~~[My target page~~#~~My section~~\|~~My section~~]]</nowiki></p>		<p class="code">My section</p>

			To create a link to a non-heading spot in a page, such as a specific paragraph,
			use a div to create an anchor on the target page at the spot you want to link to:
			<p class="code"><nowiki><div id="NameOfAnchorHere"></div></nowiki></p>
			This anchor is not visible in the wiki page view.

			You would then create the link as:
			<p class="code"><nowiki>[[PageName#NameOfAnchorHere\|link_text]]</nowiki></p>

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

JAL: /* Adding comments to your revisions */ add comment and ID

2017-12-12T22:23:48Z

Adding comments to your revisions: add comment and ID

← Older revision		Revision as of 22:23, 12 December 2017
Line 102:		Line 102:
	You might find it useful to include the section title in your comment. (Sometimes the title is included by default in the summary and you can append your comments to it.)</p>		You might find it useful to include the section title in your comment. (Sometimes the title is included by default in the summary and you can append your comments to it.)</p>
	<p>		<p>
	Once you save the page, the comment will disappear from the Summary box and be added to the revision history of the page, as shown here: </p>		Once you save the page, the comment will disappear from the Summary box and be added to the revision history of the page, as shown here (right bottom of screenshot): </p>

	<p class="figure">[[File:Wiki history with comment.png\|border\|550px]] </p>		<p class="figure">[[File:Wiki history with comment.png\|border\|550px]] </p>

	<blockquote class="note">		<blockquote class="note">
	<p><b>Tip:</b> Busy pages accumulate many revisions and the history page can get crowded. To expand the viewing area of the page, click the Toggle sidebar option in the tab at the top of the page adjacent to the <tt>View history</tt> tab:</p>		<p id=togSidebar"><b>Tip:</b> Busy pages accumulate many revisions and the history page can get crowded. To expand the viewing area of the page, click the Toggle sidebar option in the tab at the top of the page adjacent to the <tt>View history</tt> tab:</p>
	<p class="figure">[[File:TogSidebar.png\|200px]] </p>		<p class="figure">[[File:TogSidebar.png\|200px]] </p>
	</blockquote></li>		</blockquote></li>

ELowell: /* Notes and warnings */

2017-07-11T22:17:01Z

Notes and warnings

← Older revision		Revision as of 22:17, 11 July 2017
Line 338:		Line 338:

	See also: [[#Graphics and PDFs\|Graphics and PDFs]], below.		See also: [[#Graphics and PDFs\|Graphics and PDFs]], below.

			==Bulleted and numbered lists==
			To list items that are not in a particular order, make a bulleted list, using the unordered list tag <code>ul</code>.

			For steps that must be done in order, make a numbered list, using the ordered list tag <code>ol</code>.

			A bulleted list:
			<ul><li>elephant</li>
			<li>xylophone</li>
			</ul>

			A numbered list:
			<ol><li>Log in to the wiki.</li>
			<li>Navigate to the page that you want:</li>
			<ol type="a">
			<li>Enter a string in the Search field at the top of the page.</li>
			<li>Select a page name from the list returned by the search engine.</li>
			</ol>
			</li>
			<li>Click the Edit tab at the top of the page to begin editing the wiki page.</li>
			</ol>
			The previous example creates substeps in an ordered list of steps by nesting another ordered list. Use a different numbering convention for the substeps by specifying a different numbering type, such as "a":
			<p class="code"><nowiki><ol type="1\|a\|A\|i\|I"></nowiki></p>

	==Notes and warnings==		==Notes and warnings==

ELowell: /* Section numbering */

2017-06-06T21:28:03Z

Section numbering

← Older revision		Revision as of 21:28, 6 June 2017
Line 459:		Line 459:
	<p class="code"><div class="noautonum">__TOC__</div>		<p class="code"><div class="noautonum">__TOC__</div>
	</p>		</p>
			===TOC levels===
			To limit the number of levels that display in the table of contents, enter a command such as the following at the top of the page:
			<p class="syntax"><nowiki><div class="toclimit-3"></nowiki></p>
			Add the corresponding </div> at the bottom of the page (or wherever you want to TOC limit to end); a comment would also be helpful:
			<p class="syntax"><nowiki></div> <!-- end of toc limit div --></nowiki></p>

	===Skins===		===Skins===

ELowell: /* Syntax diagrams */

2017-03-28T19:54:20Z

Syntax diagrams

← Older revision		Revision as of 19:54, 28 March 2017
Line 203:		Line 203:
	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.		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/scrolling or becoming difficult to scan because of the number of characters on a single line. To get a long syntax to fit on one line, try making the font a bit smaller; for example:		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/scrolling or becoming difficult to scan because of the number of characters on a single line. To get a long syntax to fit on one line, try making the font a bit smaller for that paragraph. The font-size attribute in this example causes the font to display at 98% of its usual size:
	<p class="syntax"><p class="syntax" style="font-size:98%"></p>		<p class="syntax"><p class="syntax" style="font-size:98%">
	Use a percentage instead of a fixed size. Sometimes a reduction by just one or two percentage points can make the text fit.		</p></p>
			Use a font-size percentage instead of a fixed font size. Sometimes a reduction by just one or two percentage points can make the text fit.

	==Examples==		==Examples==

ELowell: /* Syntax diagrams */

2017-03-28T19:48:57Z

Syntax diagrams

← Older revision		Revision as of 19:48, 28 March 2017
Line 201:		Line 201:
	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.		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.		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/scrolling or becoming difficult to scan because of the number of characters on a single line. To get a long syntax to fit on one line, try making the font a bit smaller; for example:
			<p class="syntax"><p class="syntax" style="font-size:98%"></p>
			Use a percentage instead of a fixed size. Sometimes a reduction by just one or two percentage points can make the text fit.

	==Examples==		==Examples==

ELowell: /* Examples */

2017-03-28T19:41:06Z

Examples

← Older revision		Revision as of 19:41, 28 March 2017
Line 224:		Line 224:
	<li>Specify their equivalent [http://ascii.cl/htmlcodes.htm HTML decimal or entity code] (for example, for an asterisk, use <code>&#42;</code>) </li>		<li>Specify their equivalent [http://ascii.cl/htmlcodes.htm HTML decimal or entity code] (for example, for an asterisk, use <code>&#42;</code>) </li>

	<li>Enclose the character in the <code><nowiki></code> tag (for example, for an asterisk, use <code><nowiki>*</nowiki></code>) </li>		<li>Enclose the character in the <code><nowiki></code> tag (for example, for an asterisk, use <code><nowiki>*</nowiki></code>). <br />If several items in an example are problematic, such as horizontal lines used for column headers, enclose the entire example in <code><nowiki></code> tags.</li>
	</ul> </li>		</ul> </li>

ELowell: /* Tables */

2017-02-24T00:36:18Z

Tables

← Older revision		Revision as of 00:36, 24 February 2017
Line 278:		Line 278:
	<p class="code"><tr class="head">		<p class="code"><tr class="head">
	<th>A wordy column-heading title</th><th>Another wordy column-heading title<th>		<th>A wordy column-heading title</th><th>Another wordy column-heading title<th>
	</tr> </p></li>		</tr> </p>
			<p>If you want bold, non-italic headings that can wrap, do not apply the "head" class to the row -- instead apply the "thJustBold" class (mentioned below) to the entire table (<table class="thJustBold">).</p>
			</li>

	<li>To create a '''table caption''', specify a <code><caption></code> tag after the <code><table></code> tag and before any heading tags. For example:		<li>To create a '''table caption''', specify a <code><caption></code> tag after the <code><table></code> tag and before any heading tags. For example:
Line 305:		Line 307:
	<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> Tag <i>heading</i> rows with <code><tr class="head"></code>.</p></td></tr>		<p class="note"><b>Note:</b> Tag <i>heading</i> rows with <code><tr class="head"></code>...unless you want them to wrap.</p></td></tr>
	</table>		</table>

JAL: /* Formatting for a graphic image */ link repair

2016-06-30T23:07:12Z

Formatting for a graphic image: link repair

← Older revision		Revision as of 23:07, 30 June 2016
Line 405:		Line 405:

	===Formatting for a graphic image===		===Formatting for a graphic image===
	Model 204 documentation on M204wiki contains few graphics (images). For an M204wiki example, see [~~http://m204wiki.rocketsoftware.com/index.php/Tracking_system_activity_~~(CCAJRNL,~~_CCAAUDIT~~,~~_CCAJLOG~~)#~~Using_the_CCAJRNL_data_set~~ Using the CCAJRNL data set].		Model 204 documentation on M204wiki contains few graphics (images). For an M204wiki example, see [[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#Using the CCAJRNL data set\|Using the CCAJRNL data set]].
	<blockquote class="note">		<blockquote class="note">
	<p><b>Note:</b> This example demonstrates: </p>		<p><b>Note:</b> This example demonstrates: </p>