Document creation in Neogia wiki : Best Practices
| Work in progress, Page in the course of creation by {{{party}}} |
|
Contents |
Pages creation
If you never work with a wiki, start to read How to write page on MediaWiki (Editor chapter)
First step to creat a new document is internationalisation, to be able to have relationship between page with similar content but different language, and so having little flags for each language available for this page.
Pages Internationalisation
- Always start to creat the reference page with a english name
for ex: English Name
Page name is important because it's the page title default - add the mark out (model) : {{ReferencePage|English Name|English}}
- If you want creat a page in a other language that english
- Creat a new page with a correct name for the language you want :
for ex : Nom Francais
(French Name in french ;-) This name will be the default page title and a correct name increase web search engine referencing - Add to this page the mark out : {{ReferencePage|English Name|Français}} with Français for French, Español for Spanish, ...
- Next step is to link english page to the translate one, to have the little flags
- Creat a new page with the name build with the english one and a language suffix ("/fr" for french, "/es" for spanish) :
for ex: English Name/fr - In this page add a re-direction to the correct name page by insert the mark out :
#REDIRECT [[Nom Français]]
- Creat a new page with the name build with the english one and a language suffix ("/fr" for french, "/es" for spanish) :
- the last step is to clear the page cache system for these pages to vew the flags immediatly, if not, flags will appair after the next modification page validation:
- Load the translate page :
- add in the url (in the url naviguator field) "?action=purge" and enter
- Load the english :
- add in the url (in the url naviguator field) "?action=purge" and enter
- Load the translate page :
- Creat a new page with a correct name for the language you want :
Page Organisation
Next step is to choose how your page will be organize (how many colunms):
Choose the colunm number and type
Each page have some invariant part, like header (logo, menu, ...) and footer, so you can only choose for middle.
If you want use all the page, write you text directy, it's not necessary to read the end of this chapter.
Normaly page without colunm are exception: large image, very long texte, ...
PageLayout Model
It's possible to divide the page with colunm. For this, you need to use the "PageLayout" model : "{{PageLayout|type=XXX|left-template=XXX|right-template=XXX}}" or "{{PageLayout|type=XXX|left-content=XXX|right-content=XXX}}"
PageLayout model parameters
- type : give the number and type of the colunms.
Values available are :- left-column-and-article-and-right-column : 3 colunms
- article-and-right-column : 2 column with a small one in the left (classically for the sub-menu)
- left-column-and-article : 2 column with a small one in the right (classically for advertising or news)
- left-template : page name to include on the left colunm (add ":" on the pageName)
- left-content : text content to include in the left colunm
- right-template : page name to include on the right colunm (add ":" on the pageName)
- right-content : text content to include in the right colunm
How to use
left-column-and-article
Two colunms model : a small one in left + a large one in right
- the first colunm, used for sub-menu or small box
- the second one is for the document
In the document's begining insert with replacing left_page_name by a correct page name or left_colunm_text by a text (with the mediawiki syntax but without the "|" caracters):
{{PageLayout|type=left-column-and-article|left-template=:left_page_name|right-content=}} or {{PageLayout|type=left-column-and-article|left-content=left_colunm_text|right-content=}}
article-and-right-column
Two colunms model : a large one in left + a small one in right
- the first colunm, is for the document
- the second one is used for small box or advertising
In the document's begining insert with replacing right_page_name by a correct page name or right_colunm_text by a text (with the mediawiki syntax but without the "|" caracters):
{{PageLayout|type=article-and-right-column|left-content=|right-template=:right_page_name}} or {{PageLayout|type=article-and-right-column|left-content=|right-content=right_colunm_text}}
left-column-and-article-and-right-column
Three colunms model, the more used : 1 narrow colunm in left + 1 center large colunm for document + 1 right narrow colunm
- the first colunm, used for sub-menu or small box
- the second one is for the document
- the last is used for small box or advertising
In the document's begining insert with replacing left_page_name by a correct page name or left_colunm_text by a text (with the mediawiki syntax but without the "|" caracters) and right_page_name by a correct page name or right_colunm_text by a text (with the mediawiki syntax but without the "|" caracters):
{{PageLayout|type=left-column-and-article-and-right-column|left-template=:left_page_name|right-template=:right_page_name}} or {{PageLayout|type=left-column-and-article-and-right-column|left-content=left_colunm_text|right-content=right_colunm_text}}
Insert Text
You have choose your layout, now you can add some content. Our advice is to say that your document is in progress or need to be read by a second person (a neogia maintainer, for example) to validate it.
Say that this document has to be write
- Insert mark out : [[category:To_Write]]
If you want to see all document waiting to be write go to category:To_Write
Show to the readers the document is In Progress
To show to the readers (or an other writer) that you are currently writing it, we suggest you to add the {{:WorkInProgress | lang=en}} template. This template print a clear message to the reader
Show to the readers the document is waiting for validation
If you want a validation for your text, you should :
- add the check out : [[category:To_Be_Read_Again]]
- add the {{:WorkInProgress_TobeValidated | lang=en}} template to put a explicit message to the potential readers
- write a mail on the mailing list to ask a validation
Page Reference elements
At the end of the page, you should give three point, like this :
object : documentation menu reference language : English authors : xxxxx
- object
- Describe the page goal
- reference language
- indicate which page (in which language) is the more complete. If you make some added (not translation) in a page which is not the main, you should add in the main one, the same added (if you are not able to translate it, in your language). If reference language is not present, english is the default.
- author
- give all people which have contribute to this page, most of the time this point disapair when there are more than two name.
Reusable preset text Box
Some Reusable preset text Box can be insert directly in page. These box are advertising, news, press review, ..., the next list is all the existing box :
Advertising Box
- Advertising model (is used and manage by neogia organisation people)
Text status Template
- Work in Progess (use it with lang parameters, {{:WorkInProgress | lang=en}}
- Work in Progess, waiting for validation (use it with lang parameters, {{:WorkInProgress_TobeValidated | lang=en}}
Neogia info box
- ...
- ...
Slide show naviguation Box
- {{Navigator|linkFirst=linkfirst|linkPrevious=linkPrevious|linkNext=linkNext|linkLast=linkLast|lang=en}} to be insert, in a slide show
