|
WikiSyntax
The reference to the wiki syntax for Google Code projects
IntroductionEach wiki page is stored in a .wiki file under the /wiki directory in a project's repository. Each file's name is the same as the wiki page name. And, each wiki file consists of optional pragma lines followed by the content of the page. PragmasOptional pragma lines provide metadata about the page and how it should be displayed. These lines are only processed if they appear at the top of the file. Each pragma line begins with a pound-sign (#) and the pragma name, followed by a value.
Wiki-style markupParagraphsUse one or more blank lines to separate paragraphs. Typeface
You can mix these typefaces in some ways:
CodeIf 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 ====== DividersFour or more dashes on a line by themselves results in a horizontal rule. ListsGoogle 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:
QuotingBlock 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. LinksLinks 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 linksInternal 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 project committers 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, the link will become a normal 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 anchors within a pageEach heading defines a HTML anchor with the same name as the heading, but with spaces replaced by underscores. You can create a link to a specific heading on a page like this: [WikiSyntax#Wiki-style_markup] And it will render as: WikiSyntax#Wiki-style_markup. Links to external pagesYou 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. 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]
Links to imagesIf 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: http://code.google.com/images/code_sm.png
If the image is produced by a server-side script, you may need to add a nonsense query string parameter to the end so that the URL ends with a supported image filename extension. http://chart.apis.google.com/chart?chs=200x125&chd=t:48.14,33.79,19.77|83.18,18.73,12.04&cht=bvg&nonsense=something_that_ends_with.png
TablesTables 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 ||
HTML supportTo aid in the presentation of a wiki page there is some support for HTML. HTML tags are only supported in wiki pages, not in page comments. HTML syntax can be used in conjunction with wiki syntax, but it is recommended against doing so where possible. The following HTML tags and attributes are currently supported:
[1] The language attribute of the code tag is the file extension of the language used in the code block. It is used as a hint for the syntax highlighter. Escaping HTML TagsWhen you want to display html tags directly on your wiki page (as opposed to rendered), you will need to escape each HTML tag. HTML tags can be escaped as shown in the table below:
CommentsThe wiki supports embedded comments to help explain the contents of a wiki page. Anything inside the comment block is removed from the rendered page, but is visible when editing or viewing the source for that page. <wiki:comment> This text will be removed from the rendered page. </wiki:comment> GadgetsYou can embed Gadgets on your wiki pages with the following syntax: <wiki:gadget url="http://example.com/gadget.xml" height="200" border="0" /> Valid attributes are:
WorkingWithGoogleGadgets describes how to create gadgets for Google Code. It also provides a few helpful suggestions that can make it easier to publish gadgets and to integrate with other Google products such as iGoogle. InterestingDeveloperGadgets shows some sample gadgets you may want to include on your project pages. VideosYou can embed videos with the following syntax: <wiki:video url="http://www.youtube.com/watch?v=3LkNlTNHZzE"/> Valid attributes are:
Right now we support videos from Youtube and Google Video, but other containers can be added to our open source gadgets project. NavigationTable of ContentsAn inline table of contents can be generated from page headers on a wiki page. Add the following syntax to a page in the location the table of contents should be displayed: <wiki:toc max_depth="1" /> Valid attributes are:
Side navigationYou can specify the sidebar for a wiki page by selecting another wiki page that defines your side navigation. The doctype project uses the sidebar extensively across its wiki. One way of adding a sidebar is by setting the #sidebar pragma, as shown below. Alternatively, the sidebar pragma can be left blank if no side navigation is desired.
The side navigation that is defined should be in the format of a simple list, as shown below. * [Articles HOWTO articles]
* [ArticlesXSS Web security]
* [ArticlesDom DOM manipulation]
* [ArticlesStyle CSS and style]
* [ArticlesTips Tips and tricks]
* [DOMReference DOM reference]
* [HTMLElements HTML reference]
* [CSSReference CSS reference]A default sidebar page can also be specified for all wiki pages by project owners through the Wiki settings in the Administer tab. If a #sidebar pragma is also specified, it will take precedence on the page. Localizing Wiki ContentAlong with the default language for the wiki, which can be set through the Wiki settings in the Administer tab, additional languages are also supported. If more than one language is available, based on a user's language preference (e.g. browser language), the wiki will try to serve the page for the appropriate language. If no wiki page exists for that language, it will fall back to the default language. Comments, however, are shared amongst all translations of a wiki page. New translations for a page cannot be added through the web interface and have to be added through the Subversion repository. To add a translation of a page, first checkout the wiki from Subversion: Then create a new directory under /wiki/ using the two letter ISO-639 code as the name of that directory. Place all translated files in the new directory and submit those changes to the Subversion repository. The following is an example of a valid wiki directory: wiki/
ja/
ProjectHistory.wiki
StyleGuide.wiki
zh-CN/
ProjectHistory.wiki
StyleGuide.wiki
zh-TW/
ProjectHistory.wiki
StyleGuide.wiki
ProjectHistory.wiki
StyleGuide.wikiOnce the files been be submitted to the project's subversion repository, they can now be edited through the wiki's web editor. Note: The wiki accepts a subset of ISO-639 two letter language codes, where a few of the codes (such as zh_CN) contain locale-specific codes. Such locale-specific codes should use a hyphen (zh-CN) separator. A few example language codes have been specified in the table below.
The content on this page created by Google is licensed under the Creative Commons Attribution 3.0 License. User-generated content is not included in this license. |
Sign in to add a comment
Please do not file issues here or ask questions about Wiki syntax here
Issues: http://code.google.com/p/support/issues Questions: http://groups.google.com/group/google-code-hosting
Feel free to add comments that you think will be useful to others and will improve the documentation.
@andrew.fedoniouk
Just put an exclamation mark in front of the TextThatIsNotWiki:
How insert link to my project labeled page? I have link to page list?q=label:Component-Smarty
Now I insert full path to this page. This is bad! Please, parse this links:
Thanks!
After adding localization and then deletion, wiki does not fall back to use default wiki pages (without language). Now always after choosing page in wiki hows this:
Page blabla Not Found Create a New Page for blabla
inline code
How to insert unicode like ✡?
how to insert picasa images to summary page??
how to localise home page??
how to create a "bulleted or numbered lists" in tables. is it posible?
@andrew.fedoniouk: bold?
@pantaz.alexandru: Make a table with HTML, and add bulleted/numbered lists inside.
is there support for latex based equations in the google wiki markup?
Is it possible to syntax highlight Scheme or Lisp code? Thanks.
run all link
http://www.tjet-turkiye.com/ Dijital Tekstil Baskı Makineleri. Wiki support that link?
excellent
How does one work with HTML entities?
<img src="http://supported/?">
Heading1
Heading2
Heading3
So i added several languages to the wiki svn, how can they be accessed explivitly through the web interface?
Is there a way to say you do not want syntax highlighting in code blocks:
if x == 20 print("i do not want syntax highlighting for my custom language endhttp://hexun.com/hxkangli/default.html
How could I make links within the same page since the "name" attribute is not supported?
Thanks
Reboot
List 1 List 2 List 3
OK, I answer myself. Following the instructions from http://code.google.com/p/support/issues/detail?id=376&can=1&q=anchor colspec=ID%20Type%20Status%20Milestone%20Priority%20Stars%20Owner%20Summary
Anchors are automatically created for each heading. e.g.
My second chapter
Can be linked to using My second chapter
It would be great to add this to the wiki syntax documentation.
with code
This is test code
label
label that is 2 words
I read that you can check images into your svn repository and then reference them from the wiki. Maybe an example of this would be good
Is there a way to create directories:
project/wiki |---/tutorials | |----- /tutorial1 | +----- /tutorial2 | +--/manual |---- /Introduction |---- /the functions | +---- /the methodsI create second locale in wiki (en - default, add russian). After creation locale russian wiki-page only browse, no edit link.
Nice desc.
Thanks
Hi I need to include in a wiki page a link to a Google presentation. Is it possible? How?
Test test test Araba Oyunu Yarış Oyunu Araba Oyunu kız oyunu savaş oyunu giydirme oyunu dressup games animal games
Why do the page names appear on the page? Can this be optional, given that the names aren't allowed spaces or a title
Heading1
Heading2
Heading3
bold italic inline code escape: *
Indent lists 2 spaces:
Horizontal rule
WikiWordLink? label http://domain/page
String profile = request.getParameter("profile");Why not using or supporting WikiCreole? common language? http://www.wikicreole.org
Try try WikiSyntax
How do i insert pictures from my server into my wiki??
how can I input the label for my wiki? What ever I typed into the label, all the space characters gone.
Hi i am Kven just try ，um this wiki is dame diffcult one test 23 = 32
asdfasdf
asdfasdf
Can I upload an image?
I put a image file into the wiki folder through svn, can i ref it in my wiki page?
jjkj
Good
Nice
public static void main(String[] args) { System.out.println("Hello, Wiki!"); }http://image-store-888.appspot.com/image/4001
For all of you who want to add images to your wiki using the wiki repo here is how you do it.
Edit your wiki page to add the image links
Go check your wiki page out, the updated page with the images should be there.
Any new images can be added just as easily.
Description
THIS EXAMPLE SHOWS WIKI RENDERING BUG, WHICH CAUSES UNDEFINED LINE SPLITTING
between words Compiler and OpenWatcom?.
Code:
eva
Please add support for Esperanto language.
ISO 639-1: eo ISO 639-2: epo ISO/DIS 639-3: epo
I have some projects in this language and I alse see esperanto in another projects.
Wiki localization => subversion. But Mercurial?
What can I mark the color?