Undocumented wiki markup
As regular forum members know, the forum has been updated a few months ago and the existing wiki markup has changed a bit, backwards compatibility was added (is still in progress maybe?) and as it appears there's shorthand markup which is not documented.
ment 1
ADDED 05-MAR-2008 by BADSAH MUKHERJI: I am attaching a PDF file containing a documented contributed to the Jive Software Developer Community. Just a supplement to this excellent document.
Since "wiki wiki" means fast, we'd like to know the shorthand code for the shorthand code (am i making sense?)
The
official documentation for the wiki markup can be found under the help button in your editor, but there's more:
Here's an example where i show different markup with the same result:
Thread references
The official style for thread references is
{thread:id=121928}
Result:
Error marking answers as helpful/correct?
Shorthand style is
[t-121928]
Result:
Error marking answers as helpful/correct?
Message references
Official style for message references is
{message:id=1928}
Result:
Re: Installing Win 98 without a floppy diskette?
Shorthand style is
[m-1928]
Re: Installing Win 98 without a floppy diskette?
Document references
Official style for document references is
{document:id=2555}
Result:
Undocumented wiki markup tricks
Shorthand style is
[d-2555]
Result:
Undocumented wiki markup tricks
Using headers
The official documented way is:
h5. ABC
Beware of the space between the . and the ABC
Result:
ABC
As an alternative, you can use simple html, so to use a H5 header one simply surrounds the header with the appropriate code:
<h5>Your HEADER text</h5>
Result:
Your HEADER text
Quoting others
The official method is:
{quote} insert famous quote here {quote}
Result:
insert famous quote here
Shorthand is
> Every old idea will be proposed again with a different name and a different presentation, regardless of whether it works. (RFC 1925)
Every old idea will be proposed again with a different name and a different presentation, regardless of whether it works.
Referencing users
Referencing users by User ID
The official method is: [Wil|~152604]
Result:
Wil
A shorthand alternative is: [~152604]
wila
Referencing users by User name
The official method is [Wil|~152604]
Result:
Wil
The shorthand alternative is: [~User_Name_]
Please note that whenever you type the username in that format, that the forum software will translate it for you in the user-reference with the user-id number after the message is send or the document has been saved. Even when instructing to not reformat. This makes it a little difficult to explain, unless we use a screen shot. Thanks
WoodyZ for uncovering this and making the following screen shot.
Ordered lists
Official documentation on this one is nil.
The undocumented way of doing this is:
# This is a ordered list
## First indented jump in
## Second item
# Main item 2 on the list
Result:
- This is a ordered list
- First indented jump in
- Second item
- Main item 2 on the list
Forcing linebreaks
You can force a linebreak by inserting a double backslash
first line\\second line
Result:
first line
second line
Is it smart to use undocumented markup?
Well i only learned this by looking at how official VMware employees use the markup, so i would expect it to be safe to use. I admit that this was only the reference thread part, other markup here is found by trial and error. Unless we get the official "OK" from VMware it is up to you if you use the undocumented ones OR the documented part. See also the first comment from
etung
I think your "h3.ABC" line needs a space between the '.' and the 'A'; it's the markup I use in my documents.
Just because some employees/moderators use particular markup doesn't mean it's safe - I'm figuring it out as I go along much as you are. I can possibly complain louder if it does break, but no guarantee that it'll be fixed