Help:Contents

From SIMILE Widgets
(Difference between revisions)
Jump to: navigation, search
(Style guide)
 
(7 intermediate revisions by one user not shown)
Line 1: Line 1:
== Style guide ==
+
==MediaWiki Editing Basics==
  
A guide to preferred usage and presentation of terms used throughout this wiki. <!-- TODO add to style guide -->
+
The fundamentals of using MediaWiki can be found over at the MediaWiki site:
  
; SIMILE Widgets
+
* [http://www.mediawiki.org/wiki/Help:Formatting Formatting Markup and Layout]
: '''NOT''' Simile Widgets – SIMILE widgets – Simile widgets
+
* [http://www.mediawiki.org/wiki/Help:Tables Using Tables]
: refers to this open-source project
+
* [http://www.mediawiki.org/wiki/Help:Links Internal and External Links]
; SIMILE Project
+
* [http://www.mediawiki.org/wiki/Help:Images Using Images]
: '''NOT''' Simile Project – SIMILE project – Simile project
+
* [http://www.mediawiki.org/wiki/Help:Managing_files Managing Files (including Images)]
: refers to the original MIT project from which SIMILE Widgets derives
+
* [http://www.mediawiki.org/wiki/Help:Contents Primary Help Pages from MediaWiki.org]
 +
 
 +
==MediaWiki Tips and Tricks==
 +
 
 +
=== Find all external links ===
 +
 
 +
You can search for external links matching a certain protocol with [[Special:LinkSearch]]. There doesn't seem an easy way to get at all of them at once, but you can use <code>*.com</code>, <code>*.org</code> and the like to return all links for a given TLD.
 +
 
 +
=== Add TODO notes to pages ===
  
== Find external links ==
+
You can add a TODO reminder to any page using HTML comment syntax (<code><nowiki><!-- --></nowiki></code>). These are largely invisible to end-users but [http://simile-widgets.org/w/index.php?title=Special%3ASearch&search=TODO&go=Go will show up in search], which makes them an excellent way to leave reminders for yourself and others of work that needs to be done on particular pages.
  
You can search for external links matching a certain protocol with [[Special:LinkSearch]].
+
<code><nowiki><!-- TODO your text here --></nowiki></code>
  
== Assign a category to a page ==
+
=== Assign a category to a page ===
  
 
To add a category (e.g. Facets) to a given page, add the following anywhere on the page (at end is best):
 
To add a category (e.g. Facets) to a given page, add the following anywhere on the page (at end is best):
Line 20: Line 28:
 
  <nowiki>[[Category:Facets]]</nowiki>
 
  <nowiki>[[Category:Facets]]</nowiki>
  
== Add a code span or block ==
+
=== Redirect one page to another ===
 +
 
 +
To redirect an existing page to another page, use the following syntax as the first line of the page to be redirected:
 +
 
 +
<nowiki>#REDIRECT[[Page to redirect to]]</nowiki>
 +
 
 +
=== Add a code span or block ===
  
 
For a code fenced paragraph that respects indentation, use a space ("<code> </code>") followed by <code><nowiki><nowiki></nowiki></code> tags:
 
For a code fenced paragraph that respects indentation, use a space ("<code> </code>") followed by <code><nowiki><nowiki></nowiki></code> tags:
Line 42: Line 56:
 
</div></nowiki>
 
</div></nowiki>
  
== Transclude one page inside another ==
+
=+= Transclude one page inside another ==+
  
Use <code><nowiki>{{Exhibit3}}</nowiki></code>. Items in the main namespace must use a leading colon, e.g. <code><nowiki>{{:Exhibit3}}</nowiki></code>. See [https://www.mediawiki.org/wiki/Transclusion Transclusion] on MediaWiki site for more details.
+
Use <code><nowiki>{{Exhibit3}}</nowiki></code> to 'insert' or transclude the content of one page inside of another. Items in the main namespace must use a leading colon, e.g. <code><nowiki>{{:Exhibit3}}</nowiki></code>. See [https://www.mediawiki.org/wiki/Transclusion Transclusion] on MediaWiki site for more details.
  
== Transclude category listings ==
+
=== Transclude category listings ===
  
Per [http://stackoverflow.com/a/1053259 Stack Overflow,] Semantic MediaWiki allows you to do so with:
+
In addition to MediaWiki, this wiki also uses Semantic MediaWiki, which (per [http://stackoverflow.com/a/1053259 Stack Overflow]) allows you to do clever stuff like insert links to all pages in a given category as a bulleted list, like so:
  
 
  <nowiki>{{#ask:[[Category: Facets]]
 
  <nowiki>{{#ask:[[Category: Facets]]
Line 54: Line 68:
 
}}</nowiki>
 
}}</nowiki>
  
Which yields:
+
This yields:
  
{{#ask:[[Category: Facets]]
+
{{#ask:[[Category: Facets]]|format=ul}}
|format=ul
+
}}
+
  
==MediaWiki Help==
+
== Style guide ==
  
* [http://www.mediawiki.org/wiki/Help:Formatting Formatting Markup and Layout]
+
Preferred usage and formatting of terms used throughout this wiki. See also [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia's Manual of Style]. <!-- TODO add to style guide -->
* [http://www.mediawiki.org/wiki/Help:Tables Using Tables]
+
* [http://www.mediawiki.org/wiki/Help:Links Internal and External Links]
+
* [http://www.mediawiki.org/wiki/Help:Images Using Images]
+
* [http://www.mediawiki.org/wiki/Help:Managing_files Managing Files (including Images)]
+
  
* [http://www.mediawiki.org/wiki/Help:Contents Primary Help Pages from MediaWiki.org]
+
; SIMILE Widgets
 +
: '''NOT''' Simile Widgets – SIMILE widgets – Simile widgets
 +
: refers to this open-source project
 +
; SIMILE Project
 +
: '''NOT''' Simile Project – SIMILE project – Simile project
 +
: refers to the original MIT project from which SIMILE Widgets derives

Latest revision as of 05:21, 3 November 2015

Contents

MediaWiki Editing Basics

The fundamentals of using MediaWiki can be found over at the MediaWiki site:

MediaWiki Tips and Tricks

Find all external links

You can search for external links matching a certain protocol with Special:LinkSearch. There doesn't seem an easy way to get at all of them at once, but you can use *.com, *.org and the like to return all links for a given TLD.

Add TODO notes to pages

You can add a TODO reminder to any page using HTML comment syntax (<!-- -->). These are largely invisible to end-users but will show up in search, which makes them an excellent way to leave reminders for yourself and others of work that needs to be done on particular pages.

<!-- TODO your text here -->

Assign a category to a page

To add a category (e.g. Facets) to a given page, add the following anywhere on the page (at end is best):

[[Category:Facets]]

Redirect one page to another

To redirect an existing page to another page, use the following syntax as the first line of the page to be redirected:

#REDIRECT[[Page to redirect to]]

Add a code span or block

For a code fenced paragraph that respects indentation, use a space (" ") followed by <nowiki> tags:

 <nowiki><div ex:role="facet" 
   ex:expression=".age"
   ex:facetClass="Slider" 
   ex:horizontal="true"
   ex:precision="100"
   ex:histogram="true">
</div></nowiki>

Which renders as:

<div ex:role="facet" 
   ex:expression=".age"
   ex:facetClass="Slider" 
   ex:horizontal="true"
   ex:precision="100"
   ex:histogram="true">
</div>

=+= Transclude one page inside another ==+

Use {{Exhibit3}} to 'insert' or transclude the content of one page inside of another. Items in the main namespace must use a leading colon, e.g. {{:Exhibit3}}. See Transclusion on MediaWiki site for more details.

Transclude category listings

In addition to MediaWiki, this wiki also uses Semantic MediaWiki, which (per Stack Overflow) allows you to do clever stuff like insert links to all pages in a given category as a bulleted list, like so:

{{#ask:[[Category: Facets]]
|format=ul
}}

This yields:


Style guide

Preferred usage and formatting of terms used throughout this wiki. See also Wikipedia's Manual of Style.

SIMILE Widgets
NOT Simile Widgets – SIMILE widgets – Simile widgets
refers to this open-source project
SIMILE Project
NOT Simile Project – SIMILE project – Simile project
refers to the original MIT project from which SIMILE Widgets derives
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox