Some thoughts and hints for the upcoming Manual

[Myriam Schweingruber]

Hi all,

since the QucikStartGuide is almost done, we can start to think about
the Manual.

The current Table Of Contents is up here:
http://userbase.kde.org/Amarok/Manual. If you plan to work on
something specific, please always come by in #rokymotion on
irc.freenode.net and state what you are working on currently, so
nobody is interfering with your work, if you need guidance, ping
valoriez, Mamarok or Nightrose who usually linger in that channel.
valoriez is in the Pacific Time zone, Mamarok and Nightrose in the
Central European one, see also [1] for time zones.
Please also send a mail to the amarok-promo@ list if you suggest
changes in the Table of Contents or will work on a new page to avoid
duplicate work.

I copied over a few existing pages from the Amarok wiki, but since the
indexes there have sadly not always been updated when new pages were
created, I might have missed some. If you copy over pages, make sure
to clean out all references to Amarok 1.4.x and update the content so
the status reflects the current one as of Amarok 2.3.2

Besides getting familiar with the mandatory typographic guidelines[2]
and wiki basics[3], there are a few things all contributors should
keep in mind:

* The Category:

Please add [[Category:Amarok]] to all pages and in the comments of the
images or other files you upload. This makes it easy to find all
content, especially for sharing images and files. Have a look here to
see the already existing items in the Amarok category:
http://userbase.kde.org/Category:Amarok

* Page navigation:

Add the following navigation template at the bottom of each page, and
update it accordingly when new pages are added:

{{Prevnext2
| prevpage=path/to/article | nextpage=path/to/article
| prevtext=previous section | nexttext=next section
| index= Amarok/Manual | indextext=Back Menu
}}

This adds a nice navigation bar at the bottom, and allows browsing
through the Manual pages quite easily. You can find more information
about it in the template page [4]

* Tags and Templates:

Always add the {{Construction}} tag to all pages that are not
finished. "Finished" means that a page is complete and ready to be
translated, all typographic rules respected.

I also created a new template for Todo: just add {{Todo|<details>}} at
the exact location and it will add a red icon that allows to see Todos
easier. For more information see also [5]

If the content contains code modules, make sure to use the Syntax
highlighting [6]. See [7] as an example. There should usually not be
much code in the User Manual, but let's make the few modules look good
:)


In other words, a new page will look like this:

[[Category_Amarok]]
[[Construction]]

= Header =

Text...
...

*nice navigation bar at the bottom*

And, last but not least, don't forget to add yourself with name and
mail address to the Copyright header of the Manual so we can give you
credit for your work :) I have added what I found so far, but I bet
there are quite some missing names and from most Moodbar section
contributors I only have nicks.

There is big work ahead, let's make this new Amarok Handbook rock !


Regards, Myriam


[1] http://www.timeanddate.com/worldclock/
[2] http://userbase.kde.org/EditMarkup and
http://userbase.kde.org/Typographical_Guidelines
[3] http://userbase.kde.org/Tasks_and_Tools
[4] http://userbase.kde.org/Template:Prevnext2
[5] http://userbase.kde.org/Template:Todo
[6] http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Usage
[7] http://userbase.kde.org/Amarok/Manual/AdvancedFeatures/Moodbar#Moodbar_File_Generation_Script

-- 
Protect your freedom and join the Fellowship of FSFE:
http://www.fsfe.org
Please don't send me proprietary file formats,
use ISO standard ODF instead (ISO/IEC 26300)