|
Table of Contents
|
Content management
Table of contents
A table of contents will automatically list all headings in the text hierarchically and will link each listed item with its corresponding heading in the text, thus speeding up navigation. A table of content can be created with the following syntax on its own line:
- [[toc]] creates a default table of contents in the position where the syntax is written without any wrapping up by the page contents. E.g. the table of contents in this page.
Wikidot's editor writes a default table of contents when the corresponding button is clicked.
- [[f<toc]] creates a table of contents on the left side of the page and in the position where the syntax is written, but wrapped up to its right by the page contents.
- [[f>toc]] creates a table of contents on the right side of the page and in the position where the syntax is written, but wrapped up to its left by the page contents.
If you want to keep a heading from automatically appearing in the table of contents, you can add "*" right after the heading code:
- ++* Heading 2, will not be listed in the table of contents (nor the asterisk will appear in the heading).
Headings
You achieve different heading levels by typing '+':
- + Level 1 heading
- ++ Level 2 heading
- +++ Level 3 heading
- ++++ Level 4 heading
- +++++ Level 5 heading
- ++++++ Level 6 heading
Lists
Numbered lists
You create a numbered list by typing "#":
- # first element in the list
- # second element in the list, will appear as:
- first element in the list
- second element in the list
You increase list indentation by typing spaces before the numbered item:
- # first element in the list will have no list indentation.
- _# second element in the list (where _ is a blank space), will show indentation as:
- first element in the list
- second element in the list
You decrease list indentation by deleting spaces before the numbered item.
You can also mix numbered lists and bulleted lists.
Bulleted lists
You create a bulleted list by typing "*":
- * first element in the list
- * second element in the list, will appear as:
- first element in the list
- second element in the list
You increase list indentation by typing spaces before the bulleted item:
- * first element in the list will have no list indentation.
- _* second element in the list (where _ is a blank space), will show indentation as:
- first element in the list
- second element in the list
You decrease list indentation by deleting spaces before the bulleted item.
You can also mix bulleted lists and numbered lists.
Definition lists
You can list items by typing your list with the following syntax:
- : item : definition
- : item : definition, which will render the following list formatting:
- This website
- It provides a model for what we are saying.
- This other website
- It is a very good site for encyclopedic knowledge on the topic.
- This book
- It illustrates the theory in greater detail for advanced users.
Footnotes
Wikidot uses the footnotes syntax to allocate a number to your footnote in the text, write the footnote in a footnote section at the end of the page (by default) together with the default heading Footnotes, and link both. When the text has been saved, pointing to the footnote number will open a window showing the footnote text, so there is no need to scroll down to the end of the page to read the footnote.
Footnotes: default block
You can add footnotes by typing the footnote text between [[footnote]] [[/footnote]]. Wikidot will automatically allocate a chronological number to it and write the footnote in its default section at the end of the page. The syntax is the following:
- [[footnote]] your footnote here [[/footnote]]. This will appear as1 in the footnote section (notice, however, that the section has been forced to appear not at the end of the page but at the end of this section).
Footnotes: placing the footnote section elsewhere in the page
You can place the footnote section in other position than its default position (i.e. the bottom of the page) by coding it in the location within the text you wan it to be. The syntax is the following:
- [[footnoteblock]]
For example, here we have force the footnote block to appear at the end of this section, rather than at the end of the page (see below).
Footnotes: changing the title
You can substitute the default title Footnotes with your own with the following syntax:
- [[footnoteblock title="Your title here"]]
For example, [[footnoteblock title="Footnotes example"]] will result in the title shown in the example at the end of this section. (Notice that above syntax creates both the footnoteblock and the new title, so you don't need to repeat the syntax [[footnoteblock]])
If you don't want a title, use this syntax:
- [[footnoteblock title=" "]]
(Notice that above syntax creates both the footnoteblock and eliminates the title, so you don't need to repeat the syntax [[footnoteblock]])
Bibliographic citations and list of references
Wikidot uses bibliographic citations to allocate a number to your citation in the text, write the full reference in the bibliography section at the end of the text together with the default heading Bibliography, and link both. When the text has been saved, pointing to the citation number will open a window showing the full reference, so that there is no need to scroll down to the end of the page to read that reference. [Note: if you create a citation but forget to write the full reference in the bibliography section, Wikidot will show an error message in red font when you exit the editor]. Thus, two separate syntax codes need to be written: one for citations within the text, and the other for the bibliography block, where the references will be listed.
Citations
You add citations by substituting label with your own one-word keyword in the syntax below. The label will be invisible in the normal text. The syntax is the following:
- [((bibcite label))]
For example, [((bibcite firstlabel))] and [((bibcite secondlabel))] will appear as [1] and [2].
Bibliography: default block
You list references linked to each citation by creating the bibliography block in separate lines, and writing your references in between the blocks, according to its syntax. Wikidot will insert the default name Bibliography where the syntax lies in the text, will allow you to list your labels (or keywords) and the reference that goes with each label, and will automatically create a number that links the citation in the text with its reference in the bibliography section:
- [[bibliography]]
- : firstlabel : first full reference in the bibliography section
- : secondlabel : second full reference in the bibliography section
- [[/bibliography]] , will appear as shown in the example at the end of this section (notice that several examples are illustrated there).
Bibliography: references in alphabetical order (or any other order)
Notice that, unlike footnotes, you have to actually write each label (or keyword) by hand both as a citation and in the list of references. This means that Wikidot will link each citation label with its bibliographic label independently of its order of appearance in the text. That is, the number that appears in the text refers to the order the reference appears in the bibliography listing, not to the order in which the citation appears in the text. This is convenient if you want to re-order references by alphabetical order, for example. In so doing, you may find that, in the text, citation 2 comes before citation 1.
For example, Williams [((bibcite Williams))] and Carslton [((bibcite Carslton))] refers to how labels are cited in this text, whereas "Williams" is cited before "Carslton". Thus, in here, it will appear as Williams [4] and Carslton [3]. Notice that reference number "4" comes before number "3". This is so because those references have been ordered alphabetically rather than chronologically. Thus, "Carslton" (and his corresponding reference) has been listed before "Williams" in the Bibliography section, like follows:
[[bibliography]]
: Carslton : Carslton is third in the references list (although his citation is fourth in the text)
: Williams : Williams is fourth in the references list (although his citation is third in the text)
[[/bibliography]] , will appear as it is shown in the Bibliography example earlier.
Bibliography: changing the title
You can substitute the default title Bibliography with your own with the following syntax:
- [[bibliography title="Your title here"]]
For example, [[bibliography title="Bibliography example"]] will result in the title shown in the example at the end of this section. (Notice that above syntax creates both the bibliography block and the new title, so you don't need to repeat the syntax [[bibliography]], but you need to remember to close the block with [[/bibliography]])
If you don't want a title, use this syntax:
- [[bibliography title=" "]]
Tables
Basic tables
You can create basic tables by typing the cell contents between two double vertical lines "|| ||" (these lines represent the left and right limits of each cell). Add more vertical lines in your line of text to create columns; add more vertical lines in subsequent lines of text to create rows.
- || cell-1 || cell-2 || will, thus, create a table with two columns and one row (i.e. two cells). E.g.
cell-1 cell-2
- || cell-1 || cell-2 ||
- || cell-3 || cell-4 || will create a table with two columns and two rows (i.e. four cells). E.g.
cell-1 cell-2 cell-3 cell-4
You can merge cells by duplicating the initial double vertical lines "||" in order to represent how many cells are merged:
- || cell-1 || cell-2 ||
- |||| cell-3 || will create a long cell in row two (equal to two smaller cells). E.g.
cell-1 cell-2 cell-3
- || cell-1 || cell-2 || cell-3 ||
- |||| cell-4 || cell-5 || will create a long cell towards the left in row two. E.g.
cell-1 cell-2 cell-3 cell-4 cell-5
- || cell-1 || cell-2 || cell-3 ||
- |||| cell-4 || cell-5 || will create a long cell towards the right in row two. E.g.
cell-1 cell-2 cell-3 cell-4 cell-5
Tips for editing cell contents
To create headers, use "~" right after two initial vertical lines of the corresponding cells.
- ||~ header-1 ||~ header-2 ||
- || cell-3 || cell-4 || will add headings as appropriate. E.g.
header-1 header-2 cell-3 cell-4
To center text within a cell, use "=" right after the two initial vertical lines of the corresponding cells.
- ||~ header-1 ||~ header-2 ||
- ||= cell-3 ||= cell-4 || will center the cells text as appropriate. E.g.
header-1 header-2 cell-3 cell-4
Block indentations
Links
Links to an external webpage
You can add an external link by typing:
- [http://target-web-address anchor-text] (e.g. [http://www.wikidot.com wikidot])
- http:…, https:…, ftp://… and similar locations can be used. Simply write the needed one as appropriate
- not all webpages start with www… Simply remember to write the correct page (double-check as required)
- if you want the link to open a webpage in a new window, start the syntax with an asterisk, as follows:
[*http://target-web-address anchor-text] (e.g. [*http://www.wikidot.com wikidot])
- you may find much easier to use the URL link wizard button
Internal links to a page in your site
You can create an internal link by typing the name of the page (i.e. the pagename!) between :
- [[[pagename]]] will create the required link. E.g. [[[start]]] will appear as start)
- remember that most pages are named as category:pagename. Don't forget to write the category: part.
- if you want to use an alternative anchor than the namepage, you can provide the anchor text after the name of the page, as follows:
[[[pagename |anchor-text]]]. E.g. [[[start |inicio]]] will appear as inicio, but will link to the page start.
I haven't found yet the syntax to open an internally-linked page in another window. A way around it, however, is to use the syntax for an external link with that option (see above) instead of the one for an internal link. Thus:
[[[start]]] and [*http://wikiofscience.wikidot.com/start] should both open the same page (see start and [http://wikiofscience.wikidot.com/start]), except that with the second syntax you can do so in a different window automatically.
Indeed, if you check the page each syntax opens (e.g. check the bottom of the screen when hovering the mouse on each link), the route is the same. Using [[[start]]] is, simply, a shortcut for linking internal pages, but Wikidot will always open an http:// page no matter whether you use an internal link or an external one!
Insert image
Check Wiki Syntax
Embed video
Check Wiki Syntax
Embed audio
Check Wiki Syntax
Code block
Check Wiki Syntax
Invisible comments
You can make part of the information contained in a page invisible (e.g. because you are still working on it, you want to leave and invisible note, or you need to double check a reference before making that text public) by enclosing the text between [!-- --]. This works both for part of text within paragraphs as well as for blocks of paragraphs.
- [!-- --]
For example, Between here [!-- all this text, actually --] and here there is a hidden text, will appear as Between here and there is a hidden text.
Mathematical equation
Check Wiki Syntax
Inline mathematical equation
Check Wiki Syntax
Equation reference
Check Wiki Syntax
Text formatting
Bold text
You add bold text by typing your text between ** **:
- **your bold text here** will appear as your bold text here
Italics
You add italics by typing your text between // //:
- //your text in italics here// will appear as your text in italics here
Underlining
You add underlines by typing your text between __ __:
- __your underlined text here__ will appear as your underlined text here
Strikethrough
You add through strokes by typing your text between -- --:
- --your stroke through text here-- will appear as your stroke through text here
Teletype text
You add teletype text by typing your text between {{ }}:
- {{your teletype text here}} will appear as your teletype text here
Superscript
You add superscript by typing your text between ^^ ^^:
- your ^^superscript^^ text here will appear as your superscript text here
Subscript
You add subscript by typing your text between ,, ,,:
- your ,,subscript,, text here will appear as your subscript text here
Paragraph formatting
Paragraph indentation
You add paragraph indentation by typing ">". You can increase indentation levels by typing further ">":
- > Level 1 indentation
- >> Level 2 indentation
- >>> Level 3 indentation
Page formatting
Div block element
Check Wiki Syntax
Clear floats
Check Wiki Syntax
Horizontal lines
You can add horizontal lines by typing four or more dashes:
- ------ will, thus, create a horizontal line across the page (similar to that used to separate information pertaining to the editor's first row from that separating information pertaining to the editor's second row.
Syntax formatting
Literal text (raw text)
You write in raw text (i.e. your text will not be parsed) by typing your text between double @@ characters:
- your //sample// **text** ^^here^^ will then appear as your //sample// **text** ^^here^^ (instead of as your sample text here)
