User Tools

Site Tools


How to publish

Introduction - Dokuwiki

Wikipelloche works with the dokuwiki software. It's an open source software, that doesn't need a database (it saves each page as a text file) and it comes with numerous plug-ins that allow us to easily adapt it to our needs (translation, WYSIWYG editor, and so on…).

Among these plug-ins, there is translate (to deal with the different languages of the wiki), ckgedit (to have a nice WYSIWYG editor) and edittable (to make tables full of formulas and figures).

This manual purpose is to give you some hints about the pecularities of this wiki's installation, so you can start to use this tool at its most ! If some points needs (more) informations, feel free to send a mail to wikimaster [at] filmlabs [dot] org

In super super short : when you create new pages, be sure that they are in the english subfolder :en: (see below).

Create your first pages

Your wiki needs to have a start page. As long as it doesn't exist, this link will be red: not_yet_existing_page.

Go on, follow that link and create the page. If you need help with using the syntax you can always refer to the syntax page.

You might also want to use a sidebar. To create it, just edit the sidebar page. Everything in that page will be shown in a margin column on the side. Read our FAQ on sidebars to learn more.

Please be aware that not all templates support sidebars.

Prosemirror text editor

What you see is what you get - WYSIWYG

Pages in Dokuwiki are written with a special syntax, with tags, so you can write bold, italic or underlined.

Hopefully, Prosemirror plug-in allow us to have a WYSIWYG editor, ie. an editor that show directly the texte in bold, in italic, with the good spacing, with which we can edit tables, and so on… Here are some useful fonctionnalities when you contribute to a wiki !

FIXME <todo>How to make links with Prosemirror</todo>

Page naming convention

Page name in English

In order to allow a wide community to contribute to wikipelloche, it is important that anyone can quickly (wiki in Hawaiian !) add his or her discoveries, research, recipe, protocol, and so on… To do so, some of us will prefer to write in their own language, before sharing the information with the rest of the world with translations (made by them or by friends or by anyone in the community).

To do so in wikipelloche, you need to find a way to easily switch between language for the same page/topic, like we are used to while browsing Wikipedia for example. But it's not an easy stuff to build actually ! With dokuwiki, there a way to allow each language pages to evolve at their own path, without the need of one master/reference language, links between same pages in different languages being automatically done.

The counterpart to this functionality is that all pages need to have the same name in the different language folders. Since esperanto is still not the common languages (and definitely not the language used in photo-chemistry research), we'll use the lingua franca of our time, which is … French English. So the page names of every page in each language directory will be in English (with underscores instead of spaces).

This is quite convenient for the English speakers, but it comes with a small counterpart, or responsability : be sure, when you create page, that you are using words and technical terms that are the most widespread in the literature and / or on the web. Thus, you'll help non English speakers to find their way around in the different pages already created on wikipelloche.

Last but not least : some pages may already have been created that suits your need, but in a different language (folder). While browsing the files (in the Link menu or on the sitemap page, below the search box when you are logged in), feel free to check in other folders if you cannot find what you need and copy/paste the chosen name.

By the way, the page name is in English, but the title page will be translated, helping non English speakers to find the page they want (once it's already created, see below).

Create a page

If you have not find a page that can host what you're about to write, you can create a page, being aware of the naming convention of wikipelloche (see above).

To create a page, you create an internal link (see above Create links) that point to a not-yet-existing page. Unlike valid links (in green), the not-yet-valid link will appear in red and underlined. When you click on this red link, you create the page !

To be exact, you'll create the page only if you write at least one word and save it. But don't be shy and write the entire title of the page, following the convention below.

Page title (first line) in your own language

The first line of a wikipelloche should be the page title, written in your own language(a) and with the [Title 1] style ([H] button in the upper tool bar, if nothing is written on the page yet), so it's easier to find out which page is what.(b)

(a) This precision is obviously there for the future translators of this page

(b) When your language is not English.

Insert images

To insert image, click on the [Image] icon . A menu pops up where you select [Browse the server]. A new window opens with two panels. On the left panel, you should select the <images> folder, where you'll find all the images already uploaded. In the right panel, you can upload new image (above) or select already uploaded image (below). When selectin an image, a last pop-up window appears, where you should pay attention to select the last setting about Size : [O] for original size (you can always change the size after).

Change editor size

To change the editor box size, click on the small arrow/triangle in the lower-right corner of the editor. To change the editor size for more than this session only, change the value in the <Editor Height> field (below the save button) : 250px is the default value, 400px is more comfortable.

Add To Do's

You can start writing the documentation ! As writing is a long process, you may want to focus on going with the flow and come back to some parts later (for example for giving more details) : for that, you can add “TO DO notes”, with the following code block :

<todo @someone>Add some details to step 3</todo>

… replacing @someone with your username (or the username of the person that is supposed to do it ;~), for example :

<todo @someone>Add some details to step 3</todo>

You'll then find all the TO DO's here, and also in the sidebar.

en/how_to_publish.txt · Last modified: 2024/02/24 15:44 by maxime