Style Guide

Any problems with the site? How can we improve KVR?
User avatar
whyterabbyt
Beware the Quoth
27678 posts since 4 Sep, 2001 from R'lyeh Oceanic Amusement Park and Funfair

Post Fri Jan 06, 2006 6:00 am

Is it worthwhile creating a set of style guides for entries? Otherwise we're going to wind up with quite a scrappy-looking

I'd suggest the distortion entry as an example to work from, but I think certain other types of page might be usefully unified because of the commonality they'll have eg

acronyms
synthesis methods
processing methods
terminology
"The bearer of this signature is a genuine and authorised pope."

deleted

Post Fri Jan 06, 2006 7:50 am

DELETED

User avatar
Ben [KVR]
Mr KVR
1301 posts since 23 Oct, 2000 from Newport Pagnell, UK
KVR Audio

Post Fri Jan 06, 2006 8:11 am

Yes, I agree that we should lay down some guidelines.

I've created a home for it at http://www.kvraudio.com/wiki/?id=KVRwikiStyleGuide

I agree about the Distortion page looking good. whyterabbyt, feel free to define the formatting guidelines if you want to. Once they are worked out I'll add a link to the left nav menu in the wiki.

I think a new rule is going to be that plug-ins / hosts shouldn't have a dedicated page in the wiki as they already have a dedicated database page here at KVR. They should only be mentioned in other articles with their names linking either to their KVR page or their official home page. With this in mind I'm going to remove the Reaktor and energyXT pages that have been added. I'll add this info to the rules too.

BTW I've made the KVRwiki front page read-only to all except me as I want to maintain control over the landing page. If we need to add anything extra on there I'll do it.

Perhaps below the AudioLexicon we could have some quick links to the sections you suggest.

User avatar
whyterabbyt
Beware the Quoth
27678 posts since 4 Sep, 2001 from R'lyeh Oceanic Amusement Park and Funfair

Post Fri Jan 06, 2006 10:45 am

I'll try and knock something up. How do you want them done, Ben. You've got a KVRwikiStyleGuide page, but do we want multiple styles (eg KVRwikiStyleGuideforAcronyms), or just one generic one?

And another thought: once a set of style guides has been suitably fleshed out, is it worthwhile locking?
"The bearer of this signature is a genuine and authorised pope."

User avatar
pljones
KVRAF
6560 posts since 8 Feb, 2003 from London, UK

Post Fri Jan 06, 2006 1:00 pm

Ben [KVR] wrote:I think a new rule is going to be that plug-ins / hosts shouldn't have a dedicated page in the wiki as they already have a dedicated database page here at KVR. They should only be mentioned in other articles with their names linking either to their KVR page or their official home page. With this in mind I'm going to remove the Reaktor and energyXT pages that have been added. I'll add this info to the rules too.
Sounds fine. So if I want to write up a page on "sfz format", I'd have a link to SFZ's home page, rather than a wiki entry for it - but the page on "sfz format" itself would be fine (as it's implemented in a number of plugins).

User avatar
Ben [KVR]
Mr KVR
1301 posts since 23 Oct, 2000 from Newport Pagnell, UK
KVR Audio

Post Fri Jan 06, 2006 2:10 pm

whyterabbyt wrote:I'll try and knock something up. How do you want them done, Ben. You've got a KVRwikiStyleGuide page, but do we want multiple styles (eg KVRwikiStyleGuideforAcronyms), or just one generic one?

And another thought: once a set of style guides has been suitably fleshed out, is it worthwhile locking?
Probably just one guide I guess.

I'll lock it once its sorted.

User avatar
Ben [KVR]
Mr KVR
1301 posts since 23 Oct, 2000 from Newport Pagnell, UK
KVR Audio

Post Fri Jan 06, 2006 2:10 pm

pljones wrote:
Ben [KVR] wrote:I think a new rule is going to be that plug-ins / hosts shouldn't have a dedicated page in the wiki as they already have a dedicated database page here at KVR. They should only be mentioned in other articles with their names linking either to their KVR page or their official home page. With this in mind I'm going to remove the Reaktor and energyXT pages that have been added. I'll add this info to the rules too.
Sounds fine. So if I want to write up a page on "sfz format", I'd have a link to SFZ's home page, rather than a wiki entry for it - but the page on "sfz format" itself would be fine (as it's implemented in a number of plugins).
Yup.

eduardo_b
KVRAF
11857 posts since 23 Nov, 2004 from west of east

Post Fri Jan 06, 2006 2:20 pm

whyterabbyt wrote:Is it worthwhile creating a set of style guides for entries? Otherwise we're going to wind up with quite a scrappy-looking
Having created, used and administered style guides for journals and magazines, I can highly recommend doing this for the benefit of readers. Consistency of acronyms and terms really helps minimize confusion and aids comprehension. Style guides can be sort of subjective, though, so agreement among those creating it is helpful in sorting things out.

Or are you referring to appearance rather than content?
We escape the trap of our own subjectivity by
perceiving neither black nor white but shades of grey

User avatar
pljones
KVRAF
6560 posts since 8 Feb, 2003 from London, UK

Post Fri Jan 06, 2006 3:11 pm

On a vaguely related note - I've made "application developer" a WikiWord on the LADSPA page (which, when I'm more sober, I'll probably migrate to match DAW/AU/DSP/etc). The idea was that maybe we'd want to explain to people what an Audio(/DAW/plugin/etc) application developer does and provide links to useful resources. Does that idea go beyond the scope of the Wiki, though?

User avatar
whyterabbyt
Beware the Quoth
27678 posts since 4 Sep, 2001 from R'lyeh Oceanic Amusement Park and Funfair

Post Fri Jan 06, 2006 3:30 pm

eduardo_b wrote:
Or are you referring to appearance rather than content?
0

Both, really. As much consistency as possible.
"The bearer of this signature is a genuine and authorised pope."

User avatar
Ben [KVR]
Mr KVR
1301 posts since 23 Oct, 2000 from Newport Pagnell, UK
KVR Audio

Post Sat Jan 07, 2006 2:53 am

I've added an Acronyms section in the left nav of the Wiki. I could add other "major" section headings here too, such as Synthesis and Processing methods, etc. What do you think?

I'm not convinced we need the Acronyms section though, don't you think it is duplication of the AudioLexicon?

User avatar
Ben [KVR]
Mr KVR
1301 posts since 23 Oct, 2000 from Newport Pagnell, UK
KVR Audio

Post Sat Jan 07, 2006 2:54 am

pljones wrote:On a vaguely related note - I've made "application developer" a WikiWord on the LADSPA page (which, when I'm more sober, I'll probably migrate to match DAW/AU/DSP/etc). The idea was that maybe we'd want to explain to people what an Audio(/DAW/plugin/etc) application developer does and provide links to useful resources. Does that idea go beyond the scope of the Wiki, though?
Not all. Anything like this is most welcome. KVR can be a fairly technical place IMO.

Return to “Site Stuff”