|
|
WikiSyntax
The reference to the wiki syntax for Google Code projects
Paragraphs
Use one or more blank lines to separate paragraphs.
Typeface
| Name/Sample | Markup |
| italic | _italic_ |
| bold | *bold* |
| code | `code` |
| code | {{{code}}} |
| superscript | ^super^script |
| subscript | ,,sub,,script |
| strikeout | ~~strikeout~~ |
You can mix these typefaces in some ways:
| Markup | Result |
| _*bold* in italics_ | bold in italics |
| *_italics_ in bold* | italics in bold |
| *~~strike~~ works too* | strike works too |
| ~~as well as _this_ way round~~ | as well as this way round |
Code
If you have a multiline code block that you want to display verbatim, use the multiline code delimiter:
{{{
def fib(n):
if n == 0 or n == 1:
return n
else:
# This recursion is not good for large numbers.
return fib(n-1) + fib(n-2)
}}}Which results in:
def fib(n):
if n == 0 or n == 1:
return n
else:
# This recursion is not good for large numbers.
return fib(n-1) + fib(n-2)Headings
= Heading = == Subheading == === Level 3 === ==== Level 4 ==== ===== Level 5 ===== ====== Level 6 ======
Heading
Subheading
Level 3
Level 4
Level 5
Level 6
Dividers
Four or more dashes on a line by themselves results in a horizontal rule.
Lists
Google Code wikis support both bulleted and numbered lists. A list must be indented at least one space to be recognized as such. You can also nest lists one within the other by appropriate use of indenting:
The following is:
* A list
* Of bulleted items
# This is a numbered sublist
# Which is done by indenting further
* And back to the main bulleted list
* This is also a list
* With a single leading space
* Notice that it is rendered
# At the same levels
# As the above lists.
* Despite the different indentation levels.The following is:
- A list
- Of bulleted items
- This is a numbered sublist
- Which is done by indenting further
- And back to the main bulleted list
- This is also a list
- With a single leading space
- Notice that it is rendered
- At the same levels
- As the above lists.
- Despite the different indentation levels.
Quoting
Block quotes place emphasis on a particular extract of text in your page. Block quotes are created by indenting a paragraph by at least one space:
Someone once said: This sentence will be quoted in the future as the canonical example of a quote that is so important that it should be visually separate from the rest of the text in which it appears.
Someone once said:
This sentence will be quoted in the future as the canonical example of a quote that is so important that it should be visually separate from the rest of the text in which it appears.
Links
Links are central to the wiki principle, as they create the web of content. Google Code wiki permits both internal (within the wiki) and external links, and in some cases automatically creates a link when it recognizes either a WikiWord or an URL.
Internal wiki links
Internal links within a wiki are created using the syntax below. If you add a wiki link to a page that does not exist, the link will appear with a LittleLink? to all project members and owners. Clicking that link will take you to the page creation form where you can enter content for that page.
If you are not logged in, wiki links that point to non-existent pages will appear as plain text, without the link to the page creation form. When you create the target page as a project member or owner, the link will switch to being an actual hyperlink for all viewers of the page.
WikiSyntax is identified and linked automatically Wikipage is not identified, so if you have a page named [Wikipage] you need to link it explicitly. If the WikiSyntax page is actually about reindeers, you can provide a description, so that people know you're actually linking to a page on [WikiSyntax reindeer flotillas]. If you want to mention !WikiSyntax without it being autolinked, use an exclamation mark to prevent linking.
WikiSyntax is identified and linked automatically
Wikipage is not identified, so if you have a page named Wikipage you need to link it explicitly.
If the WikiSyntax page is actually about reindeers, you can provide a description, so that people know you're actually linking to a page on reindeer flotillas.
If you want to mention WikiSyntax without it being autolinked, use an exclamation mark to prevent linking.
Links to external pages
You can of course link to external pages from your own wiki pages, using a syntax similar to that for internal links:
Plain URLs such as http://www.google.com/ or ftp://ftp.kernel.org/ are automatically made into links. You can also provide some descriptive text. For example, the following link points to the [http://www.google.com Google home page]. If your link points to an image, it will get inserted as an image tag into the page: http://code.google.com/images/code_sm.png You can also make the image into a link, by setting the image URL as the description of the URL you want to link: [http://code.google.com/ http://code.google.com/images/code_sm.png]
Plain URLs such as http://www.google.com/ or ftp://ftp.kernel.org/ are automatically made into links.
You can also provide some descriptive text. For example, the following link points to the Google home page.
If your link points to an image (that is, if it ends in .png, .gif, .jpg or .jpeg), it will get inserted as an image into the page:
You can also make the image into a link, by setting the image URL as the description of the URL you want to link:
Tables
Tables are created by entering the content of each cell separated by || delimiters. You can insert other inline wiki syntax in table cells, including typeface formatting and links.
|| *Year* || *Temperature (low)* || *Temperature (high)* || || 1900 || -10 || 25 || || 1910 || -15 || 30 || || 1920 || -10 || 32 || || 1930 || _N/A_ || _N/A_ || || 1940 || -2 || 40 ||
| Year | Temperature (low) | Temperature (high) |
| 1900 | -10 | 25 |
| 1910 | -15 | 30 |
| 1920 | -10 | 32 |
| 1930 | N/A | N/A |
| 1940 | -2 | 40 |
Sign in to add a comment
What are the restrictions on internal wiki names? It seems one cannot use characters such as dot or minus in link names within square brackets.
Why is SourceCodeParser? or TypeDef? automatically recognized as a link, when it shows up with a '?' beside it?
Can we have a directive to disable syntax highlighting? Currently syntax highlighting is applied to all code blocks, whether we want it or not, and is making some Wiki pages look strange. Take the current page as example.
Can you add inline HTML? or at least the ability to add google group's subscribe/promotion box?
what about [TableOfContents?] ?
Yes, I agree with ajiaojr, I don't like the syntax highlighting, it's better to have a choise of the highlighting type(type of language) or at least a choice to turn off it.
anthony.aziz: Any word that is written with CapitalsInTheMiddle? is automatically considered to be a link to a wiki page. If there is no page with that name, the "?" link allows you to easily create that page. That is just part of the way that all wiki's work, becaue the main idea of a wiki is to make it very easy to create hyperlinked pages. You can reverse the default behavior by using an exclaimation point, e.g., CapitalsInTheMiddle.
ajiaojr: pelase see the later comments in issue 44. You may want to star that issue.
lenoam: please see issue 23. You may want to star that issue.
sashulika: Please see issue 116. You may want to star that issue.
Woops, that example was supposed to look like: !CapitalsInTheMiddle.
very suggest add TableOfContent? support such as MoinMoin? [TableOfContents?]
Can you edit the way the page name appears?
Can we change the background color of a wiki page?
It wasn't obvious to me, but if you want to write literals of *_~^ just put them in backquotes. Example: __FILENAME__
I don't see a way to force linefeeds, and suppress wrapping, unless I put lines between paragraphs.
@petdance: I personally use an heading markup with a blank inside.
any chance of a table of contents, or even internal page linking?
philip: please see issue 116. You may want to star that issue.
@aziz.koeksal: You have singlehandedly made my week. I have been trying to figure out how to produce a * in my wiki pages for so long without success. GoogleFolk?: could you please add this escape syntax to the Wiki Markup Help?
Please dl, dd, and dt are needed.
Indenting?
Image can point to external link, but cannot point to internal wiki page... ??
Without any reverse look up, Google Code Wiki is very UnWiki?
cleveridea.net: I have entered issue 410 to track this request. You may want to star that issue.
How do you add the "summary" message?
Berlin: the syntax to set the summary is #summary This is the summary of this page.
You can see an example of that every time you create a page via the web UI.
is there a special way to add images into wiki docs? Are there any special upload repository or can we just submit through subversion and then link to them like any other image.
berlin: the expected way to do it is to put images in subversion and then link to them.
Why this block code shows " and not "
javascript:function fun(){ var win = window.open(document.location); win.document.write("<html><head><title>jshArea - JavaScript Hacking Area by Davide Rognoni</title></head><body><form><textarea id='jshArea' cols='80' rows='18'>alert(opener)</textarea><br><input type='button' value='eval jshArea' onclick='javascript:eval(document.getElementById(\"jshArea\").value)'></form></body></html>") } fun()how do I control the size of paragraph text (i.e. like html small or smaller)?
There seems to be no way to insert Tab characters (the cursor moves to the first Labels field), nor any way to force a new line except with a paragraph break.
Re "Comment by marco.segato, Aug 06, 2007 @petdance: I personally use an heading markup with a blank inside. "
I don't see how this works - for me it just displays the heading markup.
How can I rename a wiki page?
tmbdev: you can use the svn command-line to do it. There is not yet any way to do it via the web UI, and there is no automated update of all other pages that link to the page you are moving.
One more vote for TableOfContents? support.
Also, the ability to link to sections (headings) within a document would be very useful.
Can I change the background color of a table´s cell ?
broofa: adding a comment here does not count as a vote on anything. The only way to vote for something to be changed is to star an issue in the support issue tracker.
victorgmartins: there is no way to do that yet.
Is there a list anywhere of the #tags supported? Besides #summary and #labels.
Is there a way to link to files in the SVN repository? E.g. [svn:/path/to/file my source file]
uhm. http://project.googlecode.com/svn/path/to/file ??
How can I write a comment in my wikis, something like
When I use sentence like: /Configuration /Template /Languages
I get no newline...
oh! Not in the comments either...
I second the request for non-highlighting literal blocks. How about [[[ for syntax ?
Please could we have restructured text support for wiki pages? http://docutils.sourceforge.net/rst.html
My project defines a new programming language. I would like to quote program written in this language. Yet, your syntax highlighting does not know how to format it (which is not surprising of course).
Is that possible to add, in a future version, a simple customizable mode for syntax highlighting to define my own keywords ?
Does the wiki support named anchor tags. Eg, I can scroll down to that particular section. I am assuming no, but would nice to have.
In html:
href="/blah.html#dog"?That dog sectiona?
name=dog?
Oops, it looks like the wiki messed up my HTML formatting
Something like this.
@berlin.brown: Yes, see above under "Links to External pages" (second example).
"You can also provide some descriptive text. For example, the followinglink points to the Google home page."?
I dont see that example; I was thinking more like this.
http://www.google.com#some_page_farther_down_on_google_page
its very nice ya
You can create an absolute URL with an anchor, but not a relative URL. More importantly, you can't created a named link to use as the target.
More importantly, you can't created a named link to use as the target
Would be a nice feature?
Are unicode characters supported? What if I wanted to do something like 葉 ?
Why can't we use the [embed?] tag to include a JavaScript? on project pages?
Just another VOTE begging for Table Of Contents. Pleeeeeeease ;-)
we need a new line synx. something like <br> or \n
1 vote for Table of Contents
meshee.knight and everyone: votes in comments here do not count. The only way to vote for issues that matter to you is to mark them with a star in the issue list or the issue detail pages. In this case, there is already issue 116 that you can star.
table of contents, please!
Insert HTML ?
....being able to insert a live mindmeister map would be a major +
Yes. We need a code to break lines easy.
maybe like this.
(i cant make "=" because the br is big then, i write "equality sign" for "=")
"equality sign"br"equality sign"
There is a problem with this "Uploaded-information"..
I uploaded my project .. i dont know 20 min ago and theres written "Updated Yesterday (37 hours ago) "
What about latex like in wikipedia ? that would be useful when document requires typing mathematics !
Something that would be interresting is a way to link from wiki-enabled texts to issues, source revisions and source files.
It may be interesting from a general wiki page to be able to link to a particular source revision, for example to link source tags to releases.
In issue description and comments, a link to a file:revision or a revision would allow to easily browse the file where the error lays and in where revision it is fixed.
If you need to escape characters, use the verbatim code block:
ie:
To access this variable, use var["hi"]
Are you sure this works
http://franklin.vp.googlepages.com
Excellent. Just one nitpick: TOC, table of contents, generated from headers, is the most important feature right now. Without it, it is hard to skim over long page. Can you please add it? Pretty please? Or is there better forum to beg for a feature?
What about adding support for polling? I would like to put a short polling to let people vote if they like or dislike my program.
And add the umpteenth vote for ToC ("table of contents, generated from headers", as peter.masiar wrote on Nov 29) feature. Please. Please please please please please. Pleeeeeeaaaaase. Plz.
Merci.
Are you guys going to make the 2007 milestone. Kind of cutting it close? There are a lot of features that I would like to use.
Hello, I want to paste an HTML block and this block must be treated not as wiki, as HTML. I couldn't succeded. Can anyone tell me if wiki markup support something like <nowiki> ? thanks.
I need to make a TOC. How do I do this ? Thanks
TOC + 1
TOC + 1
Wait.. literal `` characters, I mean. Or do I? See what I mean? Could you add it to the list?
Is there some kink of escape character? Or some way to mark a verbatim -non code- blok?
I'm trying to write the name of one of the folders in my project ( AS3_Class_Exporter_Front?? ) but haven't found a way around the autolinking feature.
Even though I've placed an exclamation mark to prevent autolinking, it keeps adding the link. I think it's a combination of the second char being upper case after an upper case first char, and the underscores.
I could just strip out the underscores or use a small 's' as the second char, but I'm intendig to document the actual name of the folder, so that wouldn't make much sense...
I think this is a bug. Should I open an issue?
Anybody know what I'm getting bolding in the list items? I'm using a single asterisk at the beginning of each line with a single white space indentation.
Problem page: http://code.google.com/p/aperture-cms/wiki/Features
What about math? My code <math>F=ma</math> is not working... How can I enter math formulas?
I want line breaks in tables!!!!
I really need TableOfContents? feature.
Any way to use a single asterisk without creating bold text for the rest of the line?
Is there a way to embed a graph written in 'dot' (www.graphviz.org)?
We want TOC !
could we have colored inline code? eg. `bla bla`
1 vote for Table of Contents
The system seems OK, but how about a hard return code? The current way leaves a blank line between the lines you want to put the hard return between.
Thanks.
怎样在Project Home 里插入youtude的FLV文件呢？？ 谢谢o(≧ω≦)o
autodesker: Right now there is no way to embed a video on your project home page. All that you can do now is hyperlink to youtube. For example, just type http://www.youtube.com/watch?v=jtK6qITij5k and it will be a link.
jrobbins:enen thanks
How to change in the Project Metadata the licenses to Multiple Licenses like on http://code.google.com/p/google-summer-of-code/ ?
m@roc.li: that value is not available on regular open source projects, you must choose one license. We only use it on special projects that we run.
Why is it not using MediaWiki? (Wikipedia.org) standard wiki syntax?
The link
should be rendered as text, but it showed up as an image instead
And linking a jpg file didn't work (without the square bracket), see http://code.google.com/p/tvsearch/issues/detail?id=1
The section headings create anchors; so you can link to them. For instance, if you type this:
You get this:And of course, you can use the anchors to build a TOC by hand.
My lists seem fine in preview mode, but get all messed up on saving. e.g.
The above displays fine in preview, but after saving the bullet is displayed on the last line of the text.
Numbering isn't working either. e.g.
Again, looks fine in preview, but after saving all the numbered items are 1:
1 Numbered item 1 1 Numbered item 1
Why not include a way to like to SVN change sets in pages, and issues. That would be great.
Is it already there? I couldn't find...!
hi,jdcohenesq,
I can create a internal html link in a wiki page using Internal wiki links .
MY question: HOW CAN I BUILD A TOC in the project home page.for example, how to build a TOC in your the following page?
http://code.google.com/p/support/
Something's wrong with wiki formatting since recently :-) Lists and paragraphs are broken, although they did work fine just month (or so) ago.
Another vote for table of contents with links to section headers would be great.
How to do images:
svn co https://your project.googlecode.com/svn/wiki projwiki --username your.name
copy the image into that checkout and svn add it. Either commit now and edit the wiki from the web interface (it's good to preview this way) or edit the .wiki file and then commit.
Edit the wiki page to link to http://your project.googlecode.com/svn/wiki/beautiful_evidence.png
Can I add attachments to my wiki page, or do I need to explicitly add them to the downloads section?
Is there any to turn off the automatically python syntax highlighting for codes? There are many programming language that is neither Python, nor python-like. No highlighting is better than a bad highlighting. At least provide an option to turn on/off.
Stupid question. Why not a WYSIWYG editor (optional)? Do we really have to suffer like this? ;-)
hello, how i can center images for example ?
I'd like a way to generate content about the project. E.g. a list of links to pages that have a given label, to issues in the tracker, to files in SVN, etc.
TOC TOC TOC \o\
If you want to change the name of a page (pagename page name for those grepping comments), just check out the wiki in subversion, and do a subversion move of the page file to a different name. Wiki pages are stored in /wiki in the root of the project repository.
great
colors would be very useful (text color)
TOC ..., TOC ? TOC ! TOC .
[[Include()]] pls !!
And what about image resizing or scalling?
How can I specify the locale of wiki page?
Okay, if I start a numbered list with sub-bullets, the wiki doesn't understand I'm continuing my numbered list later. Example.
looks like you can
TestMode
It would be nice if we could include some basic HTML and Javascript so that I could have a feedburner feed display on my projects home page.
How about an example on preventing autolinking? It says use an exclamation mark... how so?
How to, if possible, embed flash? (youtube video) Thx.
test.............
Is there a way to make the Wiki tab automatically open the top page of my wiki, instead of just a flat list of all the pages?
Could you add support for having Google Talk chatback badge to the Wiki pages?
Ability to insert (X)HTML snippets would do it too..
hh
Add one more vote to the TOC tally
def fib(n): if n == 0 or n == 1: return n else: # This recursion is not good for large numbers. return fib(n-1) + fib(n-2)People, this is not the place to complain about bugs, or ask for features.
The appropriate site is: http://code.google.com/p/support/issues
Joining with cesarsouza here - resizing please!
Hello Guys......How can I get PostTube? to show on One post but not all posts...I placed the function in SINGLE.PHP (to display the player and the playlist separately:
Any can help me to get this function to point on only specific post only but not ON all posts...
WikiSyntax is identified and linked automatically
Wikipage is not identified, so if you have a page named Wikipage? you need to link it explicitly.
If the WikiSyntax page is actually about reindeers, you can provide a description, so that people know you're actually linking to a page on reindeer flotillas.
If you want to mention WikiSyntax without it being autolinked, use an exclamation mark to prevent linking.