Issue 4636082: an example of minimal example (Closed)
|
Created:
12 years, 9 months ago by Janek Warchol Modified:
12 years, 9 months ago Reviewers:
james.lowe, Graham Percival (old account), colinpkcampbell, mail, Graham Percival, pkx166h, carl.d.sorensen CC:
lilypond-devel_gnu.org Visibility:
Public. |
Descriptionan example of minimal example
for some people it's not clear enough how tiny
a tiny example should be. So i used a recently
discussed example to illustrate it.
Patch Set 1 #Patch Set 2 : hint: attach images showing desired output #Patch Set 3 : change wording about tiny ex #
Total comments: 9
Patch Set 4 : moving things to a box at the bottom #
Total comments: 31
Patch Set 5 : fix indent and change { } to @{ @} #Patch Set 6 : ignore previous patch set, i forgot to pull #Patch Set 7 : include some of James' suggestions #
Total comments: 4
Patch Set 8 : graham's sugggestion #
Total comments: 8
Patch Set 9 : more graham's suggestions #Patch Set 10 : more graham :) #Patch Set 11 : fix aligning of the example. #
Total comments: 1
MessagesTotal messages: 24
Sign in to reply to this message.
I like this, but I think it should have a little bit more information. I don't think that the changes in the comments affect whether it is minimal or not -- perhaps the comments should be the same in both cases. What we wanted to get rid of is any unnecessary LilyPond input. In this case that means \score, \newStaff, \key d \major, \numericTimeSignature, and \time 2/4. We also got rid of unnecessary notes. Since we were focusing on the ties, we only needed the tied notes. HTH, Carl
Sign in to reply to this message.
We need to be careful about adding stuff to the webpage; perfection is when there's nothing left to remove, not when there's nothing left to add. I'm glad that you're working on it! I'm just warning you that there will be many nitpicks. http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itexi File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itex... Documentation/web/community.itexi:273: A tiny example is an example from which @strong{nothing} can be removed. I'm happy with this change. http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itex... Documentation/web/community.itexi:275: Is the code below a minimal example? This is way too long. I spent a lot of time and effort making the website as minimal as possible to increase readability Hmm... I'd be ok with it if you put it in a box at the bottom of the page. I actually can't believe that we don't have any examples on the Tiny examples page -- the only place to find something is on the Bug reports page! http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itex... Documentation/web/community.itexi:277: @lilypond this won't compile; it would have to be @example instead, and that will require @{ @} escapes. http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itex... Documentation/web/community.itexi:346: using less than a single measure. I prefer "only". If somebody gets it down to 1 measure, we're not going to quibble about 2 beats vs. 4 beats. http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itex... Documentation/web/community.itexi:353: 2 lines of code, and few exceed 10 lines. Hmm. I'm worried that this (combined with the next item) would make the page too wordy. Leave it in there for the next draft, but I may complain about it later.
Sign in to reply to this message.
On 2011/07/04 20:02:59, Carl wrote: > I like this, but I think it should have a little bit more information. > > I don't think that the changes in the comments affect whether it is minimal or > not -- perhaps the comments should be the same in both cases. Imo it's more readable when the comment is briefer. Also the way in wchich it divides the music is distracting for me. thanks, Janek
Sign in to reply to this message.
New patch set uploaded. 2011/7/4 <percival.music.ca@gmail.com>: > I'm glad that you're working on it! I'm just warning you that there > will be many nitpicks. No problem. If they aren't about code style, i can handle them :) http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itexi File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itex... Documentation/web/community.itexi:275: Is the code below a minimal example? On 2011/07/04 20:24:56, Graham Percival wrote: > This is way too long. I spent a lot of time and effort making the website as > minimal as possible to increase readability I had this feeling too. > Hmm... I'd be ok with it if you put it in a box at the bottom of the page. I > actually can't believe that we don't have any examples on the Tiny examples page > -- the only place to find something is on the Bug reports page! Done (at least i hope that it's written correctly). http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itex... Documentation/web/community.itexi:277: @lilypond On 2011/07/04 20:24:56, Graham Percival wrote: > this won't compile; it would have to be @example instead, and that will require > @{ @} escapes. Umm.. is it right now? http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itex... Documentation/web/community.itexi:346: using less than a single measure. On 2011/07/04 20:24:56, Graham Percival wrote: > I prefer "only". If somebody gets it down to 1 measure, we're not going to > quibble about 2 beats vs. 4 beats. Umm, James' original example was exactly one measure, and we condemned it as being too long. 2011/7/4 James Harkins <jamshark70@gmail.com> wrote: > To me, one bar is tiny. And after all, this wording doesn't force people to make examples less then one measure at all costs. It only suggests things. http://codereview.appspot.com/4636082/diff/3/Documentation/web/community.itex... Documentation/web/community.itexi:353: 2 lines of code, and few exceed 10 lines. On 2011/07/04 20:24:56, Graham Percival wrote: > Hmm. I'm worried that this (combined with the next item) would make the page > too wordy. Leave it in there for the next draft, but I may complain about it > later. I moved it to the bottom box, how do you like it?
Sign in to reply to this message.
On 2011/07/04 21:01:44, Janek Warchol wrote: > 2011/7/4 <percival.music.ca@gmail.com>: > > this won't compile; it would have to be @example instead, and that will > require > > @{ @} escapes. > > Umm.. is it right now? why the mao are you asking me? Cut&paste this and tell me yourself: cd build/ make website It either compiles, or it doesn't. > Umm, James' original example was exactly one measure, and we condemned it as > being too long. It was too long in terms of lines of text, not in terms of duration. Or to put it another way: it was too complicated. It had scary stuff like \useNumericTimeSignature. Cheers, - Graham
Sign in to reply to this message.
2011/7/4 <percival.music.ca@gmail.com>: > On 2011/07/04 21:01:44, Janek Warchol wrote: >> Umm.. is it right now? > > why the mao are you asking me? Cut&paste this and tell me yourself: > cd build/ > make website > > It either compiles, or it doesn't. Ooops, sorry... I didn't know that it's possible to compile website separately from all other documentation (which takes a lot of time, according to CG, and i've never done it). I did this, and it compiled. However, when i opened build/out-website/index.html, a black-and white text only page apperared. Does it mean i should do things described in CG 6.3? >> Umm, James' original example was exactly one measure, >> and we condemned it as being too long. > > It was too long in terms of lines of text, not in terms of duration. Or > to put it another way: it was too complicated. It had scary stuff like > \useNumericTimeSignature. ok, i admit this was more non-tinish than the additional notes alone. cheers, Janek
Sign in to reply to this message.
On Mon, Jul 04, 2011 at 11:46:30PM +0200, Janek Warchoł wrote: > 2011/7/4 <percival.music.ca@gmail.com>: > > On 2011/07/04 21:01:44, Janek Warchol wrote: > >> Umm.. is it right now? > > > > why the mao are you asking me? Cut&paste this and tell me yourself: > > cd build/ > > make website > > > > It either compiles, or it doesn't. > > Ooops, sorry... I didn't know that it's possible to compile website > separately from all other documentation (which takes a lot of time, > according to CG, and i've never done it). > I did this, and it compiled. ??? unless I clicked on the wrong draft by mistake, you still had a {, which shouldn't compile. hmm, maybe texi2html can handle it -- but if you try a simple "make", I expect that it will fail. > However, when i opened > build/out-website/index.html, a black-and white text only page > apperared. Does it mean i should do things described in CG 6.3? look at: build/out-website/website/index.html instead. Cheers, - Graham
Sign in to reply to this message.
Hello, my comments inline. James http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:283: The simpler the example is, the quicker potential helpers can The tinier the example, the simpler it is and therefore, the quicker... http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:287: A simple example demonstrates that you have put effort towards A tiny example also demonstrates to others on the email lists that some kind of effort has been taken to... [PS Are we talking 'simpler' or 'tinier' here? While I can see that both work, they are two different ideas and you are already moving away from 'tiny'. Can we stick to tiny?] http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:289: input, it looks like they don't care how if we help them or not. solving the problem yourself. Whereas overly complex, large or unedited examples look like no effort has been made to try to attempt to solve the problem yourself and can discourage others from helping. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:292: Creating a tiny example forces you to understand what is A tiny example can also help you to ... http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:296: insufficient understanding of LilyPond, not an actual bug! ...then the problem is usually due to a lack of understanding of how the LilyPond syntax works. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:305: @subheading How do I create them? How to create them. [we try to not personalise the text or talk in first/second person] http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:311: Include the \version number. Include the LilyPond @code{\version} number you are using. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:314: Make it small! Examples about spacing or page layout might Keep it tiny! Examples about... http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:320: or @code{%@{ @dots{} %@}})} sections of your file. If you can ..or @code{%@{ @dots{} %@}})} sections of your file first. If you can... http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:321: comment something while still demonstrating the main idea, then comment something out while ... http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:322: remove the commented-material! remove the commented material completely from your example. [no need for all the exclamations] http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:325: Avoid using complicated notes, keys, or time signatures, unless ..notes, keys or time signatures, unless... [remove comma] http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:330: is about those particular commands. [I'd use the word 'specific' instead of 'particular' here] http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:334: (how the correct output should look like). If possible, attach a small image file of what you want the correct output to look like as this will help us clarify exactly what the problem is. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:375: quite often 4 lines are enough to demonstrate the problem! [we've already said this above - "Examples about spacing or page layout might require many bars of music, but most issues can be reproduced using less than a single measure" why repeat it (and differently)?]
Sign in to reply to this message.
----- Original Message ----- From: "Janek Warchoł" <lemniskata.bernoullego@gmail.com> To: <lemniskata.bernoullego@gmail.com>; <percival.music.ca@gmail.com>; <james.lowe@datacore.com>; <carl.d.sorensen@gmail.com>; <lilypond-devel@gnu.org>; <reply@codereview.appspotmail.com> Sent: Monday, July 04, 2011 10:46 PM Subject: Re: an example of minimal example (issue4636082) > 2011/7/4 <percival.music.ca@gmail.com>: >> On 2011/07/04 21:01:44, Janek Warchol wrote: >>> Umm.. is it right now? >> >> why the mao are you asking me? Cut&paste this and tell me yourself: >> cd build/ >> make website >> >> It either compiles, or it doesn't. > > Ooops, sorry... I didn't know that it's possible to compile website > separately from all other documentation (which takes a lot of time, > according to CG, and i've never done it). > I did this, and it compiled. However, when i opened > build/out-website/index.html, a black-and white text only page > apperared. Does it mean i should do things described in CG 6.3? That's what I get as well. Providing it's compiled and looks approximately like you want it, you should be OK. -- Phil Holmes
Sign in to reply to this message.
2011/7/5 Graham Percival <graham@percival-music.ca> > > On Mon, Jul 04, 2011 at 11:46:30PM +0200, Janek Warchoł wrote: > > 2011/7/4 <percival.music.ca@gmail.com>: > > > On 2011/07/04 21:01:44, Janek Warchol wrote: > > >> Umm.. is it right now? > > > > > > why the mao are you asking me? Cut&paste this and tell me yourself: > > > cd build/ > > > make website > > > > > > It either compiles, or it doesn't. > > > > Ooops, sorry... I didn't know that it's possible to compile website > > separately from all other documentation (which takes a lot of time, > > according to CG, and i've never done it). > > I did this, and it compiled. > > ??? > unless I clicked on the wrong draft by mistake, you still had a {, > which shouldn't compile. Ah, i see now. I should've changed all { to @{ and } to @}. I understood what you meant when i saw the code of example bug report. Done. > > However, when i opened > > build/out-website/index.html, a black-and white text only page > > apperared. Does it mean i should do things described in CG 6.3? > > look at: > build/out-website/website/index.html > instead. It's almost like our website - only misses graphics and shading on menu bars. But i don't suppose it's because of anything i did. Thanks! Janek
Sign in to reply to this message.
New patch set uploaded. I have a problem with the box at the bottom: code examples are center-aligned, not left-aligned. I didn't found any example of how it's done in our manuals; i searched texinfo documentation and found @flushleft, but it didn't work... How should i do this? http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:283: The simpler the example is, the quicker potential helpers can On 2011/07/05 00:14:30, J_lowe wrote: > The tinier the example, the simpler it is and therefore, the quicker... I'm not sure if this is straightforward enough. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:287: A simple example demonstrates that you have put effort towards On 2011/07/05 00:14:30, J_lowe wrote: > A tiny example also demonstrates to others on the email lists that some kind of > effort has been taken to... Too wordy imo. > [PS Are we talking 'simpler' or 'tinier' here? While I can see that both work, > they are two different ideas and you are already moving away from 'tiny'. Can we > stick to tiny?] Umm, i didn't touch anything here. I've only added that example part. However, i agree that 'tiny' sounds better at the beginning of this sentence. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:289: input, it looks like they don't care how if we help them or not. "don't care how if we help them or not." Should 'how' be there? Looks wrong to me... http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:289: input, it looks like they don't care how if we help them or not. On 2011/07/05 00:14:30, J_lowe wrote: > solving the problem yourself. Whereas overly complex, large or unedited examples > look like no effort has been made to try to attempt to solve the problem > yourself and can discourage others from helping. I think it's too wordy, and the repetition about solving the problem yourself is not necessary. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:292: Creating a tiny example forces you to understand what is On 2011/07/05 00:14:30, J_lowe wrote: > A tiny example can also help you to ... I agree about the 'helping' part, but i wouldn't remove word 'creating'. It's creating the tiny example that helps in understanding, not merely having it. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:296: insufficient understanding of LilyPond, not an actual bug! On 2011/07/05 00:14:30, J_lowe wrote: > ...then the problem is usually due to a lack of understanding of how the > LilyPond syntax works. I prefer the original, it's grammatically simpler. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:305: @subheading How do I create them? On 2011/07/05 00:14:30, J_lowe wrote: > How to create them. > > [we try to not personalise the text or talk in first/second person] Good point, i agree. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:311: Include the \version number. On 2011/07/05 00:14:30, J_lowe wrote: > Include the LilyPond @code{\version} number you are using. I changed it so that it should be plain that the version of the actual binary matters, not what \version statement you are using in your files (i don't update \version numbers in my files quite often myself). http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:314: Make it small! Examples about spacing or page layout might On 2011/07/05 00:14:30, J_lowe wrote: > Keep it tiny! Examples about... I'd leave word 'make' because creating a tiny ex is a process of removing material. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:320: or @code{%@{ @dots{} %@}})} sections of your file. If you can On 2011/07/05 00:14:30, J_lowe wrote: > ..or @code{%@{ @dots{} %@}})} sections of your file first. If you can... Done. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:321: comment something while still demonstrating the main idea, then On 2011/07/05 00:14:30, J_lowe wrote: > comment something out while ... sounds awkward to me. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:322: remove the commented-material! On 2011/07/05 00:14:30, J_lowe wrote: > remove the commented material completely from your example. > > [no need for all the exclamations] Done. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:325: Avoid using complicated notes, keys, or time signatures, unless On 2011/07/05 00:14:30, J_lowe wrote: > ..notes, keys or time signatures, unless... > > [remove comma] Done. It's too subtle for me too speak, i'm not a native english speaker. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:330: is about those particular commands. On 2011/07/05 00:14:30, J_lowe wrote: > [I'd use the word 'specific' instead of 'particular' here] Done. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:334: (how the correct output should look like). On 2011/07/05 00:14:30, J_lowe wrote: > If possible, attach a small image file of what you want the correct output to > look like as this will help us clarify exactly what the problem is. I'm not sure. I wrote about 'achieving' because tiny examples are not only used for bug reports, so there isn't always "correct vs wrong" output. http://codereview.appspot.com/4636082/diff/10001/Documentation/web/community.... Documentation/web/community.itexi:375: quite often 4 lines are enough to demonstrate the problem! On 2011/07/05 00:14:30, J_lowe wrote: > [we've already said this above - "Examples about spacing or page layout might > require many bars of music, but most issues can be reproduced using less than a > single measure" why repeat it (and differently)?] Sizes of example music-wise and line-count-wise are two different things. The longer example above is already small in terms of music (only 1 measure), but the problem with it is that it is long code-wise.
Sign in to reply to this message.
I'm in a boring presentation. http://codereview.appspot.com/4636082/diff/4002/Documentation/web/community.i... File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/4002/Documentation/web/community.i... Documentation/web/community.itexi:311: Specify which release of LilyPond you are using with a too wordy. What was the problem with the original 4-word sentnce? (ok, adding @code{} would be good)
Sign in to reply to this message.
http://codereview.appspot.com/4636082/diff/4002/Documentation/web/community.i... File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/4002/Documentation/web/community.i... Documentation/web/community.itexi:311: Specify which release of LilyPond you are using with a On 2011/07/06 14:36:39, Graham Percival wrote: > too wordy. What was the problem with the original 4-word sentnce? (ok, adding > @code{} would be good) As i wrote to James, i thought it should be made clear that what matters is the version of the actual binary, not what \version statement you are using in your files. If someone was using 2.13.40 for some time, wrote a file (with \version specified) for it, then installed 2.13.47 and something broke, he may forgot to change version statement in his bug report. (i don't update \version numbers in my files quite often myself). But i don't insist on this change. Hmm, what about "Specify which "code{\version} of LilyPond you are using."?
Sign in to reply to this message.
http://codereview.appspot.com/4636082/diff/4002/Documentation/web/community.i... File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/4002/Documentation/web/community.i... Documentation/web/community.itexi:311: Specify which release of LilyPond you are using with a On 2011/07/06 17:44:37, Janek Warchol wrote: > Hmm, what about "Specify which "code{\version} of LilyPond you are using."? hmm, that's better, but it still feels a bit wordy. I'm not feeling enthusiastic about this change. Do we have any evidence that "include the \version number" is misunderstood? If you can point to 3 emails to bug-lilypond where people misunderstood this, then I'm fine with a more wordy explanation. (that said, adding the @code{} around \version is still a good change)
Sign in to reply to this message.
Reverted sentence about \version. Ready to go? http://codereview.appspot.com/4636082/diff/4002/Documentation/web/community.i... File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/4002/Documentation/web/community.i... Documentation/web/community.itexi:311: Specify which release of LilyPond you are using with a On 2011/07/07 10:26:39, Graham Percival wrote: > On 2011/07/06 17:44:37, Janek Warchol wrote: > > Hmm, what about "Specify which "code{\version} of LilyPond you are using."? > > hmm, that's better, but it still feels a bit wordy. > > I'm not feeling enthusiastic about this change. Do we have any evidence that > "include the \version number" is misunderstood? If you can point to 3 emails to > bug-lilypond where people misunderstood this, then I'm fine with a more wordy > explanation. No, i don't have any proofs, it was just a guess. Scrap it then. > (that said, adding the @code{} around \version is still a good change) Done.
Sign in to reply to this message.
http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... Documentation/web/community.itexi:320: or @code{%@{ @dots{} %@}})} sections of your file first. If you remove the word "first". It doesn't really add anything to the sentence. http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... Documentation/web/community.itexi:322: then remove the commented-material completely. What does the word "completely" add to this sentence? I mean, how do we expect users to remove commented-material partly? http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... Documentation/web/community.itexi:333: If possible, attach an image showing what do you want to achieve Change this: Optionally, attach an image showing the desired graphical output. http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... Documentation/web/community.itexi:346: @example This needs to be flush left, not centered.
Sign in to reply to this message.
New patch set uploaded. http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... File Documentation/web/community.itexi (right): http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... Documentation/web/community.itexi:320: or @code{%@{ @dots{} %@}})} sections of your file first. If you On 2011/07/09 07:51:13, Graham Percival wrote: > remove the word "first". It doesn't really add anything to the sentence. Hmm, ok. http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... Documentation/web/community.itexi:322: then remove the commented-material completely. On 2011/07/09 07:51:13, Graham Percival wrote: > What does the word "completely" add to this sentence? I mean, how do we expect > users to remove commented-material partly? Done. http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... Documentation/web/community.itexi:333: If possible, attach an image showing what do you want to achieve On 2011/07/09 07:51:13, Graham Percival wrote: > Change this: > > Optionally, attach an image showing the desired graphical output. "desired graphical output" is very nice and elegant, but i wouldn't change "if possible" to "optionally". IMO graphical samples are *very* useful and make answering a lot easier and faster, so we should encourage them as much as possible. http://codereview.appspot.com/4636082/diff/13003/Documentation/web/community.... Documentation/web/community.itexi:346: @example On 2011/07/09 07:51:13, Graham Percival wrote: > This needs to be flush left, not centered. Yes. As i wrote "I have a problem with the box at the bottom: code examples are center-aligned, not left-aligned. I didn't found any example of how it's done in our manuals; i searched texinfo documentation and found @flushleft, but it didn't work... How should i do this?"
Sign in to reply to this message.
On Sat, Jul 09, 2011 at 07:58:52AM +0000, lemniskata.bernoullego@gmail.com wrote: > >Optionally, attach an image showing the desired graphical output. > > "desired graphical output" is very nice and elegant, but i wouldn't > change "if possible" to "optionally". IMO graphical samples are *very* > useful and make answering a lot easier and faster, so we should > encourage them as much as possible. Graphical samples are a royal people for people like me to create. I began using lilypond precisely because I don't have / don't want graphical programs! I'm fine with encouraging them, as with my suggested sentence. I'm not fine with encouraging them "as much as possible". > On 2011/07/09 07:51:13, Graham Percival wrote: > >This needs to be flush left, not centered. > > Yes. As i wrote > "I have a problem with the box at the bottom: code examples are > center-aligned, not left-aligned. I didn't found any example of how > it's done in our manuals; i searched texinfo documentation and found > @flushleft, but it didn't work... How should i do this?" texi2html produces html and css. Take a look at the css, take a look at the html, take a look at the @divClass commands in the .itexi files in that directory. Cheers, - Graham
Sign in to reply to this message.
New patch set uploaded. I think that everything works now. cheers, Janek http://codereview.appspot.com/4636082/diff/10003/Documentation/css/lilypond-w... File Documentation/css/lilypond-website.css (right): http://codereview.appspot.com/4636082/diff/10003/Documentation/css/lilypond-w... Documentation/css/lilypond-website.css:897: text-align: left; I've also pondered at adding width: 96%; padding: 1em; border: solid #b1d281; border-width: 1px 1px 1px 5px; to make these similar to code examples in manuals, but i decided it would change too much.
Sign in to reply to this message.
LGTM
Sign in to reply to this message.
This has had its countdown; please push and close.
Sign in to reply to this message.
2011/7/14 <ColinPKCampbell@gmail.com>: > This has had its countdown; please push and close. I attach the patch, feel free to push it (i cannot). cheers, Janek
Sign in to reply to this message.
On Thu, Jul 14, 2011 at 09:59:44PM +0200, Janek Warchoł wrote: > I attach the patch, feel free to push it (i cannot). Thanks, pushed. Cheers, - Graham
Sign in to reply to this message.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
