How to edit the wiki

From Ekiga

Jump to: navigation, search
image:Emblem-important.png For security reasons, automatic subscription to the wiki is disabled. To grant access you can either join us on IRC: irc.gnome.org/6667 channel #ekiga or mail me: sevmek * free dot fr Yannick

Here are some guide lines I hope useful to get a general quality for the wiki.

Those are some thoughts I have about this job, anything can be discussed. I ain't no professional and I won't be. Feel free to add your ideas...

Contents

Style

In general, don't use HTML code in the wiki; use the wiki system, RTFM wikimedia.

Keep the whole wiki united in terms of style:

main text

  • Don't write long block text: split it! Give space to your toughts. By spliting it, you'll be able, to reorganize it sometimes, making it more clear to the reader.
  • Sometimes you want to emphasis part of the text:

You can use images and tabulation.

image:Emblem-important.png Is for things the user MUST do, or news we want the visitor to read.
image:Gnome-status.png Advices, things the user MAY want to do (rare cases, optional path to do things,...)

In general don't use those images too much. It is recommanded to use them at top of the line.

  • Command line:
$ cd /somewhere/
  • Ekiga menus: (use Non Breakable SPace and Right ARRow)

Edit → Preferences

  • Software names:
    • If they are usable from command line: gconf-editor
    • If you must use Gnome/Kde/Package manager...: Install gdb
  • table:
Ekiga's numbers
SIPNumber Description
500 Echo test
501 Public conference room from Ekiga.net
501xxxx These rooms are public or private, anyone can join a conference at any time if he choose the right number or you can protect the access with a PIN number.
5011122 french conference room 1122
  • SIP address (h323) use italic:

sip:me@provider.net Dont use italic for a sip number list, use table and regular writting.

  • Instruction to configure device or software (form to fill):

Use a table.

Entry points

At the moment, I consider there is 2 entry points in the wiki:

  • The main page
  • The "Which programs work with Ekiga ?" page.

They are similar for the numbers of hits. As a result, informations we want the visitor to read MUST be on both.

Why this situation?

My guess: try to enter "ekiga msn" or "ekiga google talk" in google... People seems to worry about interoperability...

Personal tools