Subscribe to News
Help:Contents
From TechnologicalWiki
< Spanish Version - Versión Español >
Why should I contribute with thewiki4opentech?
This site aims to be a referent in open content technologies.
Who is adding contents?
Contents are being added by experienced enterprise workgroups and anonymous people. They write freely about :
- Projects manage by them.
- Tutorials amout how to do anything ( configuring systems, creating scripts, developing littles applications, ... )
- Articles about a technology that is being studying.
I think I could contribute, but I am not sure if my contents are appropiate
Don't worry. If these contents refers to technologies open: scripts, small programs, information about new technologies, events and news of the free software community, ... , you can write them in this site. You should be respectful in your contents and not use objectionable language. In addition, you should follow the basic rules of editing.
Why is good contribute for me?
In this Wiki,when users edit an article, its score grows. Score is a value which classifies to the user inside the community. We want to promote the articles creation,then, when an user creates an article, its nickname is shown as author of the article in its header, and anybody can access to its user page clicking over the nickname.
What format should I write the articles?
This platform is based on Mediawiki Software so the syntax is similar Wikipedia (based on Mediawiki). If you have any doubt, you can try to read these links :
This wiki adds new features, so you can use new syntax in it. To know more about the syntax, read this page.
Why should I create an user?
When you create or modify an article, you are contributing to the community. Just at that moment, your score increases. So, other users can know me and visit your personal wiki page. All registered user have got a personal page.
How to create an user
Click over "log in / create account" link located at the top-right corner. Then click on "create an account" (Log in form). Fill each field and click on the button. Please, insert a valid mail account. This is the only way to recover your password. Also, if you want to protect an article/project you have to make a request from this account.
Set your navigation preferences
When you have created an account, you can establish some preferences for your navigation clicking on my_ preferences ( at the top of the screen ) :
- User profile : Change your personal info. ( To receive any notification mail you must confirm your email at this section).
- Skins : To select your Wiki Skin ( default ).
- Files : Images in articles.
- Date and time : Format.
- Editing : Preferences for edition.
- Recent changes : Set your Recent changes preferences.
- Watchlist : Preferences for your Watchlist.
- Search : Set the search preferences by default.
- Misc : Set the Layout.
The Watchlist
The Watchlist is a pages list which you are "watching". When you are seeing an article, a watch tab is located above along with other tabs. You can activate/deactivate this, clicking on the tab. When you are "watching" a page, you can get asynchronous info from the wiki. When anybody has made any change into the article, you will receive an email alert. You can configure this in your preferences (User Profile / Watchlist).
How To Create an Article in this WIKI
See first Why should I create an user ? section.
There are some steps which must be followed by the user when they create an article to get a correct working of the wiki.
2- Write the category / categories which the article allows.
Each article must belongs at least to any Category among the next ones:
- Project ( Main page Project ) - automatically assigned when a project is created.
- ProjectSection ( Section Project ) - automatically assigned when a project is created.
- OpenSource ( Open Source Content )
- Mobile ( about mobile technologies )
- HowTo ( How to make ... )
- UnifiedCommunications ( Unified Communications line )
How To Insert a Video in an Article
You can show a video uploaded to YouTube easily into an article. all you have to do is write :
<youtube>Video_ID_in_YouTube</youtube>
an example :
<youtube>ZN_yU0e96GA</youtube>
How To Create an Article in reStructuredText format
You can introduce code in rst format using the next label :
<rst>...</rst>
So, you can document easier if you are used to document in rst format.
Limitations
There is not support for images. If you want show any image into the article ( in reStructuredText format ) you have to insert this in Wiki format:
.. image: myImage.jpg
... must be transformed to :
</rst> [[Image:MyImage]] <rst>
or put the URL image from external domain:
.. image: http://domain/MyImage.jpg
... then, you must upload the image to the wiki clicking over the link.
How To Create a Project in this WIKI
To create the set of tabs for your project :
This is necessary to design the number and the name of the sections/sub-sections of the project. How I can to do it? You only have to create a new article with the next name : Name of my project
MyProject
...if you want to create a project named MyProject
Use the project label.
The code for it is the next one :
<project>
name = MyProject
name of the section 1
*name of the subsection 1-2
*name of the subsection 1-2
name of the section 2
name of the section 3
*name of the subsection 3-1
name of the section 4
...
name of the section n
*name of the sub subsection n-1
</project>
{{ContentProject}}
Note : Do not use special characters ( # , ? , $ , & , + , @ , / , = , , , ; ) in name tabs.
Project main page, sections & sub-Sections are created now, but they are empty. The content must be written now like an usual article.
If you want to change the number or the name of the tabs, you only have to modify the main page project adding or deleting the new tabs (if you delete some tabs, the articles which are linked through them, must be deleted manually).
The project main page belongs to the Project Category by default ( automatically ) and every project section is saved as belonging to the category ProjectSection ( automatically ).
How to protect a project
To protect a project ( to edit ), you have to send an mail ( from your registered email account ) to the wiki, specifying :
1. title.
2. author ( your user ).
3. which users you want to allow editing.
Only authors can do it.
Customizing Categories
How To Add a category to the article
Each article can belong to one or more categories. To add a new category to the article you only have to type[[Category:Name_of_the_category]]to the end of the article.
e.g. :
... Article Body ... [[Category:Mobile]]Only projects and project sections add to them categories
[[Category:Project]]and
[[Category:ProjectSection]]automatically.
Articles Drafts
An user has the possibility to keep their articles in the Drafts Category. When an article belongs to this category, this article is considered an unfinished article. Then, it will not be shown in the lists of articles. When an user has finished writing it must unlink the article from the Drafts Category.
Please, don't modify an Article categorized as Drafts.
What categories are available ?
There are four main categories :
- Project
- HowTo
- OpenSource
- Mobile
... but you can introduce new categories which you think are need.
For example ... you are working in an article concerning the web. You can type:
... Article Body ... [[Category:HowTo]]
... and add :
Body of the article ... Article Body ... [[Category:HowTo]] [[Category:Web]]
You can introduce any Category you think. It can not be in bad taste or concerning any issue not related to technology OpenSource. The management team of the platform reserves the right to remove such content.
How To Use the Wiki Searcher
You can find any open source article or project from this wiki typing the search term into the text box located on the left menu. Also, you can find another open source articles from other sites. It is the external search feature. In both search, you obtain a list of internal/external links to go to the articles/sites.
When you click on the "Go" button, you obtain the article if it exists into the wiki, or a list of links to internal articles / external links in other case. If you click on "Search" you obtain the list directly.
Each one of the search records is compound with the following fields :
- title : This is the title of the record.
- summary : This is a little summary from the article (obtained from the article body)
- another fragments : This part, is a set of little article fragments where the searched term appears.
- url : This is just the article url.
Advanced External Search
When you click on the "Search" button, you obtain a list of links to internal articles / external links. You can made a advanced search clicking on
"To see results from outside TechnologicalWiki, go to External Search".
Then, you can see the last list and a new advanced search form:
- All of the words : All words must be found in the text.
- Exact sentence : The exact sentence must be found in the the text.
- Without the words : None of the words must be found in the text.
- Host : Only it will be shown, the articles belongings from the site.
Interwiki Feature ( BETA )
Remote content can be displayed as local content into an article in this wiki. The target is create a network of wikis. The user can see a set of articles accesing this wiki. ( local & remote articles ). To add a remote content, users can use the interwiki label :<interwiki>
How To configure Interwiki Feature
Combine multiple wikis is a difficult task. Some features in a wiki are not supported in other wikis, and the wiki must be configured to filter the functionality that it can not handle. This feature uses mediawiki API which is used by the platform to receive request from clients ( other wikis or other aplications ). To obtain from a remote wiki, it must allow remote access to its API. An mediawiki API is accessed through an URL.
The Format
<interwiki> Domain=-Remote domain- APIprefix=-api prefif- ( It could be empty, then type an empty string ) Prefix=-wiki prefix- : e.g. : if http://myWiki/wiki/index.php/ArticleName then wiki prefix is wiki Article=-Article name- List=-List of remote templates to filter ( no show )- </interwiki>
An example
<interwiki> Domain=http://en.wikipedia.org APIprefix=w Prefix=wiki Article=Ruby_on_Rails Templates=filter List=Infobox software,Wikibooks,Ruby programming language,Application frameworks </interwiki>
Ruby on Rails : Interwiki Example
You can edit in the remote wiki directly
If the user is seeing an article with remote content, it can edit each article section. If the user clicks on the edit label ( each section ), it is redirected to the edit page of the section of the remote article.
Note : This feature is only a beta version which is still in development. Thus, the operation can sometimes produce unexpected results. Remote Images are not currently supported and these are filtered.
Administration Help Page
This section has been created to know how to manage the wiki. The content in this article is only for Sysop users (administrators).
To access to the Administration Help Page click here
To access to the Administration Portal click here
