Hi Anthony,

Just a quick note, I've just started on reorganizing the manual.  I
have completed merging the first three sections but now will have to
go in an clean up.  The old Introduction section I think is going to
be removed as it is all out of date or is included in the sections
Michael Gogins wrote for CS5.

I largely agree with everything you wrote but am not sure about the
opcode page.  It does make it easy to hit the manual home page and use
a browser's find capability to find an opcode, but there might be ways
to organize that too.  (I have to look into suppressing subsections on
a case-by-case circumstance versus generally limiting number of
sections to index).

For those who are able to pull the manual from CVS, it'd be great if
you could test here and there and offer up some guidance on the manual
changes.

Thanks,
steven


On 4/10/06, Anthony Kozar <anthonykozar@sbcglobal.net> wrote:
> Thanks for taking this on Steven.  Some reorganization would be very
> welcome.  In a couple of weeks, I should have some time to help with
> correcting the manual.  Until then, here are some thoughts.
>
> Merging Sections I and II into III (or vice versa) sounds great.  Adding the
> tables to the opcode sections also sounds like a great idea.  (This is more
> the way that the old Boothe manual was organized I think).
>
> Does the Quick Reference section have to be updated by hand?
>
> Removing the list of opcodes in the Reference section on the front page
> would be good IMHO.  Just having a list of the subsection links would be
> sufficient with the lists of each reference entry on the subsection pages.
>
> Making the "empty" pages more useful would be nice.  Many of the headings in
> the table of contents link to pages with just a title.  These pages would be
> better if they included a list of links to subsections IMHO.
>
> I wonder whether the following subsections of Reference really shouldn't be
> somewhere else:
>
> The Utility Programs
> Cscore
> Extending Csound
>
> Or at least make then more noticeable somehow?
>
> Maybe the Orchestra and Score subsections of Section III Overview should be
> separated? (Or all of the subsections on groups of opcodes be made
> subsections of "Syntax of the Orchestra" ?)
>
> There used to be a list of the various score events under "Score Statements"
> in the Reference Section.  Clicking on this link still gives a page with no
> list of all available score statements.  The only way to get to the
> individual pages now seems to be with the next and previous links.
>
> The s score event page has not been updated to reflect the new feature of
> specifying an end time.
>
> Anyway to get rid of the repetition of the opcode name at the end of its
> reference entry?  (Or are those there for a reason?)
>
> Well, that's enough thoughts for now ;)
>
> Thanks again.
>
> Anthony Kozar
> anthonykozar AT sbcglobal DOT net
>
>
> Steven Yi wrote on 4/10/06 4:15 PM:
>
> > After this initial organization, I think the opcode sections that
> > currently only list opcodes should be updated to use the format Andres
> > Cabrera introduced for the GEN routines:
> >
> > http://www.csounds.com/manual/html/ScoreGenRef.html
> >
> > where the relevant opcodes for a section are listed in a table with
> > their short information next to it to facilitate better browsing of
> > information.
> >
> > Any feedback on these proposed changes would be appreciated!
>
> --
> Send bugs reports to this list.
> To unsubscribe, send email to csound-unsubscribe@lists.bath.ac.uk
>