Protospace Wiki:Wiki conventions: Difference between revisions

Jump to navigation Jump to search
m
Ian Oliver moved page Wiki conventions to Protospace Wiki:Wiki conventions: moving wiki meta page into wiki meta namespace
m (Updated template names)
m (Ian Oliver moved page Wiki conventions to Protospace Wiki:Wiki conventions: moving wiki meta page into wiki meta namespace)
 
(5 intermediate revisions by one other user not shown)
Line 9: Line 9:


==== Equipment page titles ====
==== Equipment page titles ====
Equipment page titles should follow the format ''<equipment type>[, <salient and/or differentiating qualities>][ (<make and model>)]'', where square brackets indicate optional parts and angle brackets indicate parts you fill in with the appropriate information. (This is a ''fully qualified equipment name''; future improvements to the wiki will allow tools to also be referred to by short names, with some degree of automatic generation and association between the different kinds of names. FQENs allow easy disambiguation and sorting.)
Equipment page titles should follow the format ''<equipment type>[, <salient and/or differentiating qualities>][ (<make and model>)] ID:<tool's ID number>'', where square brackets indicate optional parts and angle brackets indicate parts you fill in with the appropriate information. (This is a ''fully qualified equipment name''; future improvements to the wiki will allow tools to also be referred to by short names, with some degree of automatic generation and association between the different kinds of names. FQENs allow easy disambiguation and sorting.)


'''Examples of good equipment page titles:''' [[Air compressor, 80-gallon (MAXair Premium)]], [[milling machine (ACRA AM4V)]], and [[inspection mirror, 18" gooseneck]].
'''Examples of good equipment page titles:''' [[Air compressor, 80-gallon (MAXair Premium)]], [[milling machine (ACRA AM4V)]], and [[inspection mirror, 18" gooseneck]].
Line 26: Line 26:


After the template and before any further sections, please add any categories appropriate for the equipment. The templates automatically add [[:Category:Tools]] or [[:Category:Tools no longer at Protospace]], respectively. The other categories to apply to tools are subcategories of those; you can browse their child categories to find appropriate categories to add. Adding categories is done with the same syntax as links. For example, including the code <nowiki>[[Category:Woodworking tools]]</nowiki> adds the page to that category. (To link to a category as seen earlier in this paragraph, use e.g. <nowiki>[[:Category:Woodworking tools]]</nowiki>.)
After the template and before any further sections, please add any categories appropriate for the equipment. The templates automatically add [[:Category:Tools]] or [[:Category:Tools no longer at Protospace]], respectively. The other categories to apply to tools are subcategories of those; you can browse their child categories to find appropriate categories to add. Adding categories is done with the same syntax as links. For example, including the code <nowiki>[[Category:Woodworking tools]]</nowiki> adds the page to that category. (To link to a category as seen earlier in this paragraph, use e.g. <nowiki>[[:Category:Woodworking tools]]</nowiki>.)
=== Equipment image names ===
Images of equipment should use the tool's ID number as their filename. For example, the image used on the [[Laser cutter (Trotec Speedy 300) ID:107|Trotec's page]] is called [[:File:107.jpg|107.jpg]], as the Trotec's ID number is [[107]].


=== Font Awesome icons ===
=== Font Awesome icons ===


As listed below in the ''Installed extensions and modules'' section, this wiki has Font Awesome installed. The following icons are suggested—use others that seem appropriate wherever you want:
As listed below in the ''Installed extensions and modules'' section, this wiki has Font Awesome 4.4 installed. The following icons are suggested—use others that seem appropriate wherever you want:


* For links that are only accessible to Protospace members (e.g. administration mailing list, my.protospace.ca), use the '''key''' icon: <i class="fa fa-key"></i> <code>&lt;i class="fa fa-key"&gt;&lt;/i&gt;</code>
* For links that are only accessible to Protospace members (e.g. administration mailing list, my.protospace.ca), use the '''key''' icon: <span class="fa fa-key"></span> <code>&lt;span class="fa fa-key"&gt;&lt;/span&gt;</code>
* For checklists, use the '''square-o''' and '''check-square-o''' icons: <i class="fa fa-square-o"></i> <code>&lt;i class="fa fa-square-o"&gt;&lt;/i&gt;</code>, <i class="fa fa-check-square-o"></i> <code>&lt;i class="fa fa-check-square-o"&gt;&lt;/i&gt;</code>
* For checklists, use the '''square-o''' and '''check-square-o''' icons: <span class="fa fa-square-o"></span> <code>&lt;span class="fa fa-square-o"&gt;&lt;/span&gt;</code>, <span class="fa fa-check-square-o"></span> <code>&lt;span class="fa fa-check-square-o"&gt;&lt;/span&gt;</code>


== Installed extensions and modules ==
== Installed extensions and modules ==
Line 38: Line 42:


=== Font Awesome ===
=== Font Awesome ===
[http://fontawesome.io Font Awesome] is an open source Icon pack, we use the provided [https://www.bootstrapcdn.com/ BootstrapCDN] copy so we're not dragging down our shared hosting.
[https://fontawesome.com/v4.7.0/ Font Awesome 4] is an open source Icon pack, we use the provided [https://www.bootstrapcdn.com/ BootstrapCDN] copy so we're not dragging down our shared hosting.


FontAwesome 4.4 is licensed under [http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL SIL OFL 1.1] (Open Font License).
This wiki uses Font Awesome 4.4, which is licensed under [http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL SIL OFL 1.1] (Open Font License).


[http://fontawesome.io/icons/ For a full list of icons available for your usage on our wiki click here.]
[https://fontawesome.com/v4.7.0/icons/ List of icons available in Font Awesome 4.]<br>
'''Note:''' This list is for a later version of Font Awesome 4 than is used on this wiki, so not all of the icons listed are available for use here.


We integrated FontAwesome in our wiki via LocalSettings.php (non-extension).
We integrated FontAwesome in our wiki via LocalSettings.php (non-extension).


'''Example:''' <nowiki><i class="fa fa-smile-o"></i></nowiki>
'''Example:''' <nowiki><span class="fa fa-smile-o"></span></nowiki>


'''Result:''' <i class="fa fa-smile-o"></i>
'''Result:''' <span class="fa fa-smile-o"></span>


=== EmbedVideo ===
=== EmbedVideo ===

Navigation menu