[Csnd] Error in Manual
Date | 2010-12-24 05:43 |
From | Jim Aikin |
Subject | [Csnd] Error in Manual |
I've just spent the past half hour chasing my tail because of an error in the manual. The page for tablew quite specifically includes i-rate write operations. But this is not correct. The opcode to use for i-rate write operations is tableiw. I do hope this will be fixed in the next release, as it's got me feeling a bit grumpy right at this particular moment. If it weren't for the online Booki manual, I might never have figured it out. --Jim Aikin |
Date | 2010-12-24 15:47 |
From | Aaron Krister Johnson |
Subject | [Csnd] Re: Error in Manual |
Wow, that must have been $%^&ing annoying!!!! It would be a good idea to do a fine search through the entire manual with a team of volunteers to check for errors. Unfortunately, there's no guarantee that small hard-to-detect errors can be found until folks start messing around with examples, as you did..... One would hope that this kind of thing would be figured out by now. This shows one of three possibilities: 1) Certain opcodes are rarely used, so manual errors are not found until they *are* used, and in depth. 2) Csound has such a small user base compared to say commercial packages, that it takes a while for such manual errors to be discovered. 3) People that use Csound rarely read or check the manual, because they are fluent in the opcodes they use (less likely for me---I've used it for years, and I rarely use it without checking the manual) In short, I think the manual is *crucial* to Csound. Perhaps the most crucial aspect, because it is such a massive and powerful program with tons of opcodes. Poor documentation can literally ruin the experience of using this fine software. While we are on the topic, I have to say that certain parts of the manual are very ambiguous and unclear. For example, from "soundin.html": ifilcod -- integer or character-string denoting the source soundfile name. An integer denotes the file soundin.filcod; a character-string (in double quotes, spaces permitted) gives the filename itself, optionally a full pathname. If not a full path, the named file is sought first in the current directory, then in that given by the environment variable SSDIR (if defined) then by SFDIR. See also GEN01. First, soundin.filcod means nothing to me, especially since it seems to be referred to as 'ifilcod' and sometimes as 'filcod'. A beginner might be confused by such a distinction, esp if they are not yet an expert on i-,k-,a- variables, etc. An example might clarify.....does this mean "soundin.4" as an example? So, a few extra words in the manual will help hand-hold us through this: "For example, if filcod (ifilcod?) is 4, Csound will look for the file called 'soundin.4' in the current directory, or....yada yada yada" Also, things that might be cryptic acronyms like SSDIR or SFDIR should have hyperlinks to their definition and setup, just as GEN01 has a hyperlink. I've definately had other head-scratching moments in my years of using Csound, due to vague descriptions in the manual. I will for sure keep a more specific list moving forward so that I can make editorial suggestions, and thus help others avoid such traps. :) AKJ On Thu, Dec 23, 2010 at 11:43 PM, Jim Aikin <midiguru23@sbcglobal.net> wrote:
-- Aaron Krister Johnson http://www.akjmusic.com http://www.untwelve.org |
Date | 2010-12-24 16:34 |
From | luis jure |
Subject | [Csnd] Re: Error in Manual |
on 2010-12-23 at 21:43 Jim Aikin wrote: >I've just spent the past half hour chasing my tail because of an error in >the manual. good. thanks to that you detected an error in the manual, and we'll all benefit from that. consider it half hour well spent in returning a little bit to a community that spent thousands of hours developing csound and its documentation. Send bugs reports to the Sourceforge bug tracker https://sourceforge.net/tracker/?group_id=81968&atid=564599 Discussions of bugs and features can be posted here To unsubscribe, send email sympa@lists.bath.ac.uk with body "unsubscribe csound" |
Date | 2010-12-24 17:14 |
From | Jim Aikin |
Subject | [Csnd] Re: Error in Manual |
I'm afraid I can't quite agree, Luis. I'd be happy to spend far more than half an hour working on improving the Csound documentation. (In fact, I corrected a tiny error in the Booki draft manual earlier this week. That's a terrific project, and I hope others are also pitching in to help with it.) But getting stuck and getting frustrated is not a good use of anyone's time. If you scroll down the page for tablew, as I did belatedly this morning, you'll see a big Warning that indicates basically the problem I ran into. And indeed, it's alluded to (in a subtle, oblique way) at the top of the page. So calling it an error in the manual is not 100% correct. The problem lies in how Robin Whittle, who wrote this page 13 years ago, chose to organize it. He organized it in a way that works for the expert, but provides inadequate guidance to the non-expert. Because I'm in the business of explaining technical matters to non-technically-savvy readers, I'm especially sensitive to this sort of thing. A couple of years ago, if memory serves, I asked how someone like me might be able to do some editing of the canonical manual, in order to address issues of this sort. I can't remember by now what I was told, but I don't think the phrase "a stroll in the park" was used. It would be a huge project, and it would need to be done properly. |
Date | 2010-12-24 22:10 |
From | luis jure |
Subject | [Csnd] Re: Re: Error in Manual |
on 2010-12-24 at 09:14 Jim Aikin wrote: >But getting stuck and getting frustrated is not a good use of anyone's >time. i agree with you on this one... unfortunately, i guess most, if not all of us have been frustrated with csound some time or another. things like these tend to happen in projects like csound. free software is not like commercial software but gratis, and users are not customers, but part of the community. and all we have is the result of the voluntary effort of the developers and other contributors. so, to whom was this directed: "I do hope this will be fixed in the next release, as it's got me feeling a bit grumpy right at this particular moment."? i don't know if i can make myself clear. you're a professional writer and i'm not even native speaker of english. so i'll leave it here. happy holidays to all csounders!! best, lj Send bugs reports to the Sourceforge bug tracker https://sourceforge.net/tracker/?group_id=81968&atid=564599 Discussions of bugs and features can be posted here To unsubscribe, send email sympa@lists.bath.ac.uk with body "unsubscribe csound" |
Date | 2010-12-25 00:41 |
From | Jim Aikin |
Subject | [Csnd] Re: Re: Error in Manual |
> free software is not like > commercial software but gratis, and users are not customers, but part of > the community. and all we have is the result of the voluntary effort of > the > developers and other contributors. so, to whom was this directed: "I do > hope this will be fixed in the next release, as it's got me feeling a bit > grumpy right at this particular moment."? Well, I'd fix it myself if I could, but I know of no way to make contributions to the canonical manual. That being the case, I guess the comment was directed to whoever maintains the manual. I do understand that whoever that person is, they may have other priorities. That particular page has been misleading for 13 years now, a fact that might lead us to either of two diametrically opposed conclusions: (a) Maybe it ought to be updated before too much longer, or (b) another year or two won't make any appreciable difference. |
Date | 2010-12-25 06:48 |
From | andy fillebrown |
Subject | [Csnd] Re: Re: Re: Error in Manual |
afaik, Andres Cabrera maintains the manual. He's also the main developer for QuteCsound. He's also a saint of a contributor to Csound in general and sets a great example on how to conduct oneself in an open-source community. He's also a grad student. He's a busy man! The canonical manual's source code can be browsed at http://csound.cvs.sourceforge.net/viewvc/csound/manual/ The tablew opcode's source is at http://csound.cvs.sourceforge.net/viewvc/csound/manual/opcodes/tablew.xml?revision=1.11&view=markup If you don't want to deal with CVS, you can post edited versions of the xml files to csound-devel@lists.sourceforge.net Cheers, ~ andy.f On Fri, Dec 24, 2010 at 7:41 PM, Jim Aikin |
Date | 2010-12-25 10:39 |
From | Andres Cabrera |
Subject | [Csnd] Re: Re: Re: Error in Manual |
Hi Jim, I am currently the maintainer of the manual, but I'm not able to contribute as I have done in the past, but fortunately people like Menno, Francois and Joachim (and surely others as well) have made important contributions recently. Learning to edit the manual is a bit engaged since you must edit a horrible XML document, and you must learn about cvs if you want to be able to publish the changes yourself (you just need to ask John for cvs access). You can learn to do that and then do all the changes yourself, or a great way to contribute, which is very effective since it takes little time for anyone with access to the manual, is sending the detailed corrections to the list, explaining what should be taken out and what should be added, including the new text. I tend to add these corrections quite quickly as opposed to a general suggestion where I need to take some time to look into it, experiment and then write the correction myself. But, that said, if you post a correction, and there is no answer, try posting it again 2 weeks later. You will probably succeed on your second try, when someone will have time to see to it. Cheers, Andres On Sat, Dec 25, 2010 at 12:41 AM, Jim Aikin |
Date | 2010-12-26 00:33 |
From | Jim Aikin |
Subject | [Csnd] Re: Re: Re: Error in Manual |
With respect to the tablew page, I think all that's really needed is to add a sentence to the paragraph at the top. I suggest having this paragraph read as follows: |
Date | 2010-12-26 01:51 |
From | luis jure |
Subject | [Csnd] Re: Re: Re: Re: Error in Manual |
on 2010-12-25 at 16:33 Jim Aikin wrote: >My main interest is in helping newcomers by providing a bit >more guidance here and there -- extra sentences, cleaning up simple >errors, and so on. i think that would be a very valuable contribution indeed. Send bugs reports to the Sourceforge bug tracker https://sourceforge.net/tracker/?group_id=81968&atid=564599 Discussions of bugs and features can be posted here To unsubscribe, send email sympa@lists.bath.ac.uk with body "unsubscribe csound" |
Date | 2010-12-26 09:56 |
From | Andres Cabrera |
Subject | [Csnd] Re: Re: Re: Re: Error in Manual |
Hi Jim, Thanks for that, I'm glad you're willing to tackle the manual. I've now committed the file. I made some changes, particularly since the XML format used in the manual is not the usual web XML, but docbookXML, which is concerned with document structure and meaning rather than document layout (this is the reason why we do the manual this convoluted way, because it allows many useful things (like extraction of opcode lists) ). You can browse the manual's sources here: http://csound.cvs.sourceforge.net/viewvc/csound/ (go to the manual directory, then inside that one you probably want to look first at the opcodes/ directory). Also in that directory you will find the readme file, which explains how to build and contribute to the manual: http://csound.cvs.sourceforge.net/viewvc/csound/manual/readme.txt?revision=1.15&view=markup If you want to download a copy of the manual's sources to your computer you need to install a cvs client (Can anyone suggest a good one for windows?), and run these two lines on the terminal: cvs -d:pserver:anonymous@csound.cvs.sourceforge.net:/cvsroot/csound login cvs -z3 -d:pserver:anonymous@csound.cvs.sourceforge.net:/cvsroot/csound co -P manual Cheers, Andres On Sun, Dec 26, 2010 at 12:33 AM, Jim Aikin |
Date | 2010-12-26 17:09 |
From | Jim Aikin |
Subject | [Csnd] Re: Re: Re: Re: Error in Manual |
I'll need to poke around a little and think about what's practical. To begin with, the instructions in the readme about how to build the manual are far too terse for me to understand them. I'm a musician and a hobbyist programmer, but I've never taken a computer science course, and my knowledge base is riddled with large gaps. I had a look at docbook.org, and frankly, Chapter 1, "Getting Started with Docbook," is written strictly for people who are already thoroughly familiar with Docbook. (As a writer and editor, I find myself thinking, "Why didn't somebody jump up and down on this guy's pointy little head and make him fix this mess???") Unless I can find a thorough, well-written introduction to Docbook available somewhere, I'm sunk. I understand html syntax, that's not an issue, but anything beyond that.... I did find and download a free CVS client for Windows (TortoiseCVS). Apparently some people have problems with it in Windows 7 due to User Account Control ... we'll see what happens with that. I'll install it and have a look. But once I have it, why would I need (as you advise) to run anything from the terminal? Also, the web interface for the Csound list (which I'm using at the moment) hides what it thinks are email addresses in the two terminal command lines you gave, so I can't even read them. Maybe they'll come out okay in the digest, which I receive as email, but I still won't know what to do with them. Why would I need to download the manual's source files? Don't I already have those files on my hard drive? I have the whole manual. Are the source files different from the manual? Sorry to be such a hopeless loser about this. I really would like to help. But I still don't know where to start. --JA |
Date | 2010-12-26 20:13 |
From | joachim heintz |
Subject | [Csnd] Re: Re: Re: Re: Error in Manual |
I think your suggestion is very good. Perhaps we could also add something like "See tableiw for changing the contents of function tables at init-time" for pointing someone who is looking for this feature to the right place. I'm very glad you found the Csound Floss Manual (http://booki.flossmanuals.net/csound/ ) useful and went in to correct and contribute. My hope is that this wiki-platform can become a complement to the Canonical Manual, like: - hard, canonical, expert facts with strict editorship in the Csound Manual - more readable, easy to add and easy to edit information by anyone in the Csound Floss Manual I hope this platform can encourage the participation from everyone in the Csound community, on the basis of the information which is provided by the manual (which is a fantastic document, thanks to Andrés and all the others before him who worked on it). One more suggestion if someone wants to contribute to the manual. I think the "See also" section could have much more links on most of the manual pages. In an ideal case, you should be able to click to the whole opcodes by starting anywhere, coming from one oscillator to others, to table readings, table writings, and so on ... joachim Am 26.12.2010 um 01:33 schrieb Jim Aikin: > > With respect to the tablew page, I think all that's really needed is > to add a > sentence to the paragraph at the top. I suggest having this > paragraph read > as follows: > > |
Date | 2010-12-26 20:51 |
From | Jim Aikin |
Subject | [Csnd] Re: Re: Re: Error in Manual |
After poking around a little, I think I now understand that the xml files are compiled (somehow) to produce the html files in the "published" manual. So if I want to edit a page, I need to download the xml file, edit it, and either use CVS to commit it or email it to someone else so they can do that. I think maybe I can figure out how to use CVS (in its TortoiseCVS incarnation), but I'll certainly need to learn the details of that process from someone who has time to teach it. However, I also have no clue how to edit an XML file. I downloaded and installed a free XML editor (XMLmind XML Editor Personal Edition) ... but its Help file is almost as obscure and impenetrable as the Docbook book. The "Getting Started" page in the Help file for this program just assumes that you know everything already. It also, right at the top, tells you that certain text elements that the program will put in a new file can't be changed. Does that mean the program was designed by idiots, or that those elements will be suppressed in the output, or that I'm choosing the wrong file type to start with? Can anyone suggest how I might go about learning this stuff? --JA |
Date | 2010-12-26 21:33 |
From | luis jure |
Subject | [Csnd] Re: Re: Re: Re: Re: Error in Manual |
on 2010-12-26 at 09:09 Jim Aikin wrote: >I had a look at docbook.org, and frankly, Chapter 1, "Getting Started with >Docbook," is written strictly for people who are already thoroughly >familiar with Docbook. googling for "docbook introduction" gives several links that look like interesting places to start, like A Practical Introduction to DocBook: http://www.ibiblio.org/oswg/oswg-nightly/oswg/en_US.ISO_8859-1/articles/DocBook-Intro/docbook-intro/ another god try could be "docbook tutorial". personally, i never made the effort to learn enough docbook to start a project from scratch, but i don't find it very difficult to modify an existing document. good luck. Send bugs reports to the Sourceforge bug tracker https://sourceforge.net/tracker/?group_id=81968&atid=564599 Discussions of bugs and features can be posted here To unsubscribe, send email sympa@lists.bath.ac.uk with body "unsubscribe csound" |
Date | 2010-12-26 21:33 |
From | Andres Cabrera |
Subject | [Csnd] Re: Re: Re: Re: Error in Manual |
Hi Jim, XML is in fact quite simple (it's just a pain to edit). You have tags like: |
Date | 2010-12-26 22:24 |
From | jpff@cs.bath.ac.uk |
Subject | [Csnd] Re: Re: Re: Re: Error in Manual |
I woul;d (and do) ignore the XML stuff an djust use a tex editor. Personally I use the one-true-editor (emacs).The manual is just text with tweaks. So treat it that way. In th eworst case others will fix.... > > After poking around a little, I think I now understand that the xml files > are > compiled (somehow) to produce the html files in the "published" manual. So > if I want to edit a page, I need to download the xml file, edit it, and > either use CVS to commit it or email it to someone else so they can do > that. > I think maybe I can figure out how to use CVS (in its TortoiseCVS > incarnation), but I'll certainly need to learn the details of that process > from someone who has time to teach it. > > However, I also have no clue how to edit an XML file. I downloaded and > installed a free XML editor (XMLmind XML Editor Personal Edition) ... but > its Help file is almost as obscure and impenetrable as the Docbook book. > The > "Getting Started" page in the Help file for this program just assumes that > you know everything already. > > It also, right at the top, tells you that certain text elements that the > program will put in a new file can't be changed. Does that mean the > program > was designed by idiots, or that those elements will be suppressed in the > output, or that I'm choosing the wrong file type to start with? > > Can anyone suggest how I might go about learning this stuff? > > --JA > -- > View this message in context: > http://csound.1045644.n5.nabble.com/Error-in-Manual-tp3317386p3318906.html > Sent from the Csound - General mailing list archive at Nabble.com. > > > Send bugs reports to the Sourceforge bug tracker > https://sourceforge.net/tracker/?group_id=81968&atid=564599 > Discussions of bugs and features can be posted here > To unsubscribe, send email sympa@lists.bath.ac.uk with body "unsubscribe > csound" > > > > Send bugs reports to the Sourceforge bug tracker https://sourceforge.net/tracker/?group_id=81968&atid=564599 Discussions of bugs and features can be posted here To unsubscribe, send email sympa@lists.bath.ac.uk with body "unsubscribe csound" |
Date | 2010-12-27 08:27 |
From | menno |
Subject | [Csnd] Re: Re: Re: Re: Error in Manual |
another thing that could be linked to in the "See also" section of the manual can be publications from The Csound Journal as found on http://www.csounds.com/journal/ I think this is maintained by Steven Yi. For example when looking at the manual page of wgflute, under See also there can be a link o this article: http://www.csounds.com/journal/issue8/liveFluteSynthesis.html If the "old" Csound Magazine could be made available the same way as The Csound Journal, we can link to these publications as well. menno |
Date | 2010-12-27 11:22 |
From | PINOT Francois |
Subject | [Csnd] Re: Error in Manual |
The jEdit text editor runs on Linux, OS X and Windows (http://www.jedit.org/). It's free software and it has a plugin to handle xml files. Moreover, it can handle encoding and line separators. For the manual, encoding should be UTF-8 and line separators should be unix like (\n). With jEdit, you can configure this, even if Windows boxes use by default latin-1 encoding and (\r\n) line separators. The XML plugin can indicate ill-formed documents and allows you to tidy the document presentation. Regards Francois Le 26/12/2010 21:51, Jim Aikin a écrit : > After poking around a little, I think I now understand that the xml files are > compiled (somehow) to produce the html files in the "published" manual. So > if I want to edit a page, I need to download the xml file, edit it, and > either use CVS to commit it or email it to someone else so they can do that. > I think maybe I can figure out how to use CVS (in its TortoiseCVS > incarnation), but I'll certainly need to learn the details of that process > from someone who has time to teach it. > > However, I also have no clue how to edit an XML file. I downloaded and > installed a free XML editor (XMLmind XML Editor Personal Edition) ... but > its Help file is almost as obscure and impenetrable as the Docbook book. The > "Getting Started" page in the Help file for this program just assumes that > you know everything already. > > It also, right at the top, tells you that certain text elements that the > program will put in a new file can't be changed. Does that mean the program > was designed by idiots, or that those elements will be suppressed in the > output, or that I'm choosing the wrong file type to start with? > > Can anyone suggest how I might go about learning this stuff? > > --JA Send bugs reports to the Sourceforge bug tracker https://sourceforge.net/tracker/?group_id=81968&atid=564599 Discussions of bugs and features can be posted here To unsubscribe, send email sympa@lists.bath.ac.uk with body "unsubscribe csound" |
Date | 2010-12-27 13:00 |
From | andy fillebrown |
Subject | [Csnd] Re: Re: Re: Re: Re: Error in Manual |
Notepad++ is a good xml editor and will probably feel the most "Windows native". http://notepad-plus-plus.org/release/5.8.6 I can put together a quick video next week on how to setup TortoiseCVS and Notepad++ for editing the csound manual. You'll need a Sourceforge login id so John can give you access. --- @John: can I have CVS access? My sourceforge id is "afillebrown". Cheers, ~ andy.f On Sun, Dec 26, 2010 at 5:24 PM, |
Date | 2010-12-27 17:09 |
From | Jim Aikin |
Subject | [Csnd] Re: Re: Re: Re: Re: Error in Manual |
Thanks to all for the suggestions. I already have (and use) Notepad++, so will probably continue to use it. And I agree that there's no need for me to learn every detail of Docbook -- all I need to do is add bits of text to existing files. On the other hand, if that's all I do, I won't be able to view the results. And I may find it difficult to incorporate the cross-links that have been suggested in this thread. In any event, getting access to the repository is probably the first step, and that means learning to use CVS. If doing a video is easy, Andy, then sure, that would be great. But a simple written list of steps might be easier for you. |
Date | 2010-12-28 05:14 |
From | andy fillebrown |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Error in Manual |
Hi Jim, I'll post the instructions here so others can chime in. First, you have to let CVS know you're going to be using SSH for your key by adding CVS_RSH to your system's environment variables. This is similar to setting your PATH variable, but you'll be adding a new variable instead. Take "Computer->Properties->Advanced System Settings->Environment Variables" to show the appropriate dialog box, then press the first "New ..." button. Set "Variable name:" to CVS_RSH Set "Variable value:" to ssh Press "Ok" When that's done, you need to setup an ssh key using puttygen.exe. You can find it in the TortoiseCVS program files folder (ex. C:\Program Files\TortoiseCVS). Run puttygen.exe and click the "Generate" button. While the key is generating you should see a progress bar and a request for you to move your mouse around to generate randomness in the key. Just move the mouse around in the "key" area until it's done. If puttygen succeeds, you should see a section that says "Public key for pasting into OpenSSH authorized_keys file:" and there should be a bunch of gibberish starting with "ssh-rsa" and ending with something like "= rsa-key-20101227", the last 8 digits being the date. Change the "Key comment:" field to "username@shell.sourceforge.net", substituting your Sourceforge login id for "username". Click the "Save private key" button and press "Yes" when it asks you about a password. The filename you choose isn't important, but it's standard to call it "Sourceforge-Shell". It should automatically have a .ppk extension. If everything looks ok, save the file. Now you need to tell Sourceforge about your key. Goto https://sourceforge.net/account/ssh to do this. Copy the entire contents of puttygen's dialog box's "key" area, starting from "ssh-rsa" and ending with "username@shell.sourceforge.net", and paste it into the "Authorized keys" box on the web-page. Press the "Update" button on the web-page. If successful, "Existing keys for this account" should change from zero to one. It will take some time for Sourceforge to synchronize the key so I'll pause here before diving into the actual usage of TortoiseCVS. Let me know if it worked or if something went wrong. Cheers, ~ andy.f On Mon, Dec 27, 2010 at 12:09 PM, Jim Aikin |
Date | 2010-12-29 01:42 |
From | Jim Aikin |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Error in Manual |
Okay, those instructions were perfectly lucid (thanks!), and the process seems to have gone without a hitch. Tomorrow or the next day, I guess we can go to the next step. --JA |
Date | 2010-12-29 19:27 |
From | andy fillebrown |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Re: Error in Manual |
The next step is to checkout the csound manual using TortoiseCVS. Open up Windows File Explorer and create a new directory named "csound". This will contain your local working copy of Csound's manual. Right-click the new directory and select "CVS Checkout". This should bring up the "TortoiseCVS - Checkout Module" window. set "Protocol:" to Secure Shell (:ssh:) -- be careful not to use the one ending in (:ext:). It won't work right on Win7 64 bit. set "Server:" to csound.cvs.sourceforge.net set "Repository folder:" to /cvsroot/csound set "User name": to your Sourceforge login id Press the "Fetch list..." button located towards the lower right of the Checkout Module window. You'll be asked for your Sourceforge password a few times, then a list of Csound's CVS modules should appear. Select the "manual" module and press the "Ok" button at the bottom. You'll be asked for your Sourceforge password again, then it should start downloading a new manual directory into the csound directory you created earlier. If the checkout succeeds, the csound directory you created earlier will contain a manual directory, and it should be lit up with green icons. Generally, a green icon on a file means it's in sync with the main repository -- i.e. you haven't edited it, yet. After you've made some edits, the icon for the file you changed will be orange. You need to "commit" it from your local working copy back to the main Csound repository on Sourceforge. First, update your local working copy (a.k.a. "sandbox" in the TortoiseCVS help files). Open up Windows File Explorer, right-click the csound/manual directory and select "CVS Update". It's a good idea to do this before you start editing files, too, to you keep your local copy in sync with the Sourceforge repository as other people make changes. If there are no conflicts during the update, you can commit your edits. Right-click the csound/manual directory and select "CVS Commit". This will bring up the "Commit" window and show a list of files you've changed. Fill in the comment box describing what you're changing (briefly), then press the "Ok" button. If that succeeds, the main Csound repository will be updated with your edits and everyone else can pull them into their local copies the next time they do a CVS update. If you run into conflicts during the update, they need to be resolved before you can commit. Resolving conflicts isn't hard and they're usually few and far between if you update your local copy regularly. You may want to read the TortoiseCVS help file for more on this. --- You'll screw something up eventually, but don't worry about it. It can always be fixed one way or another. If you have questions, feel free! Cheers, ~ andy.f On Tue, Dec 28, 2010 at 8:42 PM, Jim Aikin |
Date | 2010-12-30 01:14 |
From | Jim Aikin |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Re: Error in Manual |
I seem to have succeeded on the first try ... or maybe not. At some point I got a message from Tortoise saying: cvs [checkout aborted]: cannot rename file CVS/Entries.Backup to CVS/Entries: Bad address In spite of this, the opcodes directory, which is the only one I'm concerned about at the moment, seems to have everything in it, and there's a green circle with a yellow check next to each filename. At this point I guess I'll have a stroll through the manual, see if I can spot a couple of things that could benefit from editing, make some edits, and try committing them. I'll let you know when I've done that, and maybe you can check whether it's working. Windows did ask whether I wanted to commit something or other to the Registry. I said no this time, but I'll probably say yes next time. |
Date | 2010-12-30 11:02 |
From | andy fillebrown |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Re: Re: Error in Manual |
Great! I don't know what the Bad address error is about, but it sounds like it worked. Cheers, ~ andy.f On Wed, Dec 29, 2010 at 8:14 PM, Jim Aikin |
Date | 2011-01-02 14:25 |
From | andy fillebrown |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Re: Re: Error in Manual |
For anyone interested, I've uploaded a zip file that simplifies building individual xml files from the manual's source code. It's at http://csound.sourceforge.net/files/build-individual-csound-manual-xml.zip It's for Windows only. See the readme.txt for instructions, and let me know if it doesn't work for you, please. Cheers, ~ andy.f On Thu, Dec 30, 2010 at 6:02 AM, andy fillebrown |
Date | 2011-01-04 14:37 |
From | Andres Cabrera |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Re: Re: Re: Error in Manual |
Attachments | docbook.sh |
Hi Andy, This is quite useful. I've made a version of this script which should work on linux, OS X and other *NIX platforms. Cheers, Andres On Sun, Jan 2, 2011 at 2:25 PM, andy fillebrown |
Date | 2011-01-04 15:03 |
From | Steven Yi |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Error in Manual |
Perhaps this should be committed to the manual CVS repository? On Tue, Jan 4, 2011 at 9:37 AM, Andres Cabrera |
Date | 2011-01-04 15:20 |
From | andy fillebrown |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Error in Manual |
The zip file I uploaded to csound.sourceforge.net contains binaries for xsltproc. Is putting it in cvs ok? ~ af On Tue, Jan 4, 2011 at 10:03 AM, Steven Yi |
Date | 2011-01-04 15:36 |
From | Steven Yi |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Error in Manual |
I don't think putting binaries is a good idea. Andres' script should work on Windows with MSYS or Cygwin, yeah? On Tue, Jan 4, 2011 at 10:20 AM, andy fillebrown |
Date | 2011-01-04 16:01 |
From | andy fillebrown |
Subject | [Csnd] Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Re: Error in Manual |
On Tue, Jan 4, 2011 at 10:36 AM, Steven Yi |