webteam:draft_guidelines
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revisionNext revisionBoth sides next revision | ||
webteam:draft_guidelines [2011/03/22 15:31] – created aatre | webteam:draft_guidelines [2012/04/13 00:18] – [The Wiki is Public] Added back statement about "Recent Changes" feed because a potential link has been found. bshum | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Draft Wiki Guidelines ====== | ====== Draft Wiki Guidelines ====== | ||
+ | Evergreen has [[http:// | ||
+ | Creating articles in the wiki is a collaborative process. After you have written your article others may | ||
+ | |||
+ | * Edit | ||
+ | * Alter | ||
+ | * Adapt | ||
+ | * Add | ||
+ | |||
+ | So don't worry about making your article perfect the first time through. Don't hesitate to add content you think is useful and don't hesitate to make edits where you think you can help. There' | ||
+ | |||
+ | ===== Get an account! ===== | ||
+ | |||
+ | To get a DokuWiki account send a request to < | ||
+ | |||
+ | ===== Posting Guidelines ===== | ||
+ | |||
+ | Here are a few guidelines to keep in mind when using the Evergreen wiki: | ||
+ | * ''' | ||
+ | * ''' | ||
+ | * ''' | ||
+ | * ''' | ||
+ | * ''' | ||
+ | * ''' | ||
+ | |||
+ | ===== The Wiki is Public ===== | ||
+ | |||
+ | Everything in the wiki is public. | ||
+ | |||
+ | Every edit and every new page created goes into the [[http:// | ||
+ | |||
+ | Once it's out there, it's public. | ||
+ | * Technically, | ||
+ | * When you delete content from a page, the original content will still remain in the history for that page. | ||
+ | |||
+ | When you contribute content to the wiki (or edit existing content), there is a small notice that appears on the page stating: | ||
+ | |||
+ | //By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 3.0 Unported// | ||
+ | |||
+ | Since the wiki is a community effort, all contributions must be " | ||
+ | ===== Using the Wiki (How-to) ===== | ||
+ | |||
+ | === Where to start === | ||
+ | |||
+ | Before creating a new page, you should first make sure that a page on your topic does not already exist: | ||
+ | |||
+ | - In the search box in the upper right corner, enter your topic. | ||
+ | - If the exact topic exists, the page will open. | ||
+ | - If there are related pages, you will get a search results page. Check if your topic is in the results. | ||
+ | - If your topic does not exist, choose ''' | ||
+ | |||
+ | === How to edit a page === | ||
+ | |||
+ | If you'd like to change a page. | ||
+ | |||
+ | - Make sure that you are logged in to [http:// | ||
+ | - Click the ''' | ||
+ | - Enter your changes in the box. | ||
+ | - In the ''' | ||
+ | - Click ''' | ||
+ | - Click ''' | ||
+ | |||
+ | Deleting pages: | ||
+ | * Pages can only be deleted by wiki admins. | ||
+ | * Before you request a deletion, think about whether a redirect would be more appropriate. | ||
+ | * Place pages that you would like deleted in the " | ||
+ | * You can also specify the reason by adding ''< | ||
+ | * Please keep in mind that any page added to this category will be permanently deleted. | ||
+ | * Admins will check this category periodically and delete the pages, so don't worry if your page isn't deleted immediately. | ||
+ | |||
+ | === Creating a subpage === | ||
+ | |||
+ | Many sections in th wiki are organized by subtopic, like [[Quality/ | ||
+ | * Make sure you are logged in (and see instructions above for searching before you create a new page) | ||
+ | * In the search box, type Quality/My new page name | ||
+ | * Click " | ||
+ | |||
+ | Please note that to avoid creating orphan pages (that is, wiki pages that no other wiki page links to) it is recommended that you create a page by linking to it first, and then clicking on the link to the non-existent page. For example [[Quality/ | ||
+ | |||
+ | For more information see: [[Help: | ||
+ | |||
+ | ===== IMPORTANT! Namespaces! ===== | ||
+ | |||
+ | If you add new schematics, content, tutorials etc, please make sure you put these in their own namespace. Otherwise you will flood the current namespace and maintaining uploaded files will become a mess for the users. | ||
+ | |||
+ | Usually, when you add a link to a page-to-be, you want to add your own namespace too. | ||
+ | |||
+ | You do this by using colons, and if you start your " | ||
+ | |||
+ | **Example**: | ||
+ | Such a name (inside a normal internal link) would put the page under the Tutorials: | ||
+ | |||
+ | Please please please try to maintain a good namespace structure, it's really hard to correct it when the error already has been made. | ||
+ | |||
+ | More info: [[http:// | ||
+ | |||
+ | ===== Syntax and formatting ===== | ||
+ | |||
+ | First have a look at the [[wiki: | ||
+ | |||
+ | Try to keep formatting as clean as possible. A pages main title heading should be in H1, headings under that H2, headings under H2's should be H3 etc. Don't use horizontal rulers unless necessary (for instance they are not necessary if there' | ||
+ | |||
+ | Example of what a small page could look like, using namespaces for sub pages etc: | ||
+ | |||
+ | < | ||
+ | ====== This is the page ====== | ||
+ | |||
+ | And this is the description of this page, regarding what you can find and add here etc. | ||
+ | Remember to use sub pages, and especially namespaces, where appropriate. | ||
+ | |||
+ | ===== The first section ===== | ||
+ | |||
+ | [[.Another Page: | ||
+ | |||
+ | ===== The second section ===== | ||
+ | |||
+ | [[.Yet Another Page:Yet Another Page]] | ||
+ | </ | ||
+ | |||
+ | ===== Images ===== | ||
+ | |||
+ | You might want to include rather big screenshots within your articles, but having them displayed full size directly inside the article can make things look bad. Fortunately you can resize the image directly within the article. You can also set the alignment of the picture, examples: | ||
+ | |||
+ | Resize to given width: | ||
+ | {{wiki: | ||
+ | And left/ | ||
+ | {{ wiki: | ||
+ | {{wiki: | ||
+ | {{ wiki: | ||
+ | See [[wiki: | ||
+ | |||
+ | ===== Code ===== | ||
+ | You can insert code using the ' | ||
+ | <code c> float a; </ | ||
+ | <code c> | ||
+ | float a; | ||
+ | float b; | ||
+ | a = b * 10 + 2 * sin1(x); | ||
+ | </ | ||
+ | There' | ||
+ | |||
+ | |||
+ | ===== Spell Check ===== | ||
+ | Please spell check your work, either with UK or USA English. | ||
+ | |||
+ | |||
+ | ===== Credit ===== | ||
+ | |||
+ | '' | ||
+ | |||
+ | '' |
webteam/draft_guidelines.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1