|
Size: 2539
Comment:
|
Size: 3524
Comment: removing spam
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| == Contributing to the Mercurial Wiki == | #pragma section-numbers 2 |
| Line 3: | Line 3: |
| Contributions are most welcome, no matter how small they may be! | = Contributing to the Mercurial Wiki = |
| Line 5: | Line 5: |
| Please create a user name for yourself by clicking "Login" in the upper right. | {i} Unlike some wikis, this wiki is not intended for interactive discussion - please use the [[MailingLists|mailing lists]] for questions. |
| Line 7: | Line 7: |
| Mercurial and all wiki content are available under the GNU GPL. | <<TableOfContents>> |
| Line 9: | Line 9: |
| 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). | This page is to introduce you to contributing to the Mercurial wiki. For more basic help, see HelpOnEditing and SyntaxReference. For more extensive contributions, please see our [[WikiStyleGuide|style guide]] and [[WikiCleanup|cleanup guide]]. |
| Line 11: | Line 11: |
| 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. | == Some first help on wiki editing == |
| Line 13: | Line 13: |
| You should be aware that your IP address is logged and publicly viewable when you edit a page (even if you are logged in). | {i} You should be aware that your IP address is logged and publicly viewable when you edit a page (even if you are logged in). |
| Line 15: | Line 15: |
| 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. | '''Just about all pages on this wiki are editable by you! If you spot a typo, factual error, or other problem, you can fix it yourself immediately.''' |
| Line 17: | Line 17: |
| Thanks for your help in maintaining the Mercurial wiki! | To edit a page, simply click the 'Edit' link on the upper left of most pages. If you haven't logged in, you'll be prompted to create an account which you can later use to subscribe to page changes and set wiki preferences. |
| Line 19: | Line 19: |
| === Some first help on wiki editing === | Also consider periodically checking the RecentChanges page, where you can set bookmarks for the changes you have seen if you have a login. |
| Line 21: | Line 21: |
| 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]. | Basic help about editing the wiki is shown below the edit window when you edit any page. More info can be found at HelpOnEditing, SyntaxReference and WikiStyleGuide. |
| Line 26: | Line 26: |
| [:ChangeSet:this is a link to the page ChangeSet] | [[UnderstandingMercurial|some basic Mercurial concepts]] |
| Line 29: | Line 29: |
| which looks like this: [:ChangeSet:this is a link to the page ChangeSet]. You can omit the link text: | which looks like this: [[UnderstandingMercurial|some basic Mercurial concepts]]. You can omit the link text: |
| Line 32: | Line 32: |
| [:ChangeSet] | [[UnderstandingMercurial]] |
| Line 35: | Line 35: |
| which makes the link look like this: [:ChangeSet] (the link text is the page name if it is omitted). | which makes the link look like this: [[UnderstandingMercurial]] |
| Line 37: | Line 37: |
| So the syntax is: | Words in 'camel case' (like this: {{{UnderstandingMercurial}}}) are linked too (UnderstandingMercurial) without using the {{{[[..]]}}}, but using descriptive text is generally preferred. |
| Line 39: | Line 39: |
| {{{ [:PageName:text to show for link] }}} |
== Creating new pages == |
| Line 43: | Line 41: |
| 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. | <!> Before creating a new page, first search for similar content using [[FindPage]]. Then see the [[WikiStyleGuide|wiki style guide]] for some guidelines on naming and creating new pages. |
| Line 45: | Line 43: |
| 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. | 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. 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]]. You should also consider creating a page matching your account name to tell other wiki users and editors who you are and how to reach you. See CategoryHomepage for examples. |
| Line 47: | Line 46: |
| 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. | === Creating a homepage === |
| Line 49: | Line 48: |
| Test edits can be made in the [:WikiSandBox]. | Please only create a homepage if you have contributed content to this wiki and would like to publish your contact details for other wiki users. Homepages should concern themselves only with a person's Mercurial-related activity: general homepage hosting is widely available on the Internet, and it is not this site's purpose to offer such services. Please use the HomepageTemplate when creating your homepage so that it belongs to CategoryHomepage. == Helping out more == Mercurial is a creation of volunteers like you. If you'd like to help improve the wiki, start by checking RecentChanges to see all recent changes to the wiki and review them for spam and make additional improvements. Visit WikiCleanup for further ideas. == See also == * The [[WikiStyleGuide|wiki style guide]] * Our [[WikiCleanup|wiki clean-up]] project ---- CategoryWiki |
Contributing to the Mercurial Wiki
Unlike some wikis, this wiki is not intended for interactive discussion - please use the mailing lists for questions.
Contents
This page is to introduce you to contributing to the Mercurial wiki. For more basic help, see HelpOnEditing and SyntaxReference. For more extensive contributions, please see our style guide and cleanup guide.
1. Some first help on wiki editing
You should be aware that your IP address is logged and publicly viewable when you edit a page (even if you are logged in).
Just about all pages on this wiki are editable by you! If you spot a typo, factual error, or other problem, you can fix it yourself immediately.
To edit a page, simply click the 'Edit' link on the upper left of most pages. If you haven't logged in, you'll be prompted to create an account which you can later use to subscribe to page changes and set wiki preferences.
Also consider periodically checking the RecentChanges page, where you can set bookmarks for the changes you have seen if you have a login.
Basic help about editing the wiki is shown below the edit window when you edit any page. More info can be found at HelpOnEditing, SyntaxReference and WikiStyleGuide.
Links to other wiki pages can be created like this:
[[UnderstandingMercurial|some basic Mercurial concepts]]
which looks like this: some basic Mercurial concepts. You can omit the link text:
[[UnderstandingMercurial]]
which makes the link look like this: UnderstandingMercurial
Words in 'camel case' (like this: UnderstandingMercurial) are linked too (UnderstandingMercurial) without using the [[..]], but using descriptive text is generally preferred.
2. Creating new pages
Before creating a new page, first search for similar content using FindPage. Then see the wiki style guide for some guidelines on naming and creating new pages.
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. 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. You should also consider creating a page matching your account name to tell other wiki users and editors who you are and how to reach you. See CategoryHomepage for examples.
2.1. Creating a homepage
Please only create a homepage if you have contributed content to this wiki and would like to publish your contact details for other wiki users. Homepages should concern themselves only with a person's Mercurial-related activity: general homepage hosting is widely available on the Internet, and it is not this site's purpose to offer such services.
Please use the HomepageTemplate when creating your homepage so that it belongs to CategoryHomepage.
3. Helping out more
Mercurial is a creation of volunteers like you. If you'd like to help improve the wiki, start by checking RecentChanges to see all recent changes to the wiki and review them for spam and make additional improvements. Visit WikiCleanup for further ideas.
4. See also
The wiki style guide
Our wiki clean-up project