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
This page describes the wiki syntax used by JSPWiki, the Wiki Engine being used here. The [SandBox|http://sandbox.jspwiki.org|target='_blank'] is a great place to try out your wiki editing skills
[{TableOfContents}]
At line 3 added one line
!!Writing text
At line 4 changed 5 lines
[{TableOfContents }]
!!Quick Reference
{{{
---- = make a horizontal ruler. Extra '-' is ignored.
\\ = force a line break
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 10 changed 5 lines
[link] = create a hyperlink to an internal Wiki Page called 'Link'.
[a sample|link] = create a hyperlink to an internal Wiki Page called 'Link'
, but display the text 'a sample' to the user instead of 'Link'.
[1] = make a reference to a footnote numbered 1.
[#1] = mark the footnote number 1.
!Adding pictures
At line 16 changed 3 lines
!heading = small heading with text 'heading'
!!heading = medium heading with text 'heading'
!!!heading = large heading with text 'heading'
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].
At line 20 changed 11 lines
''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' (* must be first character on the line)
** text = make a second level bulleted list item with 'text' (** must be first character on the line)
# text = make a numbered list item with 'text' (# must be first character on the line)
## text = make a second level numbered list item with 'text' (## must be first character on the line)
;term:ex = make a definition for 'term' with the explanation 'ex'
}}}
!!Links to Other Information
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.
At line 32 changed 2 lines
!Links (hyperlinks)
Links between pages within the Wiki are indicated by enclosing the page name in brackets (i.e. ~[USERCALC] becomes [USERCALC]) or by providing text and then indicating a link (i.e. ~[user calculations|USERCALC] becomes [user calculations|USERCALC] which takes you to the same place, but it appears more "in line").
You can also attach an image, and refer to it as if it were any other page. See [WikiAttachments] for more information.
At line 35 changed one line
Links to external sites can be made by indicating the URL starting with a "protocol" like {{http:}}, {{mailto:}}, or {{https:}} (i.e., 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]). External sites are indicated by a little arrow.
If you need more layout control (or things like captions), check out the [Image] -plugin. It can do oodles more than just simple embedding.
At line 37 changed one line
Note that a link to another web page will open in the same browser window/tab unless you indicate a different "target" (i.e. ~[from Adobe|http://get.adobe.com/|target='_blank'] becomes [from Adobe|http://get.adobe.com/|target='_blank'] which opens in a different page) __single quotes only around the '_blank'__ is very important
The list of accepted image types depends on the Wiki. See the [SystemInfo] page for a list of the different image types.
At line 39 changed one line
To do email links, indicate the protocol as mailto: and put the email address to be sent to, follow. For example, {{~[mailto:info@microsoft.com]}} oor {{~[mailto:info@microsoft.com?subject=ABC123]}} to fill in the subject line with ABC123
!Headings
At line 41 changed one line
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, 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]}}.
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).
At line 43 changed one line
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 the link to the page name underscored in [RED|] when you return to that page. Then click on it and you have created a new page!
All headings also generate a "named anchor", so that you can refer from other wikipages to this wikipage. See [Named Headings] for more information.
At line 45 removed one line
!!Formatting a Page
At line 49 changed one line
* One \\ one and a half
* One
At line 35 added one line
At line 54 changed one line
* One \\ one and a half
* One
At line 62 changed one line
# One \\ one and a half
# One
At line 50 added one line
At line 68 changed one line
# One \\ one and a half
# One
At line 56 added one line
At line 73 changed 2 lines
previous item. For example:
{{{
previous item. If this sounds complicated, edit this page for an example, below.
At line 76 changed one line
* This is actually a multi-line item (in the text entered)
* This is actually a multi-line item.
At line 80 changed 9 lines
* 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. (in the text entered)
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.
* The third line is again a single-line item for your convinience.
At line 67 added one line
!Definition lists and comments
At line 91 removed one line
!Definition lists
At line 70 added 4 lines
;__Construct__:''Something you use to do something with''
Another nice use for the ';:' is that you can use it to comment shortly on other people's text, by having an empty 'term' in the definition, like this:
At line 94 changed one line
;Construct:Something you use to do something with
;:''Comment here.''
At line 96 changed 2 lines
is rendered as:
;Construct:Something you use to do something with
Which would be seen as
;:''Comment here.''
At line 100 removed one line
You may use __bold__ text or ''italic'' text, by using two underscores (_) and two single quotes ('), respectively. A [underscore|] effect can be produced by using a hyperlink to nowhere, like this: [[underscore|]
At line 82 added 3 lines
You may use __bold__ text or ''italic'' text, by using two underscores (_) and two single quotes ('), respectively. If you're on a Windows computer, make sure that you are using the correct quote sign, as there is one that looks the same, but really isn't.
At line 103 removed 2 lines
If you want to add preformatted text (like program code) just use two consecutive braces ({) to open a block, and two consecutive braces (}) to close a block.\\
{{select PERSON_CODE from P2K_HR_IDENTITIES;}}
At line 106 changed 2 lines
!Tables
You can do simple tables by using pipe signs ('|'). Use double pipe signs to start the heading of a table, and single pipe signs to then write the rows of the table. End with a line that is not a table.
If you want to add preformatted text (like code) just use three consecutive braces ({) to open a block, and three consecutive braces (}) to close a block. Edit this page for an example.
!!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
signs to start the heading of a table, and single pipe signs to then
write the rows of the table. End with a line that is not a table.
At line 121 added one line
At line 111 changed 2 lines
| ''Gobble'' | Bar \\ foo
| [Main] | [SandBox|http://sandbox.jspwiki.org|target='_blank']
| ''Gobble'' | Bar
| [Main] | [SandBox]
At line 114 removed 4 lines
gives you the following table. Note how you can use links also inside tables.
|| Heading 1 || Heading 2
| ''Gobble'' | Bar \\ foo
| [Main] | [SandBox|http://sandbox.jspwiki.org|target='_blank']
At line 128 added one line
gives you the following table. Note how you can use links also inside tables.
At line 120 changed one line
tables can also be "striped" by prefixing it with the [special style|WIKI.STYLING] {{~%%zebra-table}} and ending the table with {{~%%}}
|| Heading 1 || Heading 2
| ''Gobble'' | Bar
| [Main] | [SandBox]
At line 122 changed 2 lines
!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.
!!Styles
At line 125 changed one line
For example, referencing a file attached to another wiki page :
%%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:
At line 127 changed one line
[wikipagename/attachment.pdf]
%%small
This is small text
%%
At line 146 added 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 130 changed one line
Or, if the file is attached to the current wiki page you can use :
You can also define almost any CSS style command:
At line 132 changed one line
[attachment.pdf]
%%( font-size: 150%; color: red; )
Hello, world!
%%
At line 154 added 4 lines
would render as:
%%( font-size: 150%; color: red; )
Hello, world!
%%
At line 135 changed 3 lines
!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.
__NOTE__ You have to mark the end of thestyled text using {{{%%}}} or {{{/%}}} or {{{%%~<space>}}} !
(the {{{~<space>}}} acts as a non-rendering space.
At line 139 changed one line
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]. {{[2-The other footnote|#2]}}
For more predefined styles, see [JSPWiki Styles]
At line 164 added 32 lines
!Conflicts
If someone happens to edit the same page as you at the same time, JSPWiki will prevent you from doing changes and show a conflict page instead. Sorry to say, but the first one to make changes wins...
__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.
!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.
!Adding new pages
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.
!Attaching files
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].
!!Variables, plugins, forms and other special functions
!Inserting variables
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].
At line 142 removed 3 lines
[#1] Here's the footnote I mentioned.\\
[2-The other footnote|#2] The other footnote. Note how its name is different?
----
At line 198 added one line
[#1] Here's the footnote I mentioned.
At line 200 added 2 lines
[The other footnote|#2] The other footnote. Note how it's name is different?
At line 148 changed 2 lines
![Notes|Edit:Internal.WIKI.MARKUP+BASICS]
[{InsertPage page='Internal.WIKI.MARKUP+BASICS' default='Click to create a new notes page'}]
See also: [FormattingQuickReference]
This page (revision-22) was last changed on 26-Nov-2021 10:22 by rforbesTop