[mb-style] WikiDocs for StyleGuidelines?

[Don Redman]

On Mon, 06 Nov 2006 22:21:11 +0100, Age Bosma wrote:

>>  Would this be worth the work?
>>
>
> I think it will. We have the system in place so why not us it to the  
> fullest. It would sure fit nicely in the current discussion on the forum  
> about changing and improving the RFC/RFV process [1].
>
> I do, however, have a few concerns:
>
> The status of a specific page should be made _very_ clear. The current  
> icon and line of text is far to easy to overlook. I suggest to put a  
> nice box around the status line with a black (#3F3F3F) border and  
> different background colours for each status. I don't know how many  
> possible statuses we are dealing with throughout the wiki but simple  
> colours like green (#99FF99) for 'official', blue (#9999FF) for 'working  
> draft' and red (#FF9999) for 'deprecated' come to mind.
> Can we use templates in our wiki at the moment? If yes than it shouldn't  
> be hard to add or change the status of a page.

What exactly do you mean?
There are some icons that we can use  
<http://moinmoin.wikiwikiweb.de/HelpOnSmileys>

I do no know of any existing Macro that would display a box. I guess with  
some python knowledge it should be easy to create one, though.


> Wiki's tend to become a maze quite fast. Especially when they are used  
> for documentation purposes, like in our case, it's necessary to have a  
> solid structure. I already feel lost in the current wiki pages every now  
> and again ;-)
> To prevent the wiki from becoming a real maze, imo a set of guidelines  
> (...more guidelines...) should be created providing steps to go through  
> for each type of page. The same basically goes for the content structure  
> which should be used for a specific page.

With the CategoryProducts pages, Keschte and me introduced breadcrumbs. We  
could use that for the OSG too.
that would mean to reorganize some pages. E.g. there is a mess between  
StyleGuideline and OfficialStyleGuideline, and I have no idea how to clean  
that up.

> People should not have to knock on too many doors to get something done.  
> When there's a specific group of people who are allowed to add or change  
> something in the wikidocs, you don't want to have to ask them directly  
> by sending them an e-mail or wait for them to come online in the IRC  
> channel. Probably the best way to handle this is to add a ticket to the  
> tracker in a dedicated category when a work is finished. This way the  
> wiki people don't have to be active in every discussion all the time and  
> they can just go through each ticket every now and again.

If you mean us when reorganizing the wiki, then we do not need tickets. We  
just watch each other's steps closely. I have just started to reorganize  
ReleaseAttribute, and would appreciate if someone followed my tracks.

If you mean how changes get wikidocselt (i.e. the revision in WikiDocs is  
raised), then this should be easy. If the person who moderates this  
section of the wiki is subscribed to the page, they get the change emailed  
and can update the transclusion table. Since official *Style pages do not  
change too often, that should be feasible.

   DonRedman

-- 
Words that are written in CamelCase refer to WikiDocs,
the MusicBrainz documentation system.
Go to http://musicbrainz.org/doc/<SomeTerm>
(you might need to transform the term to singular)