RichMorin: Automated import of articles

2010-07-27T20:56:44Z

Automated import of articles

New page

== Conventions ==

<noinclude>{{Pr4_UG_mi_TOC}}<div id='pr4_ug'></noinclude>

The guide has a number of conventions
which help to keep it tidy and organized.
Please try to follow these when editing and/or creating pages.

=== Formatting ===

For ease of editing and printing,
try to keep the "source" lines for wiki pages under 80 characters.
Ideally, line breaks should be located at sentence and/or phrase boundaries.
Use the existing page formatting as a model.

MediaWiki variables (eg, <tt>#var:G</tt>, <tt>#var:Pr4</tt>)
are used throughout the guide
as a way to shorten URLs, regularize content, etc.
Global definitions are stored in [[Template:Pr4_UG]];
please <b>don't</b> modify them unless you know what you're doing!

MediaWiki syntax is fine for simple formatting,
but it isn't as flexible or powerful as HTML.
Don't be afraid to use HTML if you need it
(see the source text for this page as an example).

Be careful not to add extra newlines between paragraphs, etc.
Depending on the settings in effect,
MediaWiki will allocate space on the rendered page
for each blank line it encounters in the source.

In general, pages should be small enough to load quickly.
The [[Pr4_UG_mi_Glossary|Glossary]] page doesn't meet this standard,
but this exception is (somewhat) justified
by the need to bounce around quickly in the page.

=== Marginalia, placeholders, etc. ===

Sometimes you may want to flag a place where editing is needed,
but don't want to interrupt the appearance and/or flow
of the formatted page.
The guide uses specially formatted HTML comments for this purpose.
These are invisible in the formatted page,
but the results can be harvested for analysis, etc.
See the [[Pr4_UG_mi_Page_Report|Page Report]] for more information.

=== Page Indexing ===

To ease navigation, pages are indexed in multiple locations.
Please update these locations if you add or rename a page:

<ul>
<li>the "TOC" (Table Of Contents) template and topic page
for the enclosing chapter (section, in the Views chapter)

<li>the [[Pr4_UG_mi_Outline |Outline]]
and [[Pr4_UG_mi_Page_List|Page List]]
</ul>

=== Page Naming ===

All page names (including <tt>Image:*</tt> and <tt>Template:*</tt>)
begin with the string <tt>Pr4_UG</tt>.
This makes it clear that they belong to the {{#var:Pr4}} User's Guide.
Do <b>not</b> rename a page in the guide without checking with the staff;
you may not be aware of links and other dependencies!

Names are subdivided according to "chapter".
Names related to a chapter
begin with the string <tt>Pr4_UG_<i>cn</i></tt>,
where <tt><i>cn</i></tt> is a two-letter abbreviation of the chapter name.
The overview page for each chapter is named <tt>Pr4_UG_<i>cn</i></tt>;
all other pages are named <tt>Pr4_UG_<i>cn</i>_*</tt>.

The current list of chapter name abbreviations is as follows:

<ul>
<table><tr><td width=150><table>
<tr><td width=25><tt>co</tt></td><td>Concepts</td></tr>
<tr><td width=25><tt>ex</tt></td><td>Examples</td></tr>
<tr><td width=25><tt>h2</tt></td><td>HowTos</td></tr>
<tr><td width=25><tt>mi</tt></td><td>Miscellany</td></tr>
<tr><td width=25><tt>ov</tt></td><td>Overview</td></tr>
</table></td><td><table>
<tr><td width=25><tt>rm</tt></td><td>Ref - Menus</td></tr>
<tr><td width=25><tt>rp</tt></td><td>Ref - Plugins</td></tr>
<tr><td width=25><tt>rt</tt></td><td>Ref - Tabs</td></tr>
<tr><td width=25><tt>rv</tt></td><td>Ref - Views</td></tr>
<tr><td width=25><tt>ui</tt></td><td>User Interface</td></tr>
</table></td></tr></table>
</ul>

Names in the "Views" chapter are further subdivided by view type.
The overview page for each view type is named <tt>Pr4_UG_rv_<i>vt</i></tt>;
all other pages are named <tt>Pr4_UG_<i>vt</i>_*</tt>.

The current list of view type abbreviations is as follows:

<ul>
<table><tr><td width=150><table>
<tr><td width=25><tt>An</tt></td><td>Annotation</td></tr>
<tr><td width=25><tt>Cl</tt></td><td>Class</td></tr>
<tr><td width=25><tt>Da</tt></td><td>Data Property</td></tr>
<tr><td width=25><tt>Dt</tt></td><td>Datatype</td></tr>
</table></td><td><table>
<tr><td width=25><tt>In</tt></td><td>Individual</td></tr>
<tr><td width=25><tt>Mi</tt></td><td>Misc</td></tr>
<tr><td width=25><tt>Ob</tt></td><td>Object Property</td></tr>
<tr><td width=25><tt>On</tt></td><td>Ontology</td></tr>
</table></td></tr></table>
</ul>

Here are some representative examples:

<ul>
<li><tt>Pr4_UG_co_Ontology</tt> -
[[Pr4_UG_co_Ontology|Ontology page]]
in [[Pr4_UG_co|Concepts chapter]]
<li><tt>Pr4_UG_rm_Refactor</tt> -
[[Pr4_UG_rm_Refactor|Refactor page]]
in (reference) [[Pr4_UG_rm|Menus chapter]]
<li><tt>Pr4_UG_rv_Cl_Usage</tt> -
[[Pr4_UG_rv_Cl_Usage|Usage page]]
in [[Pr4_UG_rv_Cl|Class section]]
of (reference) [[Pr4_UG_rv|Views chapter]]
</ul>

</div>

Pr4 UG mi Conventions - Revision history

RichMorin: Automated import of articles