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
This page describes the wiki syntax used by JSPWiki, the Wiki Engine being used here.
At line 3 removed one line
At line 5 changed one line
!!Quick Reference
\\
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
At line 7 changed 2 lines
---- = make a horizontal ruler. Extra '-' is ignored.
\\ = force a line break
---- = make a horizontal ruler. Extra '-' is ignored.
\\ = force a line break
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.
[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 16 changed 3 lines
!heading = small heading with text 'heading'
!!heading = medium heading with text 'heading'
!!!heading = large heading with text 'heading'
!heading = small heading with text 'heading'
!!heading = medium heading with text 'heading'
!!!heading = large heading with text 'heading'
At line 20 changed 9 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'
''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 30 removed one line
!!Links to Other Information
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").
!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 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.
!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 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
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 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
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 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]}}.
It's allowed to use almost any kind of characters inside a [WikiName], as long as they are letters or numbers.
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!
!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 45 changed one line
!!Formatting a Page
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 76 changed one line
* This is actually a multi-line item (in the text entered)
* This is actually a multi-line item.
At line 84 changed one line
* This is actually a multi-line item. (in the text entered)
* This is actually a multi-line item.
At line 91 changed one line
!Definition lists
!Definition lists and comments
At line 94 changed one line
;Construct:Something you use to do something with
;__Construct__:''Something you use to do something with''
At line 97 changed one line
;Construct:Something you use to do something with
;__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:
{{{
;:''Comment here.''
}}}
Which would be seen as
;:''Comment here.''
At line 100 changed 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|]
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.
A [underscore] effect can be produced by using a hyperlink to nowhere, like this: [[underscore|]
At line 103 changed 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;}}
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.
({)java.package.pseudocode.class(})
At line 107 changed one line
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.
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.
At line 112 changed one line
| [Main] | [SandBox|http://sandbox.jspwiki.org|target='_blank']
| [Main] | [SandBox]
At line 117 changed one line
| [Main] | [SandBox|http://sandbox.jspwiki.org|target='_blank']
| [Main] | [SandBox]
At line 119 removed 3 lines
tables can also be "striped" by prefixing it with the [special style|WIKI.STYLING] {{~%%zebra-table}} and ending the table with {{~%%}}
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.
!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 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]}}
!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...
At line 155 added 18 lines
__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.
!Adding new pages
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.
!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":
Put the following on the "PageAliases" -page:
{{{
[{SET alias='PageAlias'}]
}}}
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".
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 145 removed 5 lines
----
![Notes|Edit:Internal.WIKI.MARKUP+BASICS]
[{InsertPage page='Internal.WIKI.MARKUP+BASICS' default='Click to create a new notes page'}]
This page (revision-22) was last changed on 26-Nov-2021 10:22 by rforbesTop