View source

This page is the manual of style for the Escher wiki.

==Language==
* The word "figure" is preferred for plane sets, drawings, images when discussing symmetries.
* Use of "we" is acceptable but try to avoid as much as possible.
* Use of "you" is avoided.

==Mathematical Definitions==
When defining a mathematical concept, use the [[Template:define]] template around the words being defined.  At the moment, this simply puts the words into '''bold''' face.  Later, this will be used for indexing.

Definitions can be made as part of the flow of the text:
 <nowiki>If points on an object are equally positioned about a point, then we say the object has {{define|rotational symmetry}}.</nowiki>
which gives:

<div style="border: 1px dotted">
If points on an object are equally positioned about a point, then we say the object has {{define|rotational symmetry}}.
</div>

Or using the mediawiki define syntax:
 <nowiki>;Similar triangles:Two triangles are {{define|similar}} if they have the same angle measures.</nowiki>
which gives:

<div style="border: 1px dotted">
;Similar triangles:Two triangles are {{define|similar}} if they have the same angle measures.
</div>

==Boxed Statements or Formulas==
To emphasize an very important statement or formula, use the [[Template:Boxed]] template around the text.
The text
 <nowiki>{{boxed|A very important formula}}</nowiki>
results in
{{boxed|A very important formula}}

==Explorations==
An exploration called "Really Fun" should be on a page named "Really Fun Exploration".
Every exploration should include [[Template:Exploration]] at the top.  Every exploration should also
include [[Template:Time]] and [[Template:Objective]] at the top to list the learning objective and the expected time for completion.
At the bottom, include [[Template:Handin]] to explicitly state what should be handed in by the student.

An example of a correctly formatted Exploration:

 <nowiki>
 {{Exploration}}
 {{Time|20}}
 {{Objective|Waste 20 Minutes.}}
 Step 1: Use Inkscape to draw a lobster.
 {{Handin|A printout of your lobster picture}}
 </nowiki>

Using just <nowiki>{{Handin}}</nowiki> with no argument gives:

{{Handin}}

==Referring to Escher Artworks==
Escher Artworks are each given their own page.  Refer to the work by linking to the page - no other information (year, where to find it) is necessary because that's all on the artwork's page.  To refer to [[Castrovalva]], use <nowiki>[[Castrovalva]]</nowiki>.

The [[Regular Division of the Plane Drawings]] should be referred to with [[Template:sketch]], using the syntax <nowiki>{{sketch|number|name}}</nowiki>.  For example, <nowiki>{{sketch|3|weightlifters}}</nowiki> gives {{sketch|3|weightlifters}}.

Unnamed minor works won't get their own page, so refer to them with citation information (see Citations to Escher Books, below) or include a scanned picture.

The individual artwork pages are created with [[Template:Escher Artwork]].
See the discussion page for the template for details on parameters: [[Template_talk:Escher_Artwork]]

One of the goals of isolating Escher's artwork is to make it easier to control access rights in the future.  Possibly, only authorized readers could see the online images.

==Citations to Escher Books==
When referring to {{VOS}}, use <nowiki>{{VOS}}</nowiki> (the  [[Template:VOS]]).

When referring to {{Magic}}, use <nowiki>{{Magic}}</nowiki> (the  [[Template:Magic]]).

Because these books are intended to be used as companions to this wiki, it is too much to put their full titles and citation information in running text.  Instead, these templates produce a short reference in the text.  Some day they will link to complete bibliographic information.

When referring to {{LWE}}, use <nowiki>{{LWE}}</nowiki> (the  [[Template:LWE]]).

==Instructor Resources==
Instructor information can be located in three places:
# As individual pages targeted towards instructors, and presumably linked to by the [[Instructor Resources]] page.
# As individual pages protected from public view.  These pages are only readable by logged in users, which at this time can only be instructors.  These pages should be placed in the 'Instructor' namespace, by prefixing their names as in [[Instructor:Rosette Exercises Solutions]].
# On the discussion pages associated with content/exploration/homework/etc.  Use <nowiki>{{Instructor Notes}}</nowiki> (the [[Template:Instructor Notes]]) for this.  Appropriate comments for discussion pages include "I often assign problem 6 because I use the results later in my course" or "watch out for question 4, it's a bit of a trick question".  It's probably not appropriate to put complete answers up there because the page is accessible to students.

==Symmetry Groups==
References to symmetry groups should use [[Template:group]] to get, for example, {{group|pmm2}}.

==Other useful templates==
{{optional}}
[[Template:optional]]

{{unfinished}}
[[Template:unfinished]]

{{clear}}

To link to a useful printable resource, use [[Template:printable]] which takes one argument.
For example,  <nowiki>{{printable|The seven frieze groups:  [[Image:frieze-printable.pdf]].}}</nowiki> produces
{{printable|
The seven frieze groups:  [[Image:frieze-printable.pdf]].
}}

{{clear}}

To alert students to a potential pitfall, use [[Template:Alert]] which takes one argument.
{{Alert|
Four-legged mammals have '''four''' legs and are '''mammals'''.
}}

{{clear}}

To force text to fall below pictures (as opposed to wrapping around), use [[Template:Clear]].  This section uses it, as an example.

==External Links==
Links to Wikipedia should use the special syntax <nowiki>[[wikipedia:Lithography]]</nowiki>
which gives the link [[wikipedia:Lithography]].

Links to Wikimedia Commons can use <nowiki>[[commons:Main Page]]</nowiki>.

==Footnotes==
Footnotes use the
<nowiki><ref>, </ref>, and <references/></nowiki>
tags described at [http://meta.wikimedia.org/wiki/Cite/Cite.php].
For an example, see [[Introduction_to_Symmetry#_ref-0]].

==Math==
Examples:

<math>x^2 + y^2</math>

<math>x_1^2+y^2</math>

<math>\frac{1}{2}</math>

<math>90^\circ</math>

<math>\pi</math>

<math>\sqrt{1+\cos(x^2)}</math>

== Images ==
===Style===
Use 2 point thickness for most lines, outlines, diagrams.  Use 1 point thickness for less important lines.

Figures are usually black, with red for marking symmetry or other annotation.  Next, the light blue and light orange are used for color details.

===Technical===
Don't give images names containing underscore '_'.  More or less standard for this wiki is to use hyphens instead of spaces for uploaded file names.

Bitmap images should use .jpg or .png.

Illustrations should use the 'svg' format.  SVG is scalable vector graphics, so it will look good at any size.  It's got small file sizes and is easily editable once stored on the wiki.
Inkscape is a free program that can create and edit SVG images.

Currently, text inside of svg images is hit-and-miss.  Sometimes it works, sometimes not.  If possible, avoid text inside of svg illustrations, and use captions instead.  If you really want some text, it is advisible to convert it to a path.  Inkscape can do this.

I've also had trouble with arrowheads in SVG files.

Here's an svg image which is supposed to have text in it:
[[Image:star_rrr.svg]]

[[Image:Test.svg|thumb|Test]]
Here's another one (thumbnailed), on the right.  Notice the large white area below the goods.  That's because I didn't resize the page to
fit the contents (while using Inkscape).  You can do this by selecting all, then Document Properties (on the File menu) then Fit page to selection.