$wgGroupPermissions['user']['read'] = true; $wgGroupPermissions['*']['read'] = true; How to edit the CamiTK wiki - Forge Wiki
SCM

How to edit the CamiTK wiki

From Forge Wiki

Jump to: navigation, search

You wish to contribute to the CamiTK wiki, from all people that you will help, thank you !

The only prerequisite step is to have an account on the forge, which is free (of course !) in order to contribute to the project. If you do not have one yet, please create one. Once logged in the forge, you will be able to easily edit any wiki page. Remember the wiki syntax

Contents

Editing an existing wiki page

Simply click on the edit tab of the page, and add your comments, suggestion or correct the page if it appears to be in some point wrong, according to you. You may also edit a particular part of the page, prefer then the top right edit button of the article. You can edit any page, even this one !

Creating a new page

Type in the search field the name of the page that you want to create, if no ones with that name exist, the search result page will propose you to create one. Simply follow the link.

Add source code in wiki pages

As a software developer you wish to add some code example. For this, feel free to use syntax highlighting to better present your code.

Add the tags

<source lang="cpp"> // Place your code here </source>

where cpp is the language that can be changed. Do not hesitate to check the option of this wiki extension

For instance the code :

<source lang="cpp" >
MyAction::MyAction(ActionExtension * extension) : Action(extension) {
    // Setting name, description and input component
    setName("My Component name");
    setDescription("The action my component does");
    setComponent("MyComponentClassName"); 
}
</source>

shows:

MyAction::MyAction(ActionExtension * extension) : Action(extension) {
    // Setting name, description and input component
    setName("My Component name");
    setDescription("The action my component does");
    setComponent("MyComponentClassName"); 
}

Upload files (images and videos)

Uploading image or video files on the wiki is simple.

Upload files

Follow the instructions, and do not forget to write some description for each file. It helps us quickly find an already uploaded file.

Embed videos

The extension MediaWikiPlayer allows us to directly play video files in wiki pages !

  • First of all, upload your video file : .flv or .mp4 or get the URL to your website hosting your video file.
  • link your file using the following tag
<mediaplayer>//path or url to your video </mediaplayer>

for instance, the following code :

<mediaplayer width='500' height='300'>http://camitk.imag.fr/videos/imp.flv</mediaplayer>

displays :

The media player is loading...

Special frames

Here are some special code to generate frames that you may use to enlight special instructions.

Information

Use the following code

{| style="color: black; background-color: #89D0FF;" class="wikitable"
| rowspan = "2"| [[File:Note.png|32px|left]]
| colspan="2" |  

This is a note you might find interesting.

|}

to generate the following frame:

This is a note you might find interesting.

Warning

Use the following code

{| style="color: black; background-color: #FFA36B;" class="wikitable"
| rowspan = "2"| [[File:Warning.png|32px|left]]
| colspan="2" |  

Be carreful, read this !

|}

to generate the following frame:

Be carreful, read this !

Tips

Use the following code

{| style="color: black; background-color: #FFFB99;" class="wikitable"
| rowspan = "2"| [[File:Tip.png|32px|left]]
| colspan="2" |  

Here's a great tip for you !

|}

to generate the following frame:

Here's a great tip for you !

Cite references

Citation is made easy thanks to the Cite plugin.

  • <ref> will allow you to create a new reference to a citation.
  • <references /> will list all the citation in the page.

For example, the given text:


CamiTK is a great framework.<ref>http://membres-timc.imag.fr/Emmanuel.Promayon/publications//FDK+12.php</ref>

<references />

Will generate:

CamiTK is a great framework.[1]

  1. http://membres-timc.imag.fr/Emmanuel.Promayon/publications//FDK+12.php

Note that your citations will appear in your page where the <references /> tag is located.

You may checkout the Cite plugin page for more precise information on this feature.

Powered By FusionForge