[mb-style] [clean up CSG] Structural concept

[Bogdan Butnaru]

On Feb 8, 2008 1:57 AM, Brian Schweitzer
<brian.brianschweitzer at gmail.com> wrote:
> So, keeping in mind everything we've been talking about, I've been
> quietly rewriting the entire CSG into a clean and (hopefully) clear
> framework, with a step-by-step guideline for how each part
> interrelates and how each part should be integrated with all the
> others.

Wow, huge work.

A few technical notes. They're not urgent, but they might be good
ideas if we ever use your structure for a CSG (indifferent of the
content).

1) In places where you indicate structure, say
http://wiki.musicbrainz.org/BrianFreud/sandbox#CSGmCommonIdentification
or http://wiki.musicbrainz.org/BrianFreud/sandbox#CSGmRoleIdentification
— you use square brackets for some reason. I found it confusing. They
don't appear in the actual example, but it's not clear what they're
doing in the structure. In
http://wiki.musicbrainz.org/BrianFreud/sandbox#CSGspecialWO6 it's even
more confusing, since there is a bracket in the resulting text, thus
there are two brackets in the structure.

You use them to separate elements in a long structure, where I think
it's a bit clearer, but where there is a single element (as above)
that's not obvious.

Since we already have to use a lot of punctuation in the titles, I
think it would be better to refrain from using the same as
meta-syntax. I'm not sure how easy it is in the wiki, but perhaps you
can use typography to separate elements. For instance, you can
alternate between two colors, or between roman and italic, to separate
the structural elements.

See http://wiki.musicbrainz.org/BogdanButnaru/sandbox for some tests.

2) Wherever examples are given — at random,
http://wiki.musicbrainz.org/BrianFreud/sandbox#CSGspecialWO6 — it
would help to have them as links to a release that contains the
tracks, to make it easier to see the examples in context. The release
should be a HQ one, to minimize the risk of it changing after the
example is written.

-- 
Bogdan Butnaru — bogdanb at gmail.com
"I think I am a fallen star, I should wish on myself." – O.