/srv/irclogs.ubuntu.com/2013/10/25/#ubuntu-doc.txt

eagles0513875hey all12:51
eagles0513875hey belkinsa12:51
eagles0513875hey phillw12:51
eagles0513875belkinsa: are you around as I am responding to your emails lol12:52
belkinsaNot really, but I will in 5 minutes.12:54
eagles0513875ok lol belkinsa ping me when you are available12:55
belkinsaOkay, ready to help you.12:58
belkinsaeagles0513875: Do you have a LP account set up?13:00
eagles0513875yes already logged in with the single sign on :)13:00
eagles0513875logged in on both wiki and lp13:00
belkinsaOkay.13:00
belkinsaGo to this page wiki.ubuntu.com/eagles051387513:00
belkinsaWhat does it give you?13:01
eagles0513875hold on13:02
eagles0513875https://wiki.ubuntu.com/eagles051387 it gives me template options13:03
belkinsaDo create new page for that  one.13:03
eagles0513875waht do i call it13:04
belkinsaIt's already named http://spacepestremoval.com/comic/hurry/13:04
belkinsaeagles0513875*13:04
eagles0513875?13:04
belkinsaI forgot what was last copied13:04
eagles0513875lol13:05
eagles0513875not sure what that comic has to do with anythign but lol13:05
eagles0513875hey mhall119 :)13:05
belkinsaWhen you create a new page, you specify the name of the page via url of the page and then you make a new page that way.13:05
belkinsaYou can do this for the sandbox wiki.ubuntu.com/eagles0513875/sandbox13:05
belkinsaBut for the user info page , you can use this template: https://wiki.ubuntu.com/MembershipTemplate13:06
belkinsaAnd an example of one: https://wiki.ubuntu.com/belkinsa13:06
eagles0513875ok i create a new template page?13:07
belkinsaNo.13:07
eagles0513875im lost13:07
eagles0513875so i am already in my sandbox page?13:07
belkinsaGive me a minute13:07
belkinsaNo really, you need to finish creating it13:07
belkinsaIt says this, "This page does not exist yet. You can create a new empty page, or use one of the page templates" and under that it has a link "create a new page" <--- click that and it will take you the editor.13:08
eagles0513875ok then what?13:08
belkinsaDo you get this message in  the editor text box, "Describe eagles0513875/sandbox here."?13:09
eagles0513875yes13:10
eagles0513875Describe eagles051387 here.13:10
belkinsaNow it's up to you if you want to edit the page now or you can just save it and edit it later.13:10
eagles0513875belkinsa: if you are up for it it would be great to have a page on the wiki about how to do this cuz im sure that would be great for others who want to contribute to have available13:11
belkinsaThat's what I will do.13:11
belkinsaAlso, I think that topic on having a final draft of the guide for us wasn't talked about in the meeting.13:12
eagles0513875belkinsa: how do i edit it now?13:12
eagles0513875what wiki infrastructure are they using in terms of software?13:14
belkinsaUnder the "Ubuntu Wiki" banner, there is a white banner that says, " Edit|Info|Subscribe|Attachments|<username>|Logout|Help".13:14
belkinsaMoinMoin wiki.13:14
belkinsahttp://moinmo.in/13:14
belkinsaDo you see that white banner?13:15
eagles0513875;interesting :)13:17
eagles0513875i managed to figure out the title :)13:17
belkinsahttps://wiki.ubuntu.com/HelpContents This could help but I agree, it would be better if there was user friendly guide.13:18
belkinsaThis is for you: https://wiki.ubuntu.com/HelpOnPageCreation13:18
eagles0513875https://wiki.ubuntu.com/eagles051387 :D13:19
eagles0513875thats a start13:19
belkinsaIt is.  But are you planning to make a about you wiki page if you aiming for a Ubuntu Membership?13:19
eagles0513875oh13:21
eagles0513875wait im confused13:21
eagles0513875lol13:21
eagles0513875where do we start doing the documentation  work for the community wiki13:21
eagles0513875that is what im after13:21
eagles0513875or would you recommend I create an about me wiki page?13:21
belkinsaIt's up to you though if you want an Ubuntu Membership.  Info: https://wiki.ubuntu.com/Membership13:22
belkinsaIt's not really but it's sometimes useful.13:22
eagles0513875ok13:22
* belkinsa is planning to get mine13:22
belkinsaAlso, I feel like your work will be a great help for the community if it all works out.13:23
eagles0513875ok I will work on my about me :)13:24
belkinsaIt's up to you though, I'm not making you to do it.13:25
belkinsaBut if you need a sandbox page you can always do wiki.ubuntu.com/eagles0513875/sandbox13:27
eagles0513875ty :)13:32
belkinsaNot a problem.13:32
belkinsaI started work on a wiki page called "SandboxPages" and it will act like the guide for this topic.13:32
eagles0513875belkinsa: its not linking my wiki page to my launchpad profile13:33
eagles0513875should it?13:33
belkinsaIt can, if you add the link to the page itself but usually this tells you it SandboxPages (last edited 2013-10-25 08:31:40 by belkinsa) and this on the bottom of the page.  But if you want your wiki page to true to your username on LP, you should do so.13:34
belkinsaThat was an example about the last edited message.13:35
eagles0513875im talking about the about me wiki page13:35
belkinsaAdd the LP account (page) link to the page yourself.13:35
eagles0513875add it in launch pad or the other way round13:36
belkinsa[[https://launchpad.net/~eagles051387|My LP Page]]13:36
belkinsaNo, on wiki page13:36
belkinsaSomething like that.13:37
eagles0513875ahh ok13:38
belkinsaThere is a temple (showed you the link already) to follow.13:38
eagles0513875the membership link13:40
belkinsaNo13:40
belkinsahttps://wiki.ubuntu.com/MembershipTemplate13:40
belkinsaYou can do edit, copy and paste that on your page, and cancel the editing of THAT page.13:41
belkinsaThat = as in https://wiki.ubuntu.com/MembershipTemplate13:41
eagles0513875belkinsa: you know what i am noticing that we have no documentation on how to setup and configure launch pad now that13:41
belkinsaWhat?  Creating a user info page?13:42
eagles0513875no13:42
eagles0513875community page13:42
belkinsaAs in a new page for a new topic?13:43
eagles0513875yes13:43
eagles0513875i can take that up if need be13:43
eagles0513875one step at a time13:43
eagles0513875does the community doc's have same deadlines as official docs13:44
belkinsaGood point.  I was thinking about writing that page myself, but if you want to start, you can.13:44
belkinsaI think not, but I'm not sure.13:44
eagles0513875belkinsa: reason i can take it up as my main focus is ubuntu server13:44
eagles0513875and i have a server to test on13:44
belkinsaThat cool.13:46
belkinsaAnyways, I need to go.  When you have that page done, want to send it off to me so i can look at it?13:46
eagles0513875sure thing ill link you to the about me wiki page :)13:47
belkinsaThanks.  You can do it via e-mail or PM.13:47
belkinsaSee ya!13:47
eagles0513875belkinsa: ill see what i do13:47
bkerensabelkinsa: ello14:53
eagles0513875belkinsa: i will work on the wiki once i get to work16:18
belkinsabkerensa: Hey there, you missed me though, I had to go class.  Did you me need me?18:55
eagles0513875hey littlegirl belkinsa pleia219:33
eagles0513875mhall119:  as well :D and balloons19:33
littlegirlHey there. (:19:33
pleia2morning19:33
eagles0513875how ar eyou littlegirl :)19:33
eagles0513875night here :D19:33
balloonshowdy eagles051387519:33
littlegirlPretty good. You?19:33
eagles0513875not bad here at work after a web development course :D19:34
eagles0513875and im loving web development atm19:34
eagles0513875starting to work on a site for my gf's father even though he has not approved the quote yet im getting a jump start on it19:34
eagles0513875how are you pleia219:37
eagles0513875balloons: :) how are things in the land of canonical administration19:42
eagles0513875server admin that is19:43
balloonseagles0513875, ?19:44
eagles0513875arent you a canonical server admin19:44
balloonseagles0513875, no19:47
eagles0513875oh my bad19:47
balloons:-) I work with the quality community19:47
eagles0513875ahh19:47
eagles0513875ok sry for the confusion19:47
balloonswe do fun stuff like testing19:47
eagles0513875im getting my hands dirty starting to document some things that i have setup in community documentation19:47
eagles0513875with postfix + dovecot single domain setup as well as postfix dovecot mysql with virtual users and domain setup and postfix admin19:48
pleia2eagles0513875: good good, busy friday :)19:48
eagles0513875ya same here pleia219:49
eagles0513875went from web development course came stright to work19:49
eagles05138756 more days until i go on a short vacation19:49
eagles0513875im getting excited pleia219:52
pleia2I'm going to Hong Kong in a week, but it's not a vacation19:55
eagles0513875pleia2: im off to dublin for a short suprise vacation with my gf and her family for her bday20:35
pleia2eagles0513875: very nice, I love dublin :)20:37
eagles0513875will be my first time to go20:37
eagles0513875and im taking my camera :)20:37
* pleia2 took lots of pictures http://www.flickr.com/photos/pleia2/sets/72157625081321357/20:38
eagles0513875lol20:39
pleia2pro tip: don't do the guinness and the jameson tour right after each other :)20:39
eagles0513875pleia2: seeing your pics is making me more excited20:39
eagles0513875and why not20:39
pleia2drunk20:39
pleia2hehe20:39
eagles0513875haha how many did you drink20:40
pleia2well I had a couple guinesses on the guinness tour, then I got to be one of the lucky three selected for a tasting on the jameson tour20:40
pleia2so 4 shots there20:40
pleia2I also didn't eat much that day, so that doesn't help20:40
eagles0513875no it doesnt lol20:42
eagles0513875now back to web programming i go20:42
eagles0513875started a web development course and its really kool tbh20:42
eagles0513875pleia2: is tom davies in here?20:47
eagles0513875d smythies i mean20:47
pleia2eagles0513875: when he is here, he's dsmythies, but I think he reads the logs20:49
eagles0513875gotcha :)20:49
eagles0513875thanks for the heads up20:49
eagles0513875im working on a wiki page so i can become a member.20:49
littlegirlHey there, godbyk, are you at your keyboard?20:52
eagles0513875littlegirl: hes a godbyk hes everywhere20:57
littlegirlhehe20:58
littlegirlI'm kind of stuck. I'm really motivated to do the docs right now (and that's not always the case) and I'm waiting to hear from him whether he's okay with the reformatting I'm doing of the layout of the docs before I continue doing more of them. I hope he's like Doug and comes in here and reads the logs. (:20:59
godbyklittlegirl: I'm here now.21:03
godbykJust getting caught up on reading the channel backlog..21:03
godbykLet me pull down your latest changes and take a look real quick.21:03
littlegirlgodbyk: Oh, cool. Listen, can you grab any of the .page files that start with the letter a and see if you're cool with what I did to them - especially if you compare them with the GNOME versions of them in whatever you're using to diff them?21:04
godbyklittlegirl: Have you been using xmllint or some other tool to do the indentation and wrapping?21:04
godbykWill do!21:04
littlegirlgodbyk: Nope - my fingers are doing all the work. (:21:04
godbyklittlegirl: Wow!21:04
littlegirlgodbyk: I can undo anything I did, and I'd rather know from you before I keep going. Right now I've got the pages that say, "Merge GNOME updates" in the spreadsheet marked in red in my personal file to let me know that I shouldn't do those yet until you've got them merged (because you'll probably have an easier time comparing them before I change their layout). The rest I intend to do, if that's okay with you. (:21:06
* littlegirl types like the wind.21:06
littlegirlI wouldn't be surprised if I'm the fastest typist in the world. (:21:06
eagles0513875littlegirl: how many words per min21:07
eagles0513875i do about 60 if not faster now since the last time i checked21:07
* eagles0513875 stays swearing at this web coding im doing21:07
littlegirl13021:07
eagles0513875damn girl21:08
eagles0513875might wanna stock up on some shoes you probably burn through that rubber so fast at the speeds you travel :p21:08
littlegirlYeah, and that's with proper punctuation, spelling, and (hopefully) grammar, and it's also removing any errors as they happen by quickly backspacing. (:21:08
eagles0513875littlegirl: what documentation are you working on the community stuff?21:09
littlegirleagles0513875: The core documentation: https://code.launchpad.net/~ubuntu-core-doc/ubuntu-docs/trusty21:10
eagles0513875kool :)21:10
eagles0513875im probably going to join the server guide team21:11
godbyklittlegirl: Did you rearrange the credit, link, desc, and revision tags?21:11
eagles0513875seeing as I am doign alot of technical setups :) would be great im sure to expand the documentation21:11
littlegirlI was working on the Kubuntu documentation, but they got away from bzr and Launchpad and are doing stuff in Trello and the wiki, which isn't really my type of thing, so I came over here to the Ubuntu team to see what needed doing. (:21:11
eagles0513875me im a kde user21:12
eagles0513875i cant stand unity or gnome for that matter :X21:12
* eagles0513875 goes to run and hide21:12
littlegirlgodbyk: Yep, I alphabetized them (except for link tags, which need to be in the order given, because they are generally alphabetized when viewed in Yelp or whatever).21:12
littlegirleagles0513875: Me neither. I use Kubuntu. But you can still help Ubuntu and maybe run it in a VM. (:21:12
godbyklittlegirl: It looks like the GNOME docs use the order (link, revision, desc, credit) fairly consistently.21:13
littlegirlgodbyk: I checked with the Mallard documentation and it says the info element can contain the other elements in any order, so I hope that was okay.21:13
godbykSo we should probably use that order, too, so it's easier to compare them and merge them.21:13
littlegirlgodbyk: Oh, would you rather I use that instead? I can fix the ones I did. (:21:13
godbykThey can be in any order. It's not a problem for Mallard per se. It just makes it more difficult to compare GNOME and Ubuntu Docs line-by-line when some of the lines are shuffled in a different order.21:14
eagles0513875littlegirl: agreed speaking of i need to install kvm on here21:14
eagles0513875going to use that as my virtualization platform of choice :)21:14
godbykAlso, I think the only lines that get wrapped in the <info> block are long <desc> paragraphs.21:15
godbykIt appears all the others are kept on a one-tag-per-line basis.21:15
littlegirlgodbyk: Okay, not a problem. I copied and pasted the order you just listed into my little personal file and will change the ones I did to that and do the rest in that order from now on. (:21:15
littlegirlgodbyk: Sometimes the revision elements are long, too.21:15
littlegirlgodbyk: Do you know who adds the revision pkversion elements? Those seem to use a different version number (like 0.1 or 0.2 or 0.3) instead of the Ubuntu release version numbers.21:16
godbyklittlegirl: I just grepped all the <revision> tags in the GNOME docs and they're all one-liners.  One <revision> per line.21:16
godbyklittlegirl: I suspect we inherited most of those from the GNOME docs.21:17
littlegirlgodbyk: Yep, they're one line, but they're longer than 80 characters, and I'm hard-wrapping the text, and some of them have to be hard-wrapped. (:21:17
littlegirlgodbyk: Not all of them - just some. (:21:17
godbykAh, well, we'll have to break the 80-column limit, then, I guess.21:17
godbyk(I've never much cared for the 80-column limit, but that's just my personal preference.)21:17
littlegirlgodbyk: Do you have a number in mind?21:18
littlegirlgodbyk: It's what the GNOME docs seem to use (except when someone edited a file and added some text and didn't wrap it), so I started using it. (:21:18
godbyklittlegirl: Well, they are wrapping paragraphs. I'll see if they have a consistent line limit there. But the revision tags are never wrapped (in the GNOME docs, at least).21:18
* littlegirl thinks the GNOME team needs to let her at their documentation. (:21:19
godbyklittlegirl: Ha! They might just let you!21:20
littlegirlgodbyk: My personal preference would be to not hard-wrap anything, but different diff programs (and emails, if you have yourself set to be notified of changes) wrap at seventy some-odd characters per line, so even eighty is breaking that limit.21:20
godbyklittlegirl: You might look at the xmllint and xmlindent programs. The benefit of using those (with decent settings) is that it (1) automates most of the work so you don't have to hand-edit all the files, and (2) means I can run the GNOME docs through the same program with the same settings to make it easy to compare Ubuntu and GNOME docs.21:21
littlegirlgodbyk: The problem is that the layout of the docs isn't consistent throughout. Sometimes everything is nicely indented and wrapped, and other times multiple tags will be on one line (like </p></item><item><p>, and I'm not sure xmllint could look for those and fix them, could it?21:22
littlegirlI'm thinking some of this stuff needs literal surgery, and it's only going to be possible to do it manually. The rest could probably be automated. (:21:23
godbyklittlegirl: xmllint can do things like ensure one tag per line with nested indentation and the like.21:23
littlegirlgodbyk: Ooooh, nice! Do you know how to do it?21:24
godbykBut you're right that those programs can't do everything automatically.21:24
godbykSo we'll still have to do some things by hand.21:24
littlegirlMaybe we could run it and then babysit it afterward to make sure it got everything right, and fix anything it didn't. (:21:24
godbyklittlegirl: You could try "xmllint --format mypage.page"21:26
godbykxmllint has a ton of options you can play with.21:26
godbykI'd probably try to find some that are relatively close to those used in the GNOME docs.21:26
godbykAnd if none of the built-in style features work, we could always whip up our own formatting script to do things just the way we like. :-)21:26
littlegirlIf we find one that works well, can't we run it on both to make them the same, for comparison's sake?21:27
godbyklittlegirl: Yeah, that's my thinking.21:27
godbyklittlegirl: Then even if the Ubuntu and GNOME docs are formatted slightly differently, we can just run the GNOME docs through our formatter to make them look like ours and then do the comparison after that.21:28
littlegirlgodbyk: Okay, I'll read up on xmllint and play around with it and see what I can come up with. (:21:28
littlegirlgodbyk:21:28
godbykThere's also xmlindent. I'm not sure if it has more or fewer formatting options.21:28
littlegirlGreat! Then even if there's a new version later, the same thing can be done. (:21:28
godbykYep!21:29
littlegirlI don't have that. It's not a default program?21:29
godbykAnd I can easily update my crosscheck.sh script to format the Ubuntu and GNOME docs through xmllint or whatever before loading the results into meld for comparison.21:29
* godbyk likes shell scripts21:29
* godbyk is lazy21:29
littlegirlSame here, but not the lazy part. I just love scripts. (:21:29
godbyklittlegirl: Looks like there's an xmlindent package that I have installed.21:30
littlegirlNow would this be a formal script that gets added to the repository so anyone can run it, or is this something you and I are working on unofficially?21:30
* littlegirl always likes to know her parameters (:21:30
littlegirlI'll have to install it and check it out if xmllint doesn't do what I want. (:21:30
godbyklittlegirl: I can certainly add it to the repository.21:31
godbykRight now it's just a one-line script.21:31
godbykIt just runs this:  meld $1 ~/git/gnome-user-docs/gnome-help/C/$121:31
littlegirlI have yet to try it. (:21:31
godbykwhere $1 is the filename I want to compare.21:31
godbykSaves me from typing the the path to the gnome docs all the time.21:31
* littlegirl immediately steals the meld command21:32
littlegirlI had no idea you could run Meld from the command line. (:21:32
godbykmeld is great for diffing files. I recommend it.21:32
littlegirlOh, I use it, but I use the GUI and browse to the files manually. I had no idea I could type them in (which I much prefer). (:21:32
godbykAh, gotcha.21:32
belkinsaAll, was the draft of how to contribute talked about during the meeting?21:33
godbykbelkinsa: Not in any detail. Only that we should create one.21:34
pleia2I owe an email to the list about basic contributing to trusty21:34
belkinsaor any release.21:35
littlegirlAre you guys talking about contributing to the wiki?21:35
pleia2well, the idea is for every release and call for participation we send out an email with the basics21:35
pleia2so my email will specificially reference trusty in this case21:35
belkinsaBecause I feel like we talked about many ways to use resources to write and check wiki pages on the list.21:36
belkinsaOh, right, duh.21:36
pleia2that way we don't have people reading an "it's open!" and then have to dig through docs to figure out how to do something21:36
belkinsaWiki pages and official docs.21:36
pleia2I'm referring to the shipped documentation, not wiki21:36
littlegirlgodbyk: I ran the xmllint --format pagename.page command and am not completely satisfied with the results. I'll have to look whether there's a way to tweak it. (:21:36
belkinsaOh, then never mind.21:36
littlegirlpleia2: Ah, okay. Well, if you need any help with the How To Use Bazaar or make changes to the repository files or commit and push them, I'd be happy to collaborate. (:21:37
godbyklittlegirl: There are a bunch of command-line options you can explore. See xmlline --help.21:38
belkinsapleia2, mind if I work on  a guide for the wiki?21:38
godbyklittlegirl: xmlindent --help has some options, too.21:38
belkinsaOr at least to add to the one we have.21:38
littlegirlgodbyk: Yep, I'm already in the man page and will check the --help afterward. If I can "bully" it into behaving the way I like, I'll be one happy camper. (:21:38
pleia2belkinsa: https://wiki.ubuntu.com/DocumentationTeam/Wiki21:38
pleia2belkinsa: if there are docs missing from those pages, please do work to improve them :)21:39
godbyklittlegirl: But if none of those work the way we want, we can whip up our own script to do the formatting the way we want. XML is pretty easy to work with.21:39
belkinsaGotcha.21:39
littlegirlgodbyk: Yeah, that's true. Okay, I'm game. (:21:39
pleia2https://help.ubuntu.com/community/WikiGuide should have most details though21:39
godbyklittlegirl: I think those existing scripts may not work quite like we want because they probably don't have a way to say 'wrap <p> tags but not <revision> tags', for instance.21:39
belkinsaIt's more of how one can contribute to the wiki that is missing.21:39
belkinsaOh, there's the guide that I needed!21:40
littlegirlgodbyk: Well, it's occurring to me that even if they don't, at least if we ran that one simple command (without even inventing another) on all the files, at least they'd all be consistent in their presentation (unless it screws up something in any of them, but we'll be babysitting). (:21:40
littlegirlI wrote this a while ago, and although it's for Kubuntu, it gives an idea of the kind of stuff I can write: https://wiki.kubuntu.org/Kubuntu/SystemDocumentation21:42
pleia2belkinsa: that WikiGuide page is linked twice on the https://wiki.ubuntu.com/DocumentationTeam/Wiki - maybe you can figure out a way to improve its visiblity on that page?21:42
pleia2belkinsa: I've seen these pages way, way too many times, my brain is useless :)21:42
belkinsaI can and there is also some other things I want to bring up.  For example Sandbox pages is one.21:43
littlegirlSorry, that should have been directed to pleia2.21:43
pleia2"of course the link is there and there, it's always been there!"21:43
godbyklittlegirl: True. As long as the elements stay in the same order, the indentation and wrapping and whatnot don't matter too much.21:43
pleia2littlegirl: yeah, we re-wrote this last cycle: https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide21:43
littlegirlgodbyk: And even if we don't love it, it's a baseline from which everything else can fall into place. (:21:43
belkinsapleia2: Couldn't there be a ref to the guide right on the home page of wiki.ubuntu.com?21:44
godbyklittlegirl: Yeah. :)21:44
littlegirlpleia2: Ah, so you already have it in Ubuntu. (:21:44
pleia2belkinsa: no, wiki.ubuntu.com and help.ubuntu.com/community/ are different things21:44
belkinsaNo- as in https://wiki.ubuntu.com/.21:45
pleia2belkinsa: we don't want references to how to get involved with help.ubuntu.com/community/ on the main wiki.ubuntu.com page, it would confuse people :\21:45
littlegirlgodbyk: Well, let me have a bit of a play with xmllint and see if I can't make it dance. If not, then we can go ahead and use the basic command as our baseline for everything, and just have that as a very small script that we let users know about in the repository for any future edits or additions. (:21:45
belkinsaI was thinking under Get Involved heading.21:45
belkinsaBut you maybe right.21:45
littlegirlpleia2: I feel very strongly that wiki.ubuntu.com and help.ubuntu.com are badly named and really, really, really should be renamed.21:46
pleia2belkinsa: I don't think it's fair to give a link to the docs team stuff there, there are dozens of teams within ubuntu21:46
* littlegirl throws another really onto the pile for good measure21:46
pleia2littlegirl: indeed, it confuses everyone, but it's a bit too late to change things21:46
littlegirlpleia2: Hopefully it's not too late. I've been using Kubuntu for years, and I'm still confused to this day and have to look it up because I can't remember it. It's even worse for newbies. (:21:46
pleia2help.ubuntu.com/community should probably be docs.ubuntu.com as it's own wiki21:47
belkinsa+121:47
pleia2but changing that now would be super painful, and I don't think we have the resources to do it (community + canonical IS resources)21:47
littlegirlpleia2: That's a shame. Hopefully they're at least talking about it and dusting it off at meetings from time to time so that maybe at some point it will get done. (:21:48
shaunmlittlegirl: I guarantee the gnome docs team would let you at their documentation21:58
shaunm(responding to stuff said earlier)21:58
littlegirlshaunm: They might hesitate if they knew I use KDE, though. (:21:58
shaunmto clarify things: the order of any child elements of info, including link elements, does not matter (except in very rare corner cases that you should strive to avoid)21:59
godbykshaunm: They only matter to me when I'm comparing the Ubuntu docs that we've inherited from the GNOME docs.21:59
littlegirlshaunm: I'm under the impression, though, that link elements display in the order they're placed in the document, though, right? In which case, if it's a matter of whether they display in alphabetical order in the raw document or whether they do so in the displayed document, the displayed document would trump, I think). (:22:00
littlegirlYeah, and I'm trying not to make the comparisons too rough for godbyk when I do all this "violent" stuff to the docs. (:22:00
shaunmthey are displayed alphabetical by their title. the order the link elements come in doesn't affect anything22:00
littlegirlIf you look at all the .page files that start with a, they're all very pretty in their raw state, now. (:22:01
littlegirlshaunm: Oh, you just made me very happy. Then I could go through and alphabetize them in their raw state, too. (:22:01
littlegirlI literally like Mallard and Bzr so much that I'm thinking of using Mallard for my personal documents since I already use Bzr, and they fit so nicely together. (:22:02
shaunmI suppose the order of the link elements might make a difference if you link to two pages that have the same title. that's one of those very rare corner cases I mentioned that you should strive to avoid :)22:02
shaunm\o/22:02
littlegirlshaunm: True. (:22:02
littlegirlLOL, let me guess. You're a Mallard developer?22:02
shaunmyes, guilty22:03
littlegirlshaunm: Nice work! I like it better than DocBook! (:22:04
shaunmget KDE to switch ;)22:04
godbykshaunm: I skimmed through your MEP about the <info> element the other day. I don't have any objections to it. Have there been a lot of requests for that sort of extension?22:05
littlegirlI wish I could. They've gone off of the repository entirely with the main body of the documentation and have it on the wiki. I'm *not* a wiki person, so I've kind of stopped helping out for the most part, although I still contribute sometimes. (:22:05
shaunmgodbyk: it comes up occasionally22:06
shaunmor rather, something comes up that would be handled by it, like doing alt titles on expanders on figures22:07
godbykshaunm: One idea that I had that would be helpful is to be able to add a package attribute to the revision element so you could specify that a page/section/whatever of documentation corresponds to a particular version of a package/application.22:07
godbykThen I could run a script to find outdated documentation by comparing the documented package versions against the current package version.22:07
godbykshaunm: Oh, and on another topic.. my earlier question about the comment block placement (i.e., it doesn't work at the end of a page). Is there anything in the documentation that explains why it's currently disallowed?22:09
shaunmgodbyk: that's what pkgversion is for. 'yelp-check status' even lets you filter based on it22:20
shaunmas for comment blocks, basically you can't put any blocks after sections, mostly because it's difficult to come up with a sensible rendering for it. the same limitation exists in docbook22:21
littlegirlshaunm: There are many documents that have two revision elements inside the info element. I realize you can have as many as you like. What I'm wondering, though, is that some are revision version and others are revision pkgversion version, and the ones with pkgversion version have a different version number in them. Do you know who adds that element and whether it's important to preserve or update those versions?22:22
shaunmand not being able to put blocks in general (e.g. paragraphs) after sections never seems to bother people, but there have been a surprisingly large number of requests for comments after sections22:22
littlegirlshaunm: To embellish that a bit, the ones with revision version use the Ubuntu release number as their version. The ones with revision pkgversion version use 0.1 or 0.2 or 0.3 and I'm not sure what those represent.22:24
godbykshaunm: Yeah, I found a few GNOME docs that had comments after sections. I may submit an MEP for that since it shouldn't impact rendering adversely.22:24
shaunmmy guess is you're seeing version numbers inherited from gnome22:24
shaunmand gnome earlier on was very sloppy about how it used them22:25
godbykshaunm: Per the pkgversion attribute, while it specifies the version, it doesn't specify the package *name*.22:25
godbykThough I suppose if pkgversion is never used by yelp, etc., then I could use a packagename-version string for the pkgversion attribute.22:26
littlegirlSo godbyk, can we get rid of those versions from the docs and just add the pkgversion attribute to the revision element and only have one revision element per document?22:26
littlegirlSome developer might want to know which package version a document is for, so keeping those is probably a good idea even if Yelp doesn't use them.22:26
godbyklittlegirl: Well, having the GNOME revision elements is handy as we don't always want the latest GNOME docs (since Ubuntu lags behind a bit).22:26
littlegirlgodbyk: Ah, okay, that makes sense. (:22:27
littlegirlgodbyk: I don't see any way to customize what xmllint does to a file, so we can just decide to use it as is or get people to install something else (not recommended) or write something ourselves. Which is most appealing to you?22:34
godbykHmm.. well, writing something ourselves shouldn't be too onerous. I could probably whip up a Python script pretty quickly.22:35
godbykThe benefit of having our own script is that we can customize the formatting to our exacting standards. :)22:35
littlegirlWe should be able to help with it. My son and I are learning Python, and we're newbs, but already know a surprising amount. (:22:35
godbykAh, cool. We'll you're welcome to take first crack at it if you like.22:35
* littlegirl can be kind of exacting at times (:22:35
godbykYou could also have the script handle the updating of the version numbers and status info.22:36
godbykMight save you even more typing!22:36
littlegirlLOL22:36
littlegirlAnything we write might be a bit clunky and need some polishing, though, since we're still very definitely newbs. (:22:37
godbykNo problem. I don't write enough Python to be particularly good at it, either.22:37
littlegirlgodbyk: If there's one that does version number and status updates, it should probably be a separate script full of sternly worded warnings. (:22:38
littlegirlgodbyk: Oh, cool, then we can stumble through it together. (:22:38
godbykThat's true.22:38

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