Actions

Difference between revisions of "Style guide for this Wiki"

From Online Dictionary of Crystallography

(Formatting content)
(Provided template for headword translations)
 
(10 intermediate revisions by 4 users not shown)
Line 16: Line 16:
 
'''IMPORTANT:''' use a lowercase initial letter, unless the term is itself a proper noun, ''e.g.''
 
'''IMPORTANT:''' use a lowercase initial letter, unless the term is itself a proper noun, ''e.g.''
  
<pre>[[Miller index]]</pre>
+
<pre>[[Miller indices]]</pre>
  
Now '''save''' the index page (the 'R' page that uou have been working on in this example). The new entry will appear as a hyperlink - if it is to a page that does not yet exist, it will show up in red. Now click on this new (red) hyperlink, and you will bring up an edit page where you can begin to enter the text of your new definition.
+
Now '''save''' the index page (the 'R' page that you have been working on in this example). The new entry will appear as a hyperlink - if it is to a page that does not yet exist, it will show up in red. Now click on this new (red) hyperlink, and you will bring up an edit page where you can begin to enter the text of your new definition.
  
 
While you are editing the page, you can always click on the <tt>Show preview</tt> button to see what the formatted entry will look like, but remember that your work will not be saved until you click  on the <tt>Save page</tt> button.
 
While you are editing the page, you can always click on the <tt>Show preview</tt> button to see what the formatted entry will look like, but remember that your work will not be saved until you click  on the <tt>Save page</tt> button.
 
  
 
= Intellectual content and overall structure =
 
= Intellectual content and overall structure =
Line 32: Line 31:
 
benzil) or from the chiral molecules that it contains (''e.g.'' saccharose). It should have links to entries such as 'optical activity', 'gyrotropic', ''etc.'', and perhaps a historic note on Pasteur's experiment separating the left and right sodium ammonium tartrate crystals and the consequences for our understanding of enantiomers and racemates.
 
benzil) or from the chiral molecules that it contains (''e.g.'' saccharose). It should have links to entries such as 'optical activity', 'gyrotropic', ''etc.'', and perhaps a historic note on Pasteur's experiment separating the left and right sodium ammonium tartrate crystals and the consequences for our understanding of enantiomers and racemates.
  
 +
= Translations =
  
= Formatting content =
+
Translations of headwords are extremely valuable. Please follow the following template for ordering and colouring terms according to different languiages:
 
 
This information is an abbreviated set of tips from the [http://meta.wikimedia.org/wiki/Help:Editing relevant mediawiki help page].
 
 
 
 
 
<table>
 
<tr>
 
<td>
 
You can emphasize text by putting two apostrophes on each side. Three apostrophes will emphasize it strongly. Five apostrophes is even stronger.
 
</td>
 
<td>
 
<pre>You can ''emphasize text'' by putting two
 
apostrophes on each side. Three apostrophes
 
will emphasize it '''strongly'''. Five
 
apostrophes is '''''even stronger'''''.</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
A single newline has no effect on the layout.
 
 
 
But an empty line starts a new paragraph.
 
</td>
 
<td>
 
 
<pre>
 
<pre>
A single newline
+
<font color="orange">XXX</font> (''Ar'').
has no effect
+
<font color="blue">XXX</font> (''Fr'').
on the layout.
+
<font color="red">XXX</font> (''Ge'').
 
+
<font color="black">XXX</font>(''It'').
But an empty line
+
<font color="purple">XXX</font>(''Ja'').
starts a new paragraph.
+
<font color="brown">XXX</font>(''Ru'').
 +
<font color="green">XXX</font> (''Sp'').
 
</pre>
 
</pre>
</td>
 
</tr>
 
  
<tr>
+
= Formatting content =
<td>
 
You can break lines
 
without starting a new paragraph.
 
Please use this sparingly.
 
</td>
 
<td>
 
<pre>
 
You can break lines<br>
 
without starting a new paragraph.<br>
 
Please use this sparingly.
 
</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
You can use <b>HTML tags</b>, too.
 
Some useful ways to use HTML:
 
 
 
Put text in a <tt>typewriter font</tt>. The same font is generally used for <code>computer code</code>.
 
 
 
 
 
<strike>Strike out</strike> or
 
<u>underline</u> text, or write it
 
<span style="font-variant:small-caps">
 
in small caps</span>.
 
 
 
Superscripts and subscripts:
 
x<sup>2</sup>, x<sub>2</sub>
 
 
 
Invisible comments that only appear while editing the page.
 
<!-- Note to editors: blah blah blah. -->
 
Comments should usually go on the talk page, though.
 
 
 
However, HTML markup should be used sparingly,
 
and only if it is difficult or impossible to
 
achieve the desired result otherwise.
 
<td>
 
<pre>
 
You can use <b>HTML tags</b>, too.
 
Some useful ways to use HTML:
 
 
 
Put text in a <tt>typewriter font</tt>.
 
The same font is generally used for
 
<code>computer code</code>.
 
 
 
<strike>Strike out</strike> or
 
<u>underline</u> text, or write it
 
<span style="font-variant:small-caps">
 
in small caps</span>.
 
 
 
Superscripts and subscripts:
 
x<sup>2</sup>, x<sub>2</sub>
 
 
 
Invisible comments that only appear while editing the page.
 
<!-- Note to editors: blah blah blah. -->
 
Comments should usually go on the talk page, though.
 
 
 
However, HTML markup should be used sparingly,
 
and only if it is difficult or impossible to
 
achieve the desired result otherwise.
 
</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
== Section headings ==
 
 
 
Headings organize your writing into sections.
 
The Wiki software can automatically generate
 
a table of contents from them.
 
 
 
=== Subsection ===
 
 
 
Using more equals signs creates a subsection.
 
 
 
==== A smaller subsection ====
 
 
 
Don't skip levels, like from two to four equals
 
signs. Start with two equals signs; don't use
 
single equals signs.
 
</td>
 
<td>
 
<pre>
 
== Section headings ==
 
 
 
Headings organize your writing into sections.
 
The Wiki software can automatically generate
 
a table of contents from them.
 
 
 
=== Subsection ===
 
 
 
Using more equals signs creates a subsection.
 
 
 
==== A smaller subsection ====
 
 
 
Don't skip levels, like from two to four equals
 
signs. Start with two equals signs; don't use
 
single equals signs.
 
</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
* ''Unordered'' lists are easy to do:
 
** Start every line with a star.
 
*** More stars indicate a deeper level.
 
* A newline
 
* in a list
 
 
 
marks the end of the list.
 
 
 
* Of course you can start again.
 
</td>
 
<td>
 
<pre>
 
* ''Unordered lists'' are easy to do:
 
** Start every line with a star.
 
*** More stars indicate a deeper level.
 
* A newline
 
* in a list 
 
marks the end of the list.
 
* Of course you can start again.
 
</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
# Numbered lists are also good:
 
## Very organized
 
## Easy to follow
 
 
 
A newline marks the end of the list.
 
 
 
# New numbering starts with 1.
 
</td>
 
<td>
 
<pre>
 
# Numbered lists are also good:
 
## Very organized
 
## Easy to follow
 
A newline marks the end of the list.
 
# New numbering starts with 1.
 
</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
You can make horizontal lines
 
to separate text.
 
---
 
But you should usually use sections instead,
 
so that they go in the table of contents.
 
</td>
 
<td>
 
<pre>
 
You can make horizontal lines
 
to separate text.
 
----
 
But you should usually use sections instead,
 
so that they go in the table of contents.
 
</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
== Links ==
 
 
 
Here's a link to a page named [[reciprocal space]].
 
 
 
You can put formatting around a link. Example: ''[[reciprocal space]]''.
 
</td>
 
<td>
 
<pre>
 
Here's a link to a page named [[reciprocal space]].
 
 
 
You can put formatting around a link.
 
Example: ''[[reciprocal space]]''.
 
</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
You can link to a page section by its title:
 
 
 
* [[International Union of Crystallography#History]]
 
* [[International Union of Crystallography#Governance]]
 
 
 
If multiple sections have the same title, add
 
a number. [[#Example section 3]] goes to the
 
third section named "Example section".
 
</td>
 
<td>
 
<pre>
 
You can link to a page section by its title:
 
 
 
* [[International Union of Crystallography#History]]
 
* [[International Union of Crystallography#Governance]]
 
 
 
 
 
If multiple sections have the same title, add
 
a number. [[#Example section 3]] goes to the
 
third section named "Example section".
 
</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
You can make a link point to a different place
 
with a 'piped link'. Put the link target first,
 
then the pipe character "|", then the link text.
 
 
 
* [[Main_Page|front page]]
 
* [[International Union of Crystallography#History | history of the IUCr]]
 
</td>
 
<td>
 
<pre>
 
You can make a link point to a different place
 
with a 'piped link'. Put the link target first,
 
then the pipe character "|", then the link text.
 
 
 
* [[Main_Page|front page]]
 
* [[International Union of Crystallography#History|history of the IUCr]]
 
</pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
You can make an external link just by typing a URL: http://www.iucr.org
 
 
 
You can give it a title:
 
[http://www.iucr.org IUCr]
 
 
 
Or leave the title blank:
 
[http://www.iucr.org]
 
</td><td>
 
<pre>
 
You can make an external link just by typing a URL:
 
http://www.iucr.org
 
 
 
You can give it a title:
 
[http://www.iucr.org IUCr]
 
 
 
Or leave the title blank:
 
[http://www.iucr.org]
 
</pre>
 
</td>
 
</tr>
 
 
 
</table>
 
 
 
<!--
 
You can redirect the user to another page with a special link. For example, you might want to redirect USA to United States.
 
 
 
Note
 
 
 
          1. This command should appear as the first line of a page for it to work.
 
          2. If there are any lines following the directive, they will be automatically erase when saving the document.
 
 
 
 
 
 
#REDIRECT [[United States]]
 
 
 
Category links don't show up, but add the page to a category.
 
 
 
Add an extra colon to actually link to the category: Category:English documentation
 
 
 
 
Category links don't show up, but add the page
 
to a category. [[Category:English documentation]]
 
 
 
Add an extra colon to actually link to the category:
 
[[:Category:English documentation]]
 
 
 
The Wiki reformats linked dates to match the reader's date preferences. These three dates will show up the same if you choose a format in your Preferences:
 
 
 
    * July 20, 1969
 
    * 20 July 1969
 
    * 1969-07-20
 
 
 
 
 
 
The Wiki reformats linked dates to match the reader's date
 
preferences. These three dates will show up the same if you
 
choose a format in your [[Special:Preferences|Preferences]]:
 
* [[July 20]], [[1969]]
 
* [[20 July]] [[1969]]
 
* [[1969]]-[[07-20]]
 
 
 
[edit]
 
 
 
Just show what I typed
 
 
 
A few different kinds of formatting will tell the Wiki to display things as you typed them.
 
What it looks like What you type
 
<nowiki> tags
 
 
 
The nowiki tag ignores [[Wiki]] ''markup''. It reformats text by removing newlines and multiple spaces. It still interprets special characters: →
 
 
 
 
<nowiki>
 
The nowiki tag ignores [[Wiki]] ''markup''.
 
It reformats text by removing newlines    and multiple spaces.
 
It still interprets special characters: &rarr;
 
</nowiki>
 
 
 
<pre> tags
 
 
 
The pre tag ignores [[Wiki]] ''markup''.
 
It also doesn't    reformat text.
 
It still interprets special characters: →
 
 
 
 
 
 
<pre>
 
The pre tag ignores [[Wiki]] ''markup''.
 
It also doesn't    reformat text.
 
It still interprets special characters: &rarr;
 
</pre>
 
 
 
Leading spaces
 
 
 
Leading spaces are another way to preserve formatting.
 
 
 
Putting a space at the beginning of each line
 
stops the text  from being reformatted. It still
 
interprets Wiki markup and special
 
characters: →
 
 
 
 
 
 
Leading spaces are another way to preserve formatting.
 
 
 
Putting a space at the beginning of each line
 
stops the text  from being reformatted. It still
 
interprets [[Wiki]] ''markup'' and special
 
characters: &rarr;
 
 
 
What to do inside of lists
 
 
 
  1. A newline surrounded by nowiki tags in a list do not mark the end of the list.
 
 
 
You can combine pre tags with nowiki tags so
 
preformatted examples can go inside of lists.
 
 
 
  2. The list continues.
 
 
 
 
 
 
#<nowiki>A newline
 
surrounded by nowiki tags
 
in a list
 
do not mark the end of the list.
 
</nowiki><pre><nowiki>
 
You can combine pre tags with nowiki tags so
 
preformatted examples can go inside of lists.
 
</nowiki></pre>
 
#The list continues.
 
 
 
[edit]
 
 
 
Images, tables, video, and sounds
 
 
 
This is a very quick introduction. For more information, see:
 
 
 
    * Help:Images and other uploaded files for how to upload files
 
    * Help:Extended image syntax for how to arrange images on the page
 
    * Help:Table for how to create a table
 
 
 
What it looks like What you type
 
 
 
A picture, including alternate text:
 
 
 
The logo for this Wiki
 
 
 
You can put the image in a frame with a caption:
 
The logo for this Wiki
 
The logo for this Wiki
 
 
 
 
A picture, including alternate text:
 
 
 
[[Image:Wiki.png|The logo for this Wiki]]
 
 
 
You can put the image in a frame with a caption:
 
[[Image:Wiki.png|frame|The logo for this Wiki]]
 
 
 
A link to Wikipedia's page for the image: Image:Wiki.png
 
 
 
Or a link directly to the image itself: Media:Wiki.png
 
 
 
 
A link to Wikipedia's page for the image:
 
[[:Image:Wiki.png]]
 
 
 
Or a link directly to the image itself:
 
[[Media:Wiki.png]]
 
 
 
Use media: links to link to sounds or videos: A sound file
 
 
 
 
Use '''media:''' links to link to sounds
 
or videos: [[media:Sg_mrob.ogg|A sound file]]
 
 
 
This is
 
a table
 
 
 
 
{| border="1" cellspacing="0" cellpadding="5" align="center"
 
! This
 
! is
 
|-
 
| a
 
| table
 
|}
 
 
 
[edit]
 
 
 
Mathematical formulas
 
 
 
You can format mathematical formulas with TeX markup. See Help:Formula.
 
What it looks like What you type
 
 
 
\sum_{n=0}^\infty \frac{x^n}{n!}
 
 
 
 
<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>
 
 
 
[edit]
 
 
 
Special characters
 
 
 
Umlauts and accents: (See Help:Special characters)
 
À Á Â Ã Ä Å
 
Æ Ç È É Ê Ë
 
Ì Í Î Ï Ñ Ò
 
Ó Ô Õ Ö Ø Ù
 
Ú Û Ü ß à á
 
â ã ä å æ ç
 
è é ê ë ì í
 
î ï ñ ò ó ô
 
œ õ ö ø ù ú
 
û ü ÿ
 
 
 
 
&Agrave; &Aacute; &Acirc; &Atilde; &Auml; &Aring;
 
&AElig; &Ccedil; &Egrave; &Eacute; &Ecirc; &Euml;
 
&Igrave; &Iacute; &Icirc; &Iuml; &Ntilde; &Ograve;
 
&Oacute; &Ocirc; &Otilde; &Ouml; &Oslash; &Ugrave;
 
&Uacute; &Ucirc; &Uuml; &szlig; &agrave; &aacute;
 
&acirc; &atilde; &auml; &aring; &aelig; &ccedil;
 
&egrave; &eacute; &ecirc; &euml; &igrave; &iacute;
 
&icirc; &iuml; &ntilde; &ograve; &oacute; &ocirc;
 
&oelig; &otilde; &ouml; &oslash; &ugrave; &uacute;
 
&ucirc; &uuml; &yuml;
 
 
 
Punctuation:
 
¿ ¡ « » § ¶
 
† ‡ • - – —
 
 
 
 
&iquest; &iexcl; &laquo; &raquo; &sect; &para;
 
&dagger; &Dagger; &bull; &ndash; &mdash;
 
 
 
Commercial symbols:
 
™ © ® ¢ € ¥ £ ¤
 
 
 
 
&trade; &copy; &reg; &cent; &euro; &yen; &pound; &curren;
 
Greek characters:
 
 
 
α β γ δ ε ζ
 
η θ ι κ λ μ ν
 
ξ ο π ρ σ ς
 
τ υ φ χ ψ ω
 
Γ Δ Θ Λ Ξ Π
 
Σ Φ Ψ Ω
 
 
 
 
&alpha; &beta; &gamma; &delta; &epsilon; &zeta;
 
&eta; &theta; &iota; &kappa; &lambda; &mu; &nu;
 
&xi; &omicron; &pi; &rho; &sigma; &sigmaf;
 
&tau; &upsilon; &phi; &chi; &psi; &omega;
 
&Gamma; &Delta; &Theta; &Lambda; &Xi; &Pi;
 
&Sigma; &Phi; &Psi; &Omega;
 
 
 
Math characters:
 
∫ ∑ ∏ √ − ± ∞
 
≈ ∝ ≡ ≠ ≤ ≥
 
× · ÷ ∂ ′ ″
 
∇ ‰ ° ∴ ø
 
∈ ∩ ∪ ⊂ ⊃ ⊆ ⊇
 
¬ ∧ ∨ ∃ ∀ ⇒ ⇔
 
→ ↔ ↑
 
 
 
 
&int; &sum; &prod; &radic; &minus; &plusmn; &infin;
 
&asymp; &prop; &equiv; &ne; &le; &ge;
 
&times; &middot; &divide; &part; &prime; &Prime;
 
&nabla; &permil; &deg; &there4; &oslash;
 
&isin; &cap; &cup; &sub; &sup; &sube; &supe;
 
&not; &and; &or; &exist; &forall; &rArr; &hArr;
 
&rarr; &harr; &uarr;
 
 
 
Problem symbols:
 
ℵ ∉
 
 
 
 
&alefsym; &notin;
 
[edit]
 
 
 
Templates
 
  
Templates are segments of Wiki markup that are meant to be copied automatically ("transcluded") into a page. You add them by putting the template's name in {{double braces}}.
+
A brief summary of how to mark up content for formatting and display may be found in the [[Help:Editing|Editing help]] page.
  
Some templates take parameters, as well, which you separate with the pipe character.
 
What it looks like What you type
 
  
This text comes from the page named Template:Transclusion demo. It has been transcluded into this page.
+
[[Category:English documentation]]
 
</table>
 
-->
 

Latest revision as of 15:31, 20 November 2017

This page provides some guidance to authors on creating and marking up definitions.

Creating a new definition

The preferred method (to maintain a properly managed index of terms) is to navigate to the appropriate alphabetical index page (accessible through the main page):

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z


Edit this page to add the new entry that you wish to work on in the form of a hyperlink, e.g. on the page for 'R' one could add

[[reciprocal space]]

IMPORTANT: use a lowercase initial letter, unless the term is itself a proper noun, e.g.

[[Miller indices]]

Now save the index page (the 'R' page that you have been working on in this example). The new entry will appear as a hyperlink - if it is to a page that does not yet exist, it will show up in red. Now click on this new (red) hyperlink, and you will bring up an edit page where you can begin to enter the text of your new definition.

While you are editing the page, you can always click on the Show preview button to see what the formatted entry will look like, but remember that your work will not be saved until you click on the Save page button.

Intellectual content and overall structure

Each entry starts with the translation of the term in other languages (at present we are still experimenting with various formats suggested for doing so). The definition is then given, starting with a short statement as to what the object is, followed by a longer development as necessary. If the development is too long, it should be put in a separate page to which a link is given (see for instance the entries arithmetic crystal classes and Miller indices). A historical note can be added if it is useful. In 'See also', appropriate links to other entries or to IUCr resources (articles in the Journals, pamphlets, COMCIFS etc.) are given as well as references to the relevant chapters in International Tables. Generally speaking, one should always ask oneself: is the definition I am writing going to give the reader the answer he is looking for?

Each entry should be self-contained, and at the same time related to the others within a preconceived framework.

There is of course often a question as to whether a full definition of a rather general term should appear in a dictionary of crystallography, or in a dictionary of chemistry or physics. Our objective is to provide the information that a crystallographer would wish to know. 'chiral' may be considered a chemical term, but the reader who wants to know what 'chiral crystal' means ought to find the answer in our dictionary. A model definition might explain that the chirality of a crystal may either come from a structure built with achiral units (e.g. quartz, benzil) or from the chiral molecules that it contains (e.g. saccharose). It should have links to entries such as 'optical activity', 'gyrotropic', etc., and perhaps a historic note on Pasteur's experiment separating the left and right sodium ammonium tartrate crystals and the consequences for our understanding of enantiomers and racemates.

Translations

Translations of headwords are extremely valuable. Please follow the following template for ordering and colouring terms according to different languiages:

<font color="orange">XXX</font> (''Ar'').
<font color="blue">XXX</font> (''Fr'').
<font color="red">XXX</font> (''Ge'').
<font color="black">XXX</font>(''It'').
<font color="purple">XXX</font>(''Ja'').
<font color="brown">XXX</font>(''Ru'').
<font color="green">XXX</font> (''Sp'').

Formatting content

A brief summary of how to mark up content for formatting and display may be found in the Editing help page.