Re: proofreading tutorial
Done! /Mats Graham Percival wrote: Mats Bengtsson wrote: I hope you don't mind if I modify the text and remove the current first paragraph under "Windows". Please do. In general, feel free to change anything relating to Windows stuff (installation, font-specific information) and anything in chapter 7. Since I don't have any experience in those areas, I really don't feel qualified to comment on them. Cheers, - Graham -- = Mats Bengtsson Signal Processing Signals, Sensors and Systems Royal Institute of Technology SE-100 44 STOCKHOLM Sweden Phone: (+46) 8 790 8463 Fax: (+46) 8 790 7260 Email: [EMAIL PROTECTED] WWW: http://www.s3.kth.se/~mabe = ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Mats Bengtsson wrote: I hope you don't mind if I modify the text and remove the current first paragraph under "Windows". Please do. In general, feel free to change anything relating to Windows stuff (installation, font-specific information) and anything in chapter 7. Since I don't have any experience in those areas, I really don't feel qualified to comment on them. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Sorry to come back to this one, but I just noticed that the current text on Windows in "Compiling a file" isn't really coherent, since it first mentions "start-up a text editor" and then later describes how to do the same thing with the text editor bundled with LilyPond. I hope you don't mind if I modify the text and remove the current first paragraph under "Windows". /Mats Graham Percival wrote: Mats Bengtsson wrote: Some more information that might be worth adding already in the tutorial (again specifically for Windows): Thanks, I did all these updates. Finally, it's probably a good idea to add a footnote with a link to some overview of different text editors, since the one supplied with LilyPond on Windows and probably also on Mac is fairly rudimentary. This should replace the current footnote 1. I have a link to our page about Editors in the manual. I'd like to remove that section and have a web page for this, but this requires a user with basic HTML skills to produce such a web page. Cheers, - Graham -- = Mats Bengtsson Signal Processing Signals, Sensors and Systems Royal Institute of Technology SE-100 44 STOCKHOLM Sweden Phone: (+46) 8 790 8463 Fax: (+46) 8 790 7260 Email: [EMAIL PROTECTED] WWW: http://www.s3.kth.se/~mabe = ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Such an overview of different editors, should of course also mention the simple text editors included in the LilyPond distribution for Mac and Windows. /Mats Graham Percival wrote: Bertalan Fodor wrote: Ok, I'm happy to do this. But what should I write about emacs, vim etc? Should I write about configuration, or link to the manual? I don't know. How about you start with the info currently in the manual (then nobody can complain that we're deleting info). If you think there's anything appropriate to add, do so. Having said that, I don't think you need to link to the manuals. Mention that you can set up lilypond-mode in emacs (or whatever it is) and syntax highlighting in vim, add a link to the INSTALL that explains how to do this, and then move on to lilypondtool. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel -- = Mats Bengtsson Signal Processing Signals, Sensors and Systems Royal Institute of Technology SE-100 44 STOCKHOLM Sweden Phone: (+46) 8 790 8463 Fax: (+46) 8 790 7260 Email: [EMAIL PROTECTED] WWW: http://www.s3.kth.se/~mabe = ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Mats Bengtsson wrote: \chords {...} is just a shorthand for \new ChordNames \chordmode {...} just as \figures{...} is a shorthand for \new FiguredBass \figuremode and similarly for \drums and \lyrics. See also http://lists.gnu.org/archive/html/lilypond-devel/2006-04/msg00332.html Without really knowing much about chords, it seems to me that the current text is relevant. Ok. I updated the final example and removed the comments. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Bertalan Fodor wrote: Ok, I'm happy to do this. But what should I write about emacs, vim etc? Should I write about configuration, or link to the manual? I don't know. How about you start with the info currently in the manual (then nobody can complain that we're deleting info). If you think there's anything appropriate to add, do so. Having said that, I don't think you need to link to the manuals. Mention that you can set up lilypond-mode in emacs (or whatever it is) and syntax highlighting in vim, add a link to the INSTALL that explains how to do this, and then move on to lilypondtool. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Mats Bengtsson wrote: Graham Percival wrote: We don't _have_ a webpage about editors. At least, not that I'm aware of. How about Section 13.6 Editor support? That's part of the manual, not the docs. I'd like to remove that section and point to a nice, colorful webpage instead. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
I managed to find out that the comment was added by Han-Wen in the patch http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=commitdiff;h=b1b62afbf96285ebd4d4406e21dee15f43366bad I don't really understand the comment, since the revision indeed added the use of \chords. \chords {...} is just a shorthand for \new ChordNames \chordmode {...} just as \figures{...} is a shorthand for \new FiguredBass \figuremode and similarly for \drums and \lyrics. See also http://lists.gnu.org/archive/html/lilypond-devel/2006-04/msg00332.html Without really knowing much about chords, it seems to me that the current text is relevant. /Mats Graham Percival wrote: The whole section 2.4.2 is the only one I didn't change. At the top of the source for this section, I saw this: @c TODO: revise this, \chords { } is shorter and more intuitive. but I'm not certain what it means. (I know even less about chords than I do about vocal music!) Does anybody want to rewrite 2.4.2 (or simply vouch for the current correctness) ? AFAIK, the current 2.4.2 was written back in the 1.2 or 1.4 days. Now, this info presented might still be correct, or it may be out of date and confusing. I just need somebody who uses chords who can look at this section and let me know. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel -- = Mats Bengtsson Signal Processing Signals, Sensors and Systems Royal Institute of Technology SE-100 44 STOCKHOLM Sweden Phone: (+46) 8 790 8463 Fax: (+46) 8 790 7260 Email: [EMAIL PROTECTED] WWW: http://www.s3.kth.se/~mabe = ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Graham Percival wrote: We don't _have_ a webpage about editors. At least, not that I'm aware of. How about Section 13.6 Editor support? /Mats ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Ok, I'm happy to do this. But what should I write about emacs, vim etc? Should I write about configuration, or link to the manual? Bert So spend 30 minutes and create a general editor webpage for lilypond. If you omit emacs or vim you'll probably have a riot, but you only need one paragraph about each. Then go ahead an have beautiful screenshots and religious text pushing lilypondtool for the rest of the page. - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Bertalan Fodor wrote: Well, we have a webpage about at least one quite good editor: http://lilypondtool.organum.hu ;-) So spend 30 minutes and create a general editor webpage for lilypond. If you omit emacs or vim you'll probably have a riot, but you only need one paragraph about each. Then go ahead an have beautiful screenshots and religious text pushing lilypondtool for the rest of the page. - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Well, we have a webpage about at least one quite good editor: http://lilypondtool.organum.hu ;-) Graham Percival írta: Bertalan Fodor wrote: I don't think it should be in the manual at all; I'd prefer this info to be on the webpages. Ok, but the link to the webpage about editors should be at an emphasized place in the doc. We don't _have_ a webpage about editors. At least, not that I'm aware of. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Bertalan Fodor wrote: I don't think it should be in the manual at all; I'd prefer this info to be on the webpages. Ok, but the link to the webpage about editors should be at an emphasized place in the doc. We don't _have_ a webpage about editors. At least, not that I'm aware of. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
I don't think it should be in the manual at all; I'd prefer this info to be on the webpages. Ok, but the link to the webpage about editors should be at an emphasized place in the doc. Bert ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Mats Bengtsson wrote: Some more information that might be worth adding already in the tutorial (again specifically for Windows): Thanks, I did all these updates. Finally, it's probably a good idea to add a footnote with a link to some overview of different text editors, since the one supplied with LilyPond on Windows and probably also on Mac is fairly rudimentary. This should replace the current footnote 1. I have a link to our page about Editors in the manual. I'd like to remove that section and have a web page for this, but this requires a user with basic HTML skills to produce such a web page. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Bertalan Fodor wrote: Finally, it's probably a good idea to add a footnote with a link to some overview of different text editors, since the one supplied with LilyPond on Windows and probably also on Mac is fairly rudimentary. This should replace the current footnote 1. I don't think it should be a footnote. Using an editor should be a preferred way, and information on editors should be emphasised. I don't think it should be in the manual at all; I'd prefer this info to be on the webpages. Info about editing environments and GUI front-ends is excellent material for webpages: you can have screenshots, links, and the info can change quickly. I know that we _can_ add all those things to the manual, but I'd rather not have flashy colorful screenshots in there. Besides, such info gets stale really quickly. If somebody prints out the 2.10.0 manual (and some people _do_), then the notation chapters can be useful for years to come. But I'm sure that LilyPondTool will be much better in two years' time than it is now. A webpage about editing environments is on the current "help wanted" list. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Finally, it's probably a good idea to add a footnote with a link to some overview of different text editors, since the one supplied with LilyPond on Windows and probably also on Mac is fairly rudimentary. This should replace the current footnote 1. I don't think it should be a footnote. Using an editor should be a preferred way, and information on editors should be emphasised. Bert ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Graham Percival wrote: Mats Bengtsson wrote: - The instructions for Windows need some polishing. Basically, you could more or less the same as on Mac, namely double-click the LilyPond icon on the desktop to start a simple text editor. I can come back with more details when I have a Windows box in front of me. Thanks, I don't have access. Here we go (everything below applies to "2.1.1 Compiling a file") "If you double-click in the LilyPond icon on the Desktop, it will open a simple text editor with an example file. Save it, for example, to test.ly on your Desktop, and then double-click on the file to process it. After some seconds, you will get a file test.pdf on your desktop. Double-click on this PDF file to view the typeset score. An alternative method to process the test.ly file is to drag and drop it onto the LilyPond icon using your mouse pointer." Actually, the example file opened in the text editor contains full instructions on how to save, process and view the example, so one alternative is to not repeat the information in the Tutorial but to just refer to these instructions (which gives one place less to update the information if it needs to be modified). The only new information I added in the text above, was that you can double-click a file to process it instead of dragging it onto the LilyPond icon. Some more information that might be worth adding already in the tutorial (again specifically for Windows): "To edit an existing .ly file, right-click on the file and select "Edit source ...". " And something that probably is relevant both for Windows and Mac: "Double-clicking the file to process it, does not only result in a PDF file, but also a .log file that contains some information on what LilyPond has done to the file and if any problems were found in the file. " Finally, it's probably a good idea to add a footnote with a link to some overview of different text editors, since the one supplied with LilyPond on Windows and probably also on Mac is fairly rudimentary. This should replace the current footnote 1. /Mats ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Alard de Boer wrote: The tutorial is great! Some minor comments: 2.1.1 second footnote: These easiest -> The easiest 2.1.1 Section MacOS X, 2nd par: lilypond -> LilyPond (all other uses except the Unix command line have the two capital letters) 2.3.1 3rd paragraph: means that are -> means that they are 2.3.1 4th par: same time simple -> same time simply 2.3.1 5th par: maybe add "Also note that each note is relative to the previous one in the input, and not relative to the c'' in the \relative function." 2.3.1 6th par: exression -> expression 2.3.5 2nd par: angled -> angle 2.4.1 the lyrics are longer than the music, so there are no notes for "free" in the 2nd example or "free __" in the 3rd > 2.5.4 2nd par: Identifiers -> With identifiers > > 2.5.4 4th par: should have -> must have (or are non-alphabetic > characters allowed?) Thanks, all updated. 2.4.2 the last example contains a comment for yourself (-gp); also you use \relative without a pitch here for the first time, which should be explained (or changed to use a pitch) Whoops, I should have added a "FIXME"... I didn't find this comment when I was clearing up the FIXMEs. The whole section 2.4.2 is the only one I didn't change. At the top of the source for this section, I saw this: @c TODO: revise this, \chords { } is shorter and more intuitive. but I'm not certain what it means. (I know even less about chords than I do about vocal music!) Does anybody want to rewrite 2.4.2 (or simply vouch for the current correctness) ? AFAIK, the current 2.4.2 was written back in the 1.2 or 1.4 days. Now, this info presented might still be correct, or it may be out of date and confusing. I just need somebody who uses chords who can look at this section and let me know. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
On 23/01/07, Graham Percival <[EMAIL PROTECTED]> wrote: The rewritten tutorial is online, http://lilypond.org/doc/v2.11/Documentation/user/lilypond/Tutorial Could a few people proofread it? In the near future the translation teams will be working on it, so it would be good if we finalized node names and caught any major mistakes. The tutorial is great! Some minor comments: 2.1.1 second footnote: These easiest -> The easiest 2.1.1 Section MacOS X, 2nd par: lilypond -> LilyPond (all other uses except the Unix command line have the two capital letters) 2.3.1 3rd paragraph: means that are -> means that they are 2.3.1 4th par: same time simple -> same time simply 2.3.1 5th par: maybe add "Also note that each note is relative to the previous one in the input, and not relative to the c'' in the \relative function." 2.3.1 6th par: exression -> expression 2.3.5 2nd par: angled -> angle 2.4.1 the lyrics are longer than the music, so there are no notes for "free" in the 2nd example or "free __" in the 3rd 2.4.2 the last example contains a comment for yourself (-gp); also you use \relative without a pitch here for the first time, which should be explained (or changed to use a pitch) 2.5.4 2nd par: Identifiers -> With identifiers 2.5.4 4th par: should have -> must have (or are non-alphabetic characters allowed?) -- Groeten, Alard. Ceterum censeo MS Word esse delendam. ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Mats Bengtsson wrote: - The cut-&-pastable-section of the first example contains lots of lines that are just confusing and should never be included in a stand-alone .ly file. Maybe it's better to not use the fragment option of lilypond-book and recommend the reader to only cut the lines after "ly snippet follows" (or whatever it says when you don't use the fragment option). Ah, oops. I made a special policy of @ignore Tutorial guidelines: - unless you have a really good reason, use either @l ilypond[quote,ragged-right,verbatim] or @l ilypond[quote,ragged-right,verbatim,fragment,relative=2] (without spaces) Don't use any other relative=X commands (make it a non-fragment example), and don't use fragment without relative=2. but I forgot to fix the very first example. I've fixed that now. - There's a new paragraph before "to the end of the file". - In "2.1.1 Compiling a file", there's a typo in "should be also be". Thanks, fixed. - The instructions for Windows need some polishing. Basically, you could more or less the same as on Mac, namely double-click the LilyPond icon on the desktop to start a simple text editor. I can come back with more details when I have a Windows box in front of me. Thanks, I don't have access. - In "2.1.1 Compiling a file", footnote 3: "have any tools" -> "have any such tools". Fixed. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
Re: proofreading tutorial
Thanks for all your ambituous documentation updates! I've just looked at the first few pages, but have a couple of comments: - The cut-&-pastable-section of the first example contains lots of lines that are just confusing and should never be included in a stand-alone .ly file. Maybe it's better to not use the fragment option of lilypond-book and recommend the reader to only cut the lines after "ly snippet follows" (or whatever it says when you don't use the fragment option). - There's a new paragraph before "to the end of the file". - In "2.1.1 Compiling a file", there's a typo in "should be also be". - The instructions for Windows need some polishing. Basically, you could more or less the same as on Mac, namely double-click the LilyPond icon on the desktop to start a simple text editor. I can come back with more details when I have a Windows box in front of me. - In "2.1.1 Compiling a file", footnote 3: "have any tools" -> "have any such tools". /Mats Graham Percival wrote: The rewritten tutorial is online, http://lilypond.org/doc/v2.11/Documentation/user/lilypond/Tutorial Could a few people proofread it? In the near future the translation teams will be working on it, so it would be good if we finalized node names and caught any major mistakes. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel -- = Mats Bengtsson Signal Processing Signals, Sensors and Systems Royal Institute of Technology SE-100 44 STOCKHOLM Sweden Phone: (+46) 8 790 8463 Fax: (+46) 8 790 7260 Email: [EMAIL PROTECTED] WWW: http://www.s3.kth.se/~mabe = ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel
proofreading tutorial
The rewritten tutorial is online, http://lilypond.org/doc/v2.11/Documentation/user/lilypond/Tutorial Could a few people proofread it? In the near future the translation teams will be working on it, so it would be good if we finalized node names and caught any major mistakes. Cheers, - Graham ___ lilypond-devel mailing list lilypond-devel@gnu.org http://lists.gnu.org/mailman/listinfo/lilypond-devel