Guide lines for wiki contributors - Guy-Dentelle-Neupre/DiBL GitHub Wiki
Do not translate the guidelines for developers nor wiki editors. We need a common language to communicate. The background articles are less important for users of tools.
It appears that translations act as thorough reviews of the original pages. Don't hesitate to question anything. Any feedback leads to improvement of the original wiki pages or even the code.
Feel free to enhance and clarify to improve the project.
The default edit mode for wiki pages on GitHub is markdown. With markdown the web-interface provides help with a toolbar. Many English pages have the mediawiki edit mode. They were imported from the former GoogleCode version of the project. Syntax help is harder to get, but the pages get a TOC for free.
It is possible but not wise to create two pages with identical names. It would cause similar problems as for side bars. For example an "Introduction" page might get the same name in English and French. Extend such a page name to make it unique.
The pages are organized into a folder per language. The web interface does not work with folders. This has a few consequences:
- Creating a new page, renaming a page or changing the edit mode of a page causes a page without a footer and sidebar. Do not create the sidebar or footer.
- You might get the wrong sidebar when trying to edit one. In that case you can get the proper content with the URL's below. Save it with your changes as a new page.
In both cases contributors will receive notifications about your change. They know how to work with a desktop clone and move the changed/new page into the proper folder.
Wiki pages may have a much longer history than the number of revisions suggest. Sadly the web-interface does not provide an easy way to follow that history.
Images are used via a permanent cache. A new version of an images requires a new link.
This is not a even ready recipe for techies, but a reminder. Replace master
in the https://rawgit.com/ URL by the SHA of the commit, or something like that.
Images from the wiki use the path: wiki/jo-pol/DiBL/images/
Images from the code use the path: jo-pol/DiBL/master/