[linux-audio-user] sound card linux documentation wiki+forum site [WAS: Linux audio hardwarem arket research [was: creating a wiki "soundcard experiences" site]]

[MarC]

I've been thinking about all that:

I'd stay with the notation:

LinuxAudio
LA_SoftwareSetup
LA_SoundFonts
LA_SoundCards
LA_SC_Creative_SBAudigyOEM

("_" replaces the usual function of "/" to separate folders(which 
express topics) in static web pages
and the capital letters are used to summarize the name of the topic)

but I don't believe in the pearl engine to find all subpages,
let's do it manually at least at the beginning. it's not so difficult to 
add everytime a link to the page if you always follow the same notation.
furthermore, this engine makes the page load slower and this is not good.

and if you don't like it, staying with this notation you'll be able to 
reactivate the engine afterwards. let's start adding some content and if 
many people start to use it, in the future they'll help us to improve 
these things.


En/na MarC ha escrit:

> En/na Ruth A. Kramer ha escrit:
>
>> MarC wrote:
>>  
>>
>>> I agree with LASCCreative_SBAudigyOEM, but we should display it in
>>> ahuman readable title in the list displayed at LASoundCards (it's
>>> possible to associate a title like "Creative Labs Sound Blaster Audigy
>>> OEM" to "LASCCreative_SBAudigyOEM")
>>>   
>>
>>
>> Currently I have a search automatically create the list of LA pages (and
>> later, LASC pages, which would be (primarily) a list of sound cards. 
>> (See http://twiki.org/cgi-bin/view/Wikilearn/LA_LinuxAudio.)  A typical
>> entry is as follows, with the non-human readable page name
>> (LA_SoundBlasterAudigy) followed by the human readable page title
>> (Creative Labs Sound Blaster Audigy OEM).  (The TWiki software basically
>> (iirc) displays the page name followed by the first ~162 characters of
>> the text of the page, which almost certainly includes the page title.):
>>
>> LA_SoundBlasterAudigy: MarC's comments on the Creative Labs Sound
>> Blaster Audigy, OEM version. If anything is missing, misleading, or
>> whatever, please ...
>> Unless I'm missing something, making the entry display the page title
>> (by, for example) creating a link like [[LA_SoundBlasterAudigy][Creative
>> Labs Sound Blaster Audigy OEM]] would require manual maintenance of the
>> list.  (or someone to modify some parts of the TWiki Perl code and
>> possibly the TWiki meta data)  It may happen some day, but most likely
>> not by me (I'm working on learning Ruby or Python, and then may write
>> something like TWiki only with more askSam type features (and some other
>> stuff)).
>>  
>>
> Perfect, this is fine for me. I also discard manual maintenance, we're 
> all busy and it's better to spend our time putting real content in the 
> pages rather than "executing manually monotonous instructions which 
> doesn't help too much"...
> In the future, we can change this, adding this feature to the engine 
> without modifying the structure of the whole site.
>
>> So, I'd suggest we stick with the automatic format.  If somebody
>> actually wants to maintain a manual list, I'd suggest we keep the
>> automatic list, preferably on the same page, but maybe on another page
>> linked to that page.
>>
>>  
>>
>>> I'm also thinking that it must be very simple for a contributor to a
>>> create a new page for his/her sound card, so we should not make it too
>>> complicated and create a sort of a form to help him/her. Abbreviations
>>> must follow some "universal" logic (but yes, I think that LA for
>>> subpages of Linux Audio and SC for subpages of SoundCards is quite 
>>> logic))
>>>   
>>
>>
>> Very simple is good.  There is some possibility of a form or template,
>> but maybe we'll start with the existing template and a page of
>> instructions.  I use the existing template for all the (new) pages on
>> WikiLearn, and it would be tedious to create a different one for the LA
>> pseudo web.  I'll try to work on a set of instructions, or maybe just
>> start the page, let others add to it in the Wiki way.
>>  
>>
> we can also write "FOR LAZY CONTRIBUTORS: If you don't know how to do 
> it, contact MarcVinyes or RandyKramer to add a new page for your sound 
> card. Send them a draft and they will post it for you.".
>
>> I'm still wrestling (a little) with LaSc vs. LASc vs. LASC as a prefix
>> -- the last lower case letter (at least) helps the first "real" word of
>> the page name stand out more, e.g.:
>>
>> LAScCreative_SBAudigyOEM
>>
>> vs.
>>
>> LaScCreative_SBAudigyOEM
>>
>> vs.
>>
>> LASCCreative_SBAudigyOEM
>>
>> Or, we can put the underbar back in, like:
>>
>> LASC_Creative_SBAudigyOEM
>>
>>  
>>
> I think the syntax must be the same for everything:
> so to create a subpage you can use LASoundCards or LA_SoundCards
>
> but you shouldn't use first LASoundCards and then 
> LASC_Creative_SBAudigyOEM. In my opinion we must be coherent:
> LA_SoundCards and LASC_Creative_SBAudigyOEM
> or
> LASoundCards and LASCCreative_SBAudigyOEM
>
> and well... maybe the first one is more readable and easy to remember.
>
> I don't think it's a good idea to put the last letter in lower case.
> SoundCards -> "SC" is quite logic ("we only write the capital letters 
> to abreviate")
> SoundCards -> "Sc" can be confusing in my opinion
> If you want to distinguish LA from SC I'd prefer "LA_SC"
>
> so finally, the better option may be:
> LA_SoundCards and LA_SC_Creative_SBAudigyOEM
>
> ("_" replaces the usual function of "/" to separate folders in static 
> web pages)
>
>> I'll try to spend a little time today double checking that the underbar
>> doesn't cause problems, or that they are minor.
>>  
>>
> yes take your time to check it! if does cause problems, many doubts 
> commented above will have no sense...
>
>>  
>>
>>>> I'd prefer (I think) LALinuxAudio, which sort of explains the LA 
>>>> prefix
>>>> in the name.
>>>>     
>>>
>>> yes, I think that the main page can even be called LinuxAudio
>>> and only call LA* its subpages.
>>>   
>>
>>
>> That's probably fine too (I'll think on it a little today) -- it does
>> avoid having that page show up on the (automatically generated) list of
>> pages on that page (itself).  (Sorry about the sentence. ;-)
>>  
>>
> yes, I suggested it for this reason.
>
>>  
>>
>>> By the way, do you know how to activate RSS feed in this page? is it
>>> possible?
>>>   
>>
>>
>> It is possible, but I've never done it / don't know how.  Try a search
>> on twiki.org for RSS (maybe Google for [site:twiki.org RSS 
>> activate]). OK, I just tried it, looks like this is the page you want:
>> http://twiki.org/cgi-bin/view/Codev/TWikiSyndication
>>
>>  
>>
> I'll investigate. Thanks for the last link.
>
>> regards,
>> Randy Kramer
>>
>> PS: Again, I'll hold off name changes for a little while, to hear any
>> further comments from you and do some checking / thinking -- renaming
>> and the associated bookkeeping (leaving (recreating) the old page with a
>> link to the new page) is something I prefer not to do very often.
>>
>>
>>
>>  
>>
>
>
>
>