part 8 of 13 Reproducible: Always Steps to Reproduce:
Created attachment 67131 [details] version 0.1 Basically done ... haven't gone over it but once for correctness ...
Hm, it needs some love, Initial version is 1.0. There should be <!-- $Header$ --> line for CVS purposes. <c>Resources</c> <- shouldn't it be <uri link="#resources">Resources</uri>? (resources section needs id="resources" for such links to work) There shouldn't be blank line between </section> and <section>. There shouldn't be any tabs in doc, they are forbidden. Things in pre like "time cat 16-meg-file > /dev/null" should be with prompt and in <i>: "$ <i>time cat 16-meg-file</i>. Table doesn't look good, blank lines must be removed, <th>'s should be changed into <ti>'s and intended two spaces right. There shouldn't be any blank line before </chapter>.... "wonders of...XFS!" needs space before XFS. (ok, it's typo...) Links should be checked if they work, if not new locations of guides they linked to have to be placed in or links commented out. (kt.zork.net is broken now for example). <mail link="drobbins@gentoo.org">drobbins@gentoo.org</mail> can be simply <mail>drobbins@gentoo.org</mail> with a new xsl. Sorry if it looks a bit like bashing your guide, it's good job, just needs small fixes. :)
Created attachment 67242 [details] version 0.2 Hm, it needs some love, Initial version is 1.0. I would have thought that would be set just prior to checkin. I was just using the 0.x notation in case someone wanted to change something and then attach a new version as an attachment. I guess I'll go ahead and change it in the file ... and then keep my attachment naming convention. There should be <!-- $Header$ --> line for CVS purposes. ... could you elaborate ? I'm trying to learn ... <c>Resources</c> <- shouldn't it be <uri link="#resources">Resources</uri>? (resources section needs id="resources" for such links to work) ... yeah done ... I didn't know how to do this. I was gonna look up an example, but hadn't yet, thanks. <chapter id="resources"> .. like this? .. its functional, but wasn't completely sure. There shouldn't be blank line between </section> and <section>. So basically, what you are saying is between section tags, not actually in a section, there should be no blank lines ? There shouldn't be any tabs in doc, they are forbidden. oops .. I think I took care of them all ... I think ... Things in pre like "time cat 16-meg-file > /dev/null" should be with prompt and in <i>: "$ <i>time cat 16-meg-file</i>. what about code listing 4.1 ... would I do it for that too ? <i>: "$ <i>time cat 16-meg-file</i> .. why the colon and the " ? Table doesn't look good, blank lines must be removed, <th>'s should be changed into <ti>'s and intended two spaces right. ... done There shouldn't be any blank line before </chapter>.... couldn't find this one ... "wonders of...XFS!" needs space before XFS. (ok, it's typo...) ok Links should be checked if they work, if not new locations of guides they linked to have to be placed in or links commented out. (kt.zork.net is broken now for example). ... well it does redirect you to kernel trafic, but in any case .. it works now with the correct lin. <mail link="drobbins@gentoo.org">drobbins@gentoo.org</mail> can be simply <mail>drobbins@gentoo.org</mail> with a new xsl. ok, but this doesn't seem to work in Konqueror ... so I used the previous example originally, but I'll change it to the "broken" version if you insist. Sorry if it looks a bit like bashing your guide, it's good job, just needs small fixes. :) thanks .. I'm learning ...
>> There should be <!-- $Header$ --> line for CVS purposes. > ... could you elaborate ? I'm trying to learn ... Of course i can. :) Such comment changes to sort of information about doc which helps to track revisions when we commit a file into CVS. It becomes something like: <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/printing-howto.xml,v 1.50 2005/07/02 12:24:16 swift Exp $ --> Which is used for example by translators to generate that fancy pages like dev.gentoo.org/~rane. :) > <c>Resources</c> <- shouldn't it be <uri link="#resources">Resources</uri>? > (resources section needs id="resources" for such links to work) > > ... yeah done ... I didn't know how to do this. I was gonna look up an > example, but hadn't yet, thanks. > > <chapter id="resources"> .. like this? .. its functional, but wasn't completely > sure. Yes, it's proper way (the better one) of making links inside the doc. > There shouldn't be blank line between </section> and <section>. > > So basically, what you are saying is between section tags, not actually in a > section, there should be no blank lines ? Every: </section> <section> Should be just: </section> <section> > There shouldn't be any tabs in doc, they are forbidden. > > oops .. I think I took care of them all ... I think ... Just use `grep "ctrl+v<tab>" file.xml` to find all the 22 of them which are still in there. > what about code listing 4.1 ... would I do it for that too ? No, it's file's content, should be left as is. :) > There shouldn't be any blank line before </chapter>.... > > couldn't find this one ... Let's look for it... :) It was in 363rd line of 0.1, and now it's fixed. Hm, btw: <title>Resources</title> <section> should be just: <title>Resources</title> <section> No need for blank line here. >> <mail link="drobbins@gentoo.org">drobbins@gentoo.org</mail> can be simply >> <mail>drobbins@gentoo.org</mail> with a new xsl. > > ok, but this doesn't seem to work in Konqueror ... so I used the previous > example originally, but I'll change it to the "broken" version if you insist. Maybe you use old xsl in your gorg? It works in mine with current one... I mean of course <mail> at the far end of a doc, not that one in <author> tag which is ok. > Sorry if it looks a bit like bashing your guide, it's good job, just needs > small fixes. :) > > thanks .. I'm learning ... No problem. More things i spotted: all the lines in doc except those in <pre> must be wrapped after 80th sign. Please read once more http://www.gentoo.org/doc/en/xml-guide.xml, there are all the answers, especially "coding style" chapter will be useful. :) (http://www.gentoo.org/doc/en/xml-guide.xml#doc_chap3)
Created attachment 67307 [details] version 0.3 >> There should be <!-- $Header$ --> line for CVS purposes. fixed. Every: </section> <section> Should be just: </section> <section> fixed. Just use `grep "ctrl+v<tab>" file.xml` to find all the 22 of them which are still in there. .. thanks. That is a very useful tip. Hm, btw: <title>Resources</title> <section> should be just: <title>Resources</title> <section> No need for blank line here. yeah. oops! >> <mail link="drobbins@gentoo.org">drobbins@gentoo.org</mail> can be simply >> <mail>drobbins@gentoo.org</mail> with a new xsl. > > ok, but this doesn't seem to work in Konqueror ... so I used the previous > example originally, but I'll change it to the "broken" version if you insist. Maybe you use old xsl in your gorg? It works in mine with current one... I mean of course <mail> at the far end of a doc, not that one in <author> tag which is ok. yeah ... the one in the last section. I fetched the newest version of guide.sxl from http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl, but this mail link format still don't work. also, the "Gentoo Linux XML Guide" doesn't reference the <mail></mail> format only the <mail uri=""></mail> type. > Sorry if it looks a bit like bashing your guide, it's good job, just needs > small fixes. :) > > thanks .. I'm learning ... No problem. More things i spotted: all the lines in doc except those in <pre> must be wrapped after 80th sign. fixed. Please read once more http://www.gentoo.org/doc/en/xml-guide.xml, there are all the answers, especially "coding style" chapter will be useful. :) Yeah, I did read it again. A couple more of these and I'll have it down. .. this should be good to go, or very close.
`grep "ctrl+v<tab>" file.xml` this doesn't seem to work .. or more precisely ... returns nothing. are you sure this is correct?
Hm, so just remove tabs in these lines: [~]$ grep " " attachment.cgi\?id\=67307 it from doing so. and we'll never need to worry about this issue again. metadata into a consistent state. <section> the benefits of journalling and ReiserFS (Part 1) setting up a ReiserFS system (Part 2) using the tmpfs virtual memory filesystem and bind mounts (Part 3) the benefits of devfs, the device management filesystem (Part 4) beginning the conversion to devfs (Part 5) completing the conversion to devfs using an init wrapper (Part 6) the benefits of the ext3 filesystem (Part 7) <p> </p> </p> <p> </p> <p> </p> <p> </p> </p> I just wrote <c>grep "</c>, then pressed both ctrl and v, left them, pressed tab, closed " and added file name. As for mail <mail>drobbins@gentoo.org</mail> is 100% valid and can stay.
I pasted wrong term's content. :) Here's better version: [~]$ grep -n " " attachment.cgi\?id\=67307 171:it from doing so. 182:and we'll never need to worry about this issue again. 275:metadata into a consistent state. 410:<section> 418: the benefits of journalling and ReiserFS (Part 1) 419: setting up a ReiserFS system (Part 2) 420: using the tmpfs virtual memory filesystem and bind mounts (Part 3) 421: the benefits of devfs, the device management filesystem (Part 4) 422: beginning the conversion to devfs (Part 5) 423: completing the conversion to devfs using an init wrapper (Part 6) 424: the benefits of the ext3 filesystem (Part 7) 428:<p> 432:</p> 437:</p> 439:<p> 443:</p> 450:<p> 457:</p> 459:<p> 465:</p> 470:</p>
Any news about that? If it gets no input in a few days, i will finish it by myself and commit.
Fixed and committed. Thanks.
