Csound Csound-dev Csound-tekno Search About

[CSOUND-DEV:5629] Csound Manual - CVS Commit issues

Date2005-01-05 17:31
Fromsteven yi
Subject[CSOUND-DEV:5629] Csound Manual - CVS Commit issues
Hi all,

Is anyone else having problems commiting files to the manual module in 
CVS?  I've made updates and fixes (the entries for Victor's pvs opcodes 
were not valid SGML and were not added to the opcodes/top.sgml) as well 
as have added a copy of the docbook dsssl stylesheets, but none of which 
I can commit. It's strange as I've been able to do commits to the blue 
CVS this morning but not the csound repository. (Is it a permissions thing?)

steven

Date2005-01-05 17:41
FromJohn ffitch
Subject[CSOUND-DEV:5630] Re: Csound Manual - CVS Commit issues
Typo in permissions.
This shoudl be OK now.
==John

On Wed, 5 Jan 2005, steven yi wrote:

> Hi all,
> 
> Is anyone else having problems commiting files to the manual module in 
> CVS?  I've made updates and fixes (the entries for Victor's pvs opcodes 
> were not valid SGML and were not added to the opcodes/top.sgml) as well 
> as have added a copy of the docbook dsssl stylesheets, but none of which 
> I can commit. It's strange as I've been able to do commits to the blue 
> CVS this morning but not the csound repository. (Is it a permissions thing?)
> 
> steven
> 
> 
> 
> 

Date2005-01-05 19:03
Fromsteven yi
Subject[CSOUND-DEV:5631] Re: Csound Manual - CVS Commit issues
Hi John,

Thanks! I'll commit from my home machine tonight and will report back 
here when things are working on Cygwin.

steven

John ffitch wrote:
> Typo in permissions.
> This shoudl be OK now.
> ==John
> 
> On Wed, 5 Jan 2005, steven yi wrote:
> 
> 
>>Hi all,
>>
>>Is anyone else having problems commiting files to the manual module in 
>>CVS?  I've made updates and fixes (the entries for Victor's pvs opcodes 
>>were not valid SGML and were not added to the opcodes/top.sgml) as well 
>>as have added a copy of the docbook dsssl stylesheets, but none of which 
>>I can commit. It's strange as I've been able to do commits to the blue 
>>CVS this morning but not the csound repository. (Is it a permissions thing?)
>>
>>steven
>>
>>
>>
>>
> 
> 
> 
> 

Date2005-01-06 10:23
FromVictor Lazzarini
Subject[CSOUND-DEV:5632] Re: Csound Manual - CVS Commit issues
Should I do something about the pvsbasic opcode documentation?
I don't know SGML, but I can try learning it, if that's the way to go.

Victor

At 19:03 05/01/2005, you wrote:
>Hi John,
>
>Thanks! I'll commit from my home machine tonight and will report back here 
>when things are working on Cygwin.
>
>steven
>
>John ffitch wrote:
>>Typo in permissions.
>>This shoudl be OK now.
>>==John
>>On Wed, 5 Jan 2005, steven yi wrote:
>>
>>>Hi all,
>>>
>>>Is anyone else having problems commiting files to the manual module in 
>>>CVS?  I've made updates and fixes (the entries for Victor's pvs opcodes 
>>>were not valid SGML and were not added to the opcodes/top.sgml) as well 
>>>as have added a copy of the docbook dsssl stylesheets, but none of which 
>>>I can commit. It's strange as I've been able to do commits to the blue 
>>>CVS this morning but not the csound repository. (Is it a permissions thing?)
>>>
>>>steven
>>>
>>>
>>>
>>

Victor Lazzarini
Music Technology Laboratory
Music Department
National University of Ireland, Maynooth 

Date2005-01-06 17:06
Fromsteven yi
Subject[CSOUND-DEV:5634] Re: Csound Manual - CVS Commit issues
Hi Victor,

For the entry itself, Michael's advice is correct and probably best to 
copy an existing entry and use as a template. You can think of Docbook 
SGML as being like XML, so just be sure to close any tag you open. 

As for incorporating the entry into the manual, there's a few things 
more you would need to do.

1)Add the entry as an entity in manual.sgml.  For example, if you put 
the pvsbasic.sgml in the opcodes directory, then this entry should be 
the one to add in manual.sgml



2)Add the entry to opcodes/top.sgml .  This will actually add the entry 
to the reference manual.  The entries are alphabetically ordered, so 
just find where your opcode should be in the list and add:

&opcodespvsbasic;

The above uses the entity that was defined in the manual.sgml file. 
(Think of it like an #include)

3)After that, you'll probably want to find the section headers where the 
opcode should be cross-referenced from.  For example, pvsbasic should 
probably be categorized with the other pvs opcodes in 
spectral/realtime.sgml as:

pvsbasic

The linkend attribute above points to a docbook ID.  The "pvsbasic" ID 
should be defined in the pvsbasic.sgml, probably to be done at the top 
level like this:



Repeat step 3 for any sections you think this opcode should be 
categorized in.

Hope that helps!
steven


Victor Lazzarini wrote:

> Should I do something about the pvsbasic opcode documentation?
> I don't know SGML, but I can try learning it, if that's the way to go.
>
> Victor