Site Conventions

Back to Contributors

There have been some suggestions from DaveCs, FinMan and others that a set of formatting conventions for the site are needed. I agree with this. So throwing open the floor here jump in and add your thoughts on this. Things like how code needs to be formatted for one thing, so as to provide a more seamless experience for the reader. This goes hand in hand with the discussions of how the pages need to be lain out ie. that monster of a table of contents that is out there. Feel free to add an example of what type of formatting that you are talking about on this page so it can be seen rendered and we can kick it around some. Heres the link to formating docs for some inspiration http://wikka.jsnx.com/WikkaDocumentation∞

So far in this page:

- Page Titles
- Back links
- Code blocks
- Using some Color
- Branding (adding a logo to the top right corner)
- Creating categories
- Guiding the user through given steps

Some basic stuff that already seems to be happening.
Page Titles
An h2 heading to start a page off
=====Page Title=====

Page Title

Don't use WikiWords in page titles, put the wikiworks to double quotes so an automatic link is not created.
Back links
A back link right under the page title that links back to the page the current one was linked from.
Back to [[Contributors]]
Back to Contributors
Code blocks
Any code goes in a code block. Could be bash commands, perl, or config file contents.
%%This is just some text in a block%%

This is color syntax hilited as a bash script
%%
#!/bin/bash
#bashrc-private file
#personal additions go in this file
source /etc/prompts
tonka
unset tonka
%%

Using some Color

What type of info needs to hilited with color. Possibly menu related things?
{{color text="Menu->Submenu->choice" c="green"}}
Menu->Submenu->choice

• If it sounds ridiculous someone say so. I was at work and my mind was wandering. okie

Branding

Would it be worth adding a graphic to the top of each page sort of like this.
{{image class="right" url="http://www.digitalsundries.com/data/logos/small_blue_peng.png" link="PCLinuxOS"}} =====Page Title=====
See PclosControlCenter for what it looks like on a page.

Page Title

• Or maybe a small pclos logo? okie

---

Creating Categories

When adding a created page to a category. Check the existing list of categories to see if it fits into one of them before creating a new category. It might be nessary to add a sub category to one of the existing categories. We need to try and keep the number of categories down to a managable number.
&)Thoughts or suggestions about the category layout? Its fairly easy to change it. okie

---

Guiding the user through given steps

How to write the steps for some user actions?
Should some kind of numbering ( 1. , 1) , (1) , etc.) be used or just bullets?
Various ways used now. e.g. see ParTioning and TorrentFiles.
Also should it be indented or not? Or give the freedom to do like it looks best?
Some ideas...