• View
• Edit
• History
• Print

Editing guidelines for gNewSense website pages

This page is not intended to be a definative 'How To' for creating pages, rather it is intended to provide a set of basic guidelines to try and ensure consistancy and thus usability of the wiki.

1. Linking pages into the wiki

There is no hard and fast rule here, but think twice - does this really need to be linked on the front page, or would linking off a sub page make more sense? is this page a general wiki page (link to main wiki), or builder specific page(link to builder wiki)?

• To link to a page in your current section, simply capitalise the text inside two square brackets
• If a page is in a different category on this site, use Category/Pagename inside two square brackets (eg, Profiles/Kgoetz ).
• If your linking to an external site, you will need a full URI, starting with http.

2. Projects

When you start a project, please do at least two of these three things:

• Add it to the table on our Current Projects page, and fill in the details.
• Create a new page in the Projects section and use that page for status updates, and anything you want recoreded publicly.
• (optional) Add it to How To Help, so other people know about the project

3. How to name pages

TODO

4. All pages

When creating a new page please put a header at the top. An easy way to do this is to create an auto-generating table of contents for quick access to other parts of the page.

To auto insert toc (called "On this page") do the following:

• Put at the top of the document
• Put ! in front of every heading
• Put !! in front of every sub heading

When editing a page, please leave a comment/explaination of some sort in the comment field.

Remember, it's GNU/Linux for the whole OS, Linux for just the kernel.

4.1 Documentation pages

Basic description of pages contents, what command does, comments, etc Give the page proper headings - its required to generate the contents list properly. When done, tag the page "Tested with $release" or "Written for $release" somewhere near the top.

5. Profile pages

When you create an account, you are automatically given a page in Profiles. It would be good if on this page you could provide some background information about yourself (a few lines would do), and some information about your involvment/projects, and your relationship with gNewSense. Another good thing to include on this page would be some way to contact you in case someone wants to ask you about a project, or requires help from you.