This page (revision-22) was last changed on 26-Nov-2021 10:22 by rforbes

This page was created on 26-Nov-2021 10:22 by Administrator

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
22 26-Nov-2021 10:22 7 KB rforbes to previous
21 26-Nov-2021 10:22 7 KB rforbes to previous | to last

Page References

Incoming links Outgoing links
WIKI.MARKUP BASICS
WIKI.MARKUP BASICS

Version management

Difference between version and

At line 1 changed one line
[{TableOfContents}]
This page describes the wiki syntax used by JSPWiki, the Wiki Engine being used here.
At line 3 changed one line
!!Writing text
[{TableOfContents }]
\\
When you've figured out how the editor works, then you should read [WikiEtiquette] so that you would know how to use your newly acquired skills. The [SandBox|http://sandbox.jspwiki.org] is a great place to try them out.
!Quick Reference
{{{
---- = make a horizontal ruler. Extra '-' is ignored.
\\ = force a line break
At line 5 changed 2 lines
You don't need to know anything about the Wiki text formatting rules to use Wiki. Just write normal text, and then use an empty line to mark a paragraph.
It's just like writing an email.
[link] = create a hyperlink to an internal WikiPage called 'Link'.
[this is also a link] = create a hyperlink to an internal WikiPage called
'ThisIsAlsoALink' but show the link as typed with spaces.
[a sample|link] = create a hyperlink to an internal WikiPage called
'Link', but display the text 'a sample' to the
user instead of 'Link'.
~NoLink = disable link creation for the word in CamelCase.
[1] = make a reference to a footnote numbered 1.
[#1] = mark the footnote number 1.
[link] = create text '[link]'.
At line 8 changed one line
!Adding pictures
!heading = small heading with text 'heading'
!!heading = medium heading with text 'heading'
!!!heading = large heading with text 'heading'
At line 10 changed 2 lines
You can embed any image in the wiki code by putting the image available somewhere on the web in one of the allowed formats, and then just linking to it.
For example, this is an inlined [PNG] image: [http://www.ecyrd.com/~jalkanen/test.png].
''text'' = print 'text' in italic.
__text__ = print 'text' in bold.
{{text}} = print 'text' in monospaced (fixed pitch) font.
[text|] = print 'text' underscored (dummy hyperlink) - the link with a pipe, but no page to go to
* text = make a bulleted list item with 'text'
# text = make a numbered list item with 'text'
;term:ex = make a definition for 'term' with the explanation 'ex'
}}}
At line 13 changed 2 lines
If you specify a link text ([[this one here|http://example.com/example.png]) it becomes
the ALT text for those who either can't or don't want to view images.
!Writing text
You don't need to know anything about the Wiki text formatting rules to use Wiki. Just write normal text, and then use an empty line to mark a paragraph.
It's just like writing an email.
At line 16 changed one line
You can also attach an image, and refer to it as if it were any other page. See [WikiAttachments] for more information.
!Hyperlinks
The link can also be a direct URL starting with {{http:}}, {{ftp:}}, {{mailto:}}, {{https:}}, or {{news:}}, in which case the link points to an external entity. For example, to point at the java.sun.com home page, use {{[[http://java.sun.com]}}, which becomes [http://java.sun.com/] or {{[[Java home page|http://java.sun.com]}}, which becomes [Java home page|http://java.sun.com].
At line 18 changed one line
If you need more layout control (or things like captions), check out the [Image] -plugin. It can do oodles more than just simple embedding.
If you do not start the link with one of the above "protocols", the wiki assumes a normal link to another page in the wiki space, %%(color:red) you need to use a letter as the first character of the page, purely numeric page names are not allowed%%. If you want to use square brackets ({{[[]}}) in the page without creating a hyperlink, use two opening square brackets. So the text {{[[[Example Non-Link]]}} will appear as {{[[Example Non-Link]}}.
At line 20 changed one line
The list of accepted image types depends on the Wiki. See the [SystemInfo] page for a list of the different image types.
To add a new page you just create a link to it from somewhere else. After all, there isn't much point in having a page if you can't access it! You'll then see a small question mark after the page name when you return to that page. Then click on it and you have created a new page!
At line 22 changed one line
!Headings
It's allowed to use almost any kind of characters inside a [WikiName], as long as they are letters or numbers.
At line 24 changed one line
JSPWiki gives you three kinds of headings: A small one (denoted by starting a line with a single exclamation mark '!'), a medium-sized one (two exclamation marks), or a large one (three marks).
!Footnotes
These are a special kind of hyperlink. By using nothing but a number inside a hyperlink you create a reference to a footnote, like this {{[[1]}}, which
creates a footnote[1]. To make the actual footnote, you just put a {{[[#1]}} where you want that footnote to point at. Look below to find the footnote.
At line 26 changed one line
All headings also generate a "named anchor", so that you can refer from other wikipages to this wikipage. See [Named Headings] for more information.
You can also make a named footnote, just as if you were doing a normal hyperlink, such as {{[[Footnote name|1]}} as another way of referring to the first footnote[Footnote name|1]. Or you can put the custom name at the footnote itself[2].
At line 31 changed one line
* One
* One \\ one and a half
At line 35 removed one line
At line 37 changed one line
* One
* One \\ one and a half
At line 45 changed one line
# One
# One \\ one and a half
At line 50 removed one line
At line 52 changed one line
# One
# One \\ one and a half
At line 56 removed one line
At line 58 changed 2 lines
previous item. If this sounds complicated, edit this page for an example, below.
previous item. For example:
{{{
At line 65 changed one line
* The third line is again a single-line item for your convinience.
* The third line is again a single-line item for your convenience.
}}}
produces:
* This is a single-line item.
* This is actually a multi-line item.
We continue the second sentence on a line on a line of its own.
We might as well do a third line while we're at it...
Notice, however, as all these sentences get put inside a single item!
* The third line is again a single-line item for your convenience.
At line 67 removed one line
!Definition lists and comments
At line 99 added one line
!Definition lists and comments
At line 70 changed one line
{{{
At line 72 changed one line
}}}
is rendered as:
;__Construct__:''Something you use to do something with''
At line 81 removed one line
At line 115 added one line
A [underscore] effect can be produced by using a hyperlink to nowhere, like this: [[underscore|]
At line 84 removed one line
At line 86 removed one line
At line 119 added one line
({)java.package.pseudocode.class(})
At line 89 changed 28 lines
!!Linking around
Links are an integral part of Wikis.
!Linking to a WikiPage
Just type the name of the page within brackets: [[Like this]. This will create automatically a link to a page.
Note also that this Wiki can be configured to support standard CamelCase linking (if it's supported, the word CamelCase should be a link). It's off by default, but if your friendly administrator has turned it on, then well, CamelCase all you want =).
!Linking to external sites
The link can also be a direct URL starting with http:, ftp:, mailto:, https:, or news:, in which case the link points to an external entity. For example, to point at the java.sun.com home page, use [[http://java.sun.com], which becomes [http://java.sun.com/] or [[Java home page|http://java.sun.com], which becomes [Java home page|http://java.sun.com].
!Footnotes
These are a special kind of hyperlink. By using nothing but a number inside
a hyperlink you create a reference to a footnote, like this [[1], which
creates a footnote[1]. To make the actual footnote, you just put a [[#1]
where you want that footnote to point at. Look below to find the footnote.
You can also make a named footnote, just as if you were doing a normal hyperlink. For example, this refers to the same footnote[Footnote number 1|1] as the footnote above, but this refers to another footnote[2].
!!Tables
You can do simple tables by using using pipe signs ('|'). Use double pipe
!Tables
You can do simple tables by using pipe signs ('|'). Use double pipe
At line 118 changed 2 lines
write the rows of the table. End with a line that is not a table.
write the rows of the table. End with a line that is not a table.
At line 121 removed one line
At line 124 changed 2 lines
| ''Gobble'' | Bar
| [EPersonality Wiki|Main] | [SandBox]
| ''Gobble'' | Bar \\ foo
| [Main] | [SandBox]
At line 127 changed 3 lines
gives you the following table. Note how you can use links also inside tables.
gives you the following table. Note how you can use links also inside tables.
At line 131 changed 2 lines
| ''Gobble'' | Bar
| [EPersonality Wiki|Main] | [SandBox]
| ''Gobble'' | Bar \\ foo
| [Main] | [SandBox]
At line 134 changed one line
!!Styles
!Referencing Attachments like Images
This is achieved by firstly attaching your document to a wiki page and then referencing it in a similar fashion to wiki pages links or external url's.
At line 136 changed 5 lines
%%commentbox
__Hi there!__\\
It's actually quite possible to do things like put comment boxes like this directly on your WikiPage. This sample comment box uses the "commentbox" style, as defined in the included "jspwiki.css" style sheet. To make a box like this, just use {{{%%commentbox <text> %%}}}.
%%
In addition to the simple styles represented by the WikiMarkup, we also allow you to put in your own styles. For example:
For example, referencing a file attached to another wiki page :
At line 142 changed 3 lines
%%small
This is small text
%%
[wikipagename/attachment.pdf]
At line 146 removed one line
uses the defined CSS style called "small", as defined in the jspwiki.css file. These may vary from site to site, and it is up to the site administrator to define a style.
At line 148 changed one line
You can also define almost any CSS style command:
Or, if the file is attached to the current wiki page you can use :
At line 150 changed 3 lines
%%( font-size: 150%; color: red; )
Hello, world!
%%
[attachment.pdf]
At line 154 removed 4 lines
would render as:
%%( font-size: 150%; color: red; )
Hello, world!
%%
At line 159 changed 2 lines
__NOTE__ You have to mark the end of thestyled text using {{{%%}}} or {{{/%}}} or {{{%%~<space>}}} !
(the {{{~<space>}}} acts as a non-rendering space.
!CSS styles
While not in line with the keep it simple principle, CSS styles [can be used inline|CSSInWikipages] for those special occasions when you really need to emphasize part of a page.
At line 162 removed 2 lines
For more predefined styles, see [JSPWiki Styles]
At line 165 removed one line
At line 168 changed one line
__A word of warning:__ If you use the Back button of your browser to go into the Edit page, you will almost certainly get a conflict. This is because the browser thinks its still editing an earlier copy of the page.
__A word of warning:__ If you use the Back button of your browser to go into the Edit page, you will almost certainly get a conflict. This is because the browser thinks it's still editing an earlier copy of the page.
At line 170 removed 4 lines
!Deleting pages
Every page has a "More Info..." link on the bottom. If you click on it, you arrive on a page which allows you to, among other things, restore old versions and delete pages. Note that your administrator may have prevented deleting pages arbitrarily.
At line 158 added one line
Create a link that points to a new (not existing) page using its WikiName. Click that new link, and you will get an editor for the new page.
At line 176 changed 3 lines
Create a link that points to a new (not existing) page using its [WikiName].
Click that new link, which should now have a question mark (?) suffix and
you will get an editor for the new page.
!Aliasing a Page
Sometimes it's useful to have one page really mean some other page. For example, you might have a page called "Page Aliases", but you would also like people to have it available under "Aliases". In such a case, you can use a "page alias":
At line 180 changed one line
!Attaching files
Put the following on the "PageAliases" -page:
At line 182 changed one line
If the administrator of the wiki has configured it, there is a "Attach file..." link at the bottom of every page. Clicking it allows you to attach files into pages. For more information, please see [WikiAttachments].
{{[{SET alias='PageAlias'}]}}
At line 184 changed one line
!!Variables, plugins, forms and other special functions
Every time someone views the page "PageAliases", they will be automatically redirected to this page. This is very useful if you want to be able to use the irregular plural forms, for example. Normally, The WikiEngine does properly recognize English language plural forms of page names (i.e. if the page is called __''Concept''__, you can link to it as ''concept ''or ''concepts'', but it's not smart enough to recognize certain forms, such as "aliases".
At line 186 changed one line
!Inserting variables
Obviously you cannot click on the "Edit this page" -link, because you are redirected every time you try to view a page. You can, however, edit the page directly by just writing Edit.jsp?page=pagename after the base URL.
At line 188 removed 12 lines
There are many possible variables you can insert on a page. The basic form is:
{{ [[{$variablename}], }}
where ''variablename'' is the name of the variable you want to insert. Note that variable names are case-insensitive - that is, "pagename" is the same as "paGeNamE" and "PageName".
You can see the list of available of variables at [WikiVariables].
!Fancy Jazz
Check out the fancy jazz at [http://www.jspwiki.org/wiki/JSPWikiStyles]
At line 201 removed one line
At line 203 changed 3 lines
[The other footnote|#2] The other footnote. Note how it's name is different?
[2-The other footnote|#2] The other footnote. Note how its name is different?
At line 207 removed 2 lines
See also: [FormattingQuickReference]
This page (revision-22) was last changed on 26-Nov-2021 10:22 by rforbesTop