/srv/irclogs.ubuntu.com/2011/01/17/#ubuntu-manual.txt

=== topo is now known as Guest10802
aquariusnisshh, heya; would you rather have my incomplete desktopcouch developer manual chapter now so that there's *something*, or wait until it's finished?10:34
nisshhaquarius, that depends how complete it is and when you plan to have it done by10:34
aquariuswell, the first 60% or so is basically complete (might tweak wording, but hey ho); the latter part remains to be written10:35
aquariusbut Belinda dropped me a mail to say "how are you getting on"10:35
nisshhright10:35
aquariusand the answer is: I haven't just ignored it :)10:35
nisshhi assume its just plain text with no latex formatting at this point?10:35
aquariusnope, it's latex10:36
nisshhoh ok10:36
nisshhheh, i was about to say chuck it in the branch so i can latexify it10:36
nisshhbut nvm now :)10:36
nisshhwell10:36
aquariusalthough the extent of my latex is wrapping inline code in \code{}, wrapping lines of code in \verbatim{}, and having \{section}s and \{subsection}s :)10:36
nisshhchuck it in the branch and just keep working on it from there, tbh10:36
nisshhah ok10:37
nisshhplenty more could be done, like glossary entries, index entries, rewording, editing, etc <- aquarius10:38
aquariusya, that's what I thought :)10:38
nisshhyeah10:38
aquariusso, I'll push a branch.10:38
nisshhyeah10:38
nisshhor you could put it in trunk10:38
nisshhthat way i can jump in and add some latex stuff for you10:38
aquariusum, I have the rights to commit to trunk?10:38
nisshhyeah10:39
nisshheveryone in the launchpad team does10:39
aquariusblimey. you lot are pretty trusting. :)10:39
nisshhwell10:39
aquariusif you'd rather I just pushed to trunk, then OK10:39
nisshhits pretty hard to break the branch10:39
nisshhhehe10:39
aquariustrue, but then I can't test it because I don't have the upgraded latex packages (see discussions previously), so I'll just have to take it on trust, but OK :)10:39
nisshhah ok10:40
nisshhthats fine10:40
aquariusso if I push broken latex, I'll break trunk for everyone until that's fixed. You're OK with that?10:40
nisshhno it wont10:40
nisshhitll only break make if you link it in and problems occure10:41
nisshha simple .tex file not linked in will cause no problems10:41
nisshhaquarius, can i suggest you grab the latest trunk and inside create a dir called 'desktopcouch' or something10:41
nisshhand put your chapter in there10:42
nisshhmuch cleaner that way10:42
aquariusah, OK, so I shouldn't link it in. No worried :)10:45
nisshhaquarius, yeah, its probably just safer if you dont link it in until one of us who knows latex better can check it over and make sure it has everything it needs.10:46
aquariushave pushed revno 92 which contains the chapter thus far (not linked anywhere else)10:49
nisshhok10:50
nisshhill have a look10:50
nisshhaquarius, see stuff like the double quotes? that has to be latexified :)10:51
nisshhthat would have cause problems during make10:52
nisshhcaused*10:52
aquariuswhat? god almighty.10:52
nisshhaquarius, yeah, in latex a pair of double quotes has to be like this: ``''10:53
aquariushahaha party like it's 198510:53
nisshhotherwise latex chucks a fit10:53
nisshhyeah10:53
nisshhaquarius, there are various symbols and chars that latex doesnt like, for example: _ $ &10:54
aquariusI also have a question. The app I'm building in the chapter has a bunch of stuff that isn't actually relevant to desktopcouch, so there's little point in putting the source code for the whole app in the book, since it'd waste space. So...what should I do? Should the book just reference a branch on LP?10:54
nisshhfor thos a backslash before them is required10:54
nisshhthose*10:54
nisshhhmmm10:55
ChrisWoollardMorning, aquarius. I was actually going to ask you how it was going this morning. But you weren't one when i thought about it. Well done for beating me to it.10:55
nisshhaquarius, which code sections were you thinking of that werent relevant?10:55
aquariusnisshh, the app is a very (very very very) simple DVD cataloguer. It's a quickly app. So everything that displays a window, that does gtk, that displays the about box, etc, is totally irrelevant to the chapter. All the desktopcouch code is in one file called "backend.py", which is the one discussed in the chapter10:56
nisshhah i see10:57
nisshhaquarius, i would say exclude the Quickly generated code and just present it as if your adding your code into a vanilla Quickly app10:59
nisshhknow what i mean?10:59
nisshhso at the start just tell the user to create a new Quickly app and reference that chapter for that and then tell the reader that all the following code is to be added to the existing stuff11:00
aquariusnisshh, sort of, but then there's the glade file, etc. If I put enough of the app into the book that you can build the app using nothing more than the book and quickly itself, there'll be a bunch of code in the chapter which is irrelevant and will bulk out the chapter unnecessarily, in my opinion.11:00
nisshhtrue11:00
aquariuspeople shouldn't have to type a glade file in; I should not have to write a whole thing instructing them what to do in glade :)11:01
nisshhthats very true11:01
nisshhaquarius, can i suggest you post to the list about this? i think we need others input on how to tackle this issue11:02
aquariussure thing11:03
nisshhas far as i can think, there is no easy way of getting the user to use Quickly *and* teach them desktopcouch in the same chapter without telling them exactly what to do in glade11:03
aquariusunless we say: bzr branch lp:ubuntu-developer-manual/desktopcouch-dvd-thingy11:03
aquariuswhich I think is reasonable, myself.11:03
aquariusand having the code for all the apps in LP is a godo idea anyway!11:04
aquariusbut I will lay this out in the mail.11:04
nisshhyeah11:04
nisshhaquarius, a good idea, but it would force a rearranging of the chapters (again) because the bzr/launchpad chapter is currently after yours :)11:05
nisshhand tbh, the bzr/launchpad chapter *needs* to be last11:06
nisshhsince its all about releasing your app,etc11:06
aquariusI really think that explaining a bunch of glade bollocks in my chapter is not a valuable use of space. :)11:06
nisshhagreed11:07
aquariuswe don't need to explain the bzr stuff. Just tell people "type this command to get the code for this app. You don't have to care what it means. If you do care, read the bzr chapter."11:07
nisshhbut i for one, cannot easily think of a way around that11:07
nisshhtrue11:07
nisshhmaybe just reference the bzr chapter when doing that stuff then11:07
aquariusnisshh, email sent as requested, so we'll see what else comes of it :)13:05
nisshhaquarius, ok, cool13:56
* jasono is away: I'm busy23:52

Generated by irclog2html.py 2.7 by Marius Gedminas - find it at mg.pov.lt!