| 
  • If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • You already know Dokkio is an AI-powered assistant to organize & manage your digital files & messages. Very soon, Dokkio will support Outlook as well as One Drive. Check it out today!

View
 

Guidelines for wiki contributors

Page history last edited by andrea.ippo 11 years, 9 months ago

This page contains some guidelines every contributor of this wiki should follow to ensure quality and consistency of all contents.

Everybody wants a beatiful wiki, right? :)

 

Where to start

First of all, thank you for contributing. This wiki is run by passionate MusicBee users in their free time, so don't feel like you have to pick up big tasks: even the smallest contribution is very appreciated :)

Ready to go?

The first thing to do to start editing contents it to get an account: go to http://musicbee.pbworks.com/w/request-access  (send your nickname from the MusicBee forums and just a little personal thing why you want to help).

Wait for the Admin (Silasje1) to accept your request and he will give you the right permissions.

Now you can start editing contents.

But where to start?

You have to options:

  1. creating a page for contents that haven't still been treated: in this case, head over to this discussion on the official MusicBee website: getmusicbee.com/forum/index.php?topic=6304 and specify what topics you would like to write about, to prevent others from starting to write about the same topics. It's strongly recommended that you subscribe to that topic if you are contributing to this wiki, since most decisions are discussed and taken there.
  2. editing an existing page: you can start by searching for unfinished contents throughout the wiki by looking for the TODO keyword, or you can enhance or add more contents to a finished page, if you think it's needed. In any case, you can use the history function to restore previous versions of any page.

 

Setup a dedicated MusicBee instance

It is recommended that you setup a separate MusicBee instance you don't care much about. This has two positive effects:

  1. you have every setting to the defaults, including the default skin, which is better for documentation purposes
  2. if you mess up with this instance, for example by changing preferences, UI layout, etc you still have your separate MusicBee instance for everyday use, customized the way you like it

The best way to setup a dedicated instance is by following these steps:

  1. TODO (describe portable setup)
  2. TODO

 

Screenshots

Whenever you have to take some screenshots, please be sure to be using the "MusicBee Default" skin with the "Skin Window Borders" option enabled.

This allows for consistency of all the application screenshots throughout the wiki.

 

TODOs

Nobody expects you to finish every content page you started or contributed to.

But if you start something and leave it unfinished, please use the "TODO" text marker to make it noticeable. This allows to look for unfinished content throughout the wiki, and makes it easier for other contributors to have a starting point for joining in.

 

Style and formatting

As of 21/06/2012, it is unknown if this wiki will become MusicBee's official wiki (actually, it seems rather improbable). So please don't dedicate too much time for styling and formatting, since your effort may be partially vain. It's recommended to just use the default headings and some bold and italic text where needed to emphasize the most important pieces of text. Of course you can also use numbered and numbered lists, images and tables, but please don't spend time in changing the default text font or color.

Comments (0)

You don't have permission to comment on this page.