Contributing to the Mercurial Wiki

Contributions are most welcome, no matter how small they may be!

Please create a user name for yourself by clicking "Login" in the upper right.

Mercurial and all wiki content are available under the GNU GPL.

There is currently no specific procedure to follow for editing the wiki besides that you should be bold in updating pages. If an edit is unwanted, it can be easily reverted (even page deletions), so there should be no fear about screwing-up pages (of course, there are more sensitive areas like the front page, but it's no big deal).

Larger edits or refactorings are best reported or proposed on the mercurial mailing list (see [:MailingLists]). So it might be a good idea to be subscribed to the list when "moving around the furniture" :) . A good advice is to listen to what the consensus is.

You should be aware that your IP address is logged and publicly viewable when you edit a page (even if you are logged in).

If you edit a page and decide to abandon your edit, please click the "cancel" button above the edit window. This will clear out the edit warning lock others will get while you edit a page. To see the history of all edits made to a page, click on the "info" link on the top.

Thanks for your help in maintaining the Mercurial wiki!

1. Some first help on wiki editing

Basic help about editing the wiki is shown below the edit window when you edit any page. The most important wiki editing help pages are [:HelpOnEditing] and [:SyntaxReference].

Links to other wiki pages can be created like this: 

[:ChangeSet:this is a link to the page ChangeSet]

which looks like this: [:ChangeSet:this is a link to the page ChangeSet]. So the syntax is: 

[:PageName:text to show for link]

Words in camel case (like this: CamelCase) are linked too without using the [..]. If you don't want a camel cased word to be linked put a ! in front of it.

The easiest way to create a new page is to first insert a link to that new page on an existing page, then click the link and you will get a list of templates for new pages.

To search for a page, go to [:FindPage]. You can also start a new page by entering the name of the new page in the "Go To Page" input field on the bottom of FindPage.

Test edits can be made in the [:WikiSandBox].