Re: [DOCS] Tips needed for contrib doc
Albert Cervera i Areny wrote: > Not that I want to make each module a reference. With previous > discussions we seemed to agree that: > > - It should go into the References part of the documentation (right > after "III. PostgreSQL Server Applications). > - Each module docs should be in a single page, mainly because some > contrib modules have/require very little documentation. It think you should structure the documentation by content, not by output format. You could make each module a section or a chapter, as you choose. -- Peter Eisentraut http://developer.postgresql.org/~petere/ ---(end of broadcast)--- TIP 6: explain analyze is your friend
Re: [DOCS] Tips needed for contrib doc
The problem is that if we want these docs in the Reference section of the documentation right after "PostgreSQL Server Applications" they can't be chapters nor sections, they need to be 's. That's the problem... A Diumenge 14 Octubre 2007, Peter Eisentraut va escriure: > Albert Cervera i Areny wrote: > > Not that I want to make each module a reference. With previous > > discussions we seemed to agree that: > > > > - It should go into the References part of the documentation (right > > after "III. PostgreSQL Server Applications). > > - Each module docs should be in a single page, mainly because some > > contrib modules have/require very little documentation. > > It think you should structure the documentation by content, not by > output format. You could make each module a section or a chapter, as > you choose. -- Albert Cervera i Areny http://www.NaN-tic.com ---(end of broadcast)--- TIP 2: Don't 'kill -9' the postmaster
Re: [DOCS] Tips needed for contrib doc
Albert Cervera i Areny <[EMAIL PROTECTED]> writes: > The problem is that if we want these docs in the Reference section of the > documentation right after "PostgreSQL Server Applications" they can't be > chapters nor sections, they need to be 's. That's the problem... In any case one would think that each contrib module should be at the same logical level in the docs --- if some of them are only sections, what chapter are they inside of? One point here is that a lot of the contrib material is not really written in reference style anyway. I wonder if the best solution is to make it a separate , with each contrib module being a , and then sections and subsections if needed. regards, tom lane ---(end of broadcast)--- TIP 3: Have you checked our extensive FAQ? http://www.postgresql.org/docs/faq
Re: [DOCS] Tips needed for contrib doc
Albert Cervera i Areny wrote: > The problem is that if we want these docs in the Reference section of > the documentation right after "PostgreSQL Server Applications" they > can't be chapters nor sections, they need to be 's. That is not true, AFAICT. What do you base this assertion on? -- Peter Eisentraut http://developer.postgresql.org/~petere/ ---(end of broadcast)--- TIP 3: Have you checked our extensive FAQ? http://www.postgresql.org/docs/faq
Re: [DOCS] Tips needed for contrib doc
A Diumenge 14 Octubre 2007, Peter Eisentraut va escriure: > Albert Cervera i Areny wrote: > > The problem is that if we want these docs in the Reference section of > > the documentation right after "PostgreSQL Server Applications" they > > can't be chapters nor sections, they need to be 's. > > That is not true, AFAICT. What do you base this assertion on? You're right, that's not exactly true: Reference is a Part. If we still want contrib inside Reference, contrib can be a , or other elements defined at http://www.docbook.org/tdg5/en/html/part.html. But I cant' make the contrib section a inside reference (that means no chapter per module!). If I make it a chapter the numbering inside Reference becomes: "I. SQL Commands" "II. PostgreSQL Client Applications" "III. PostgreSQL Server Applications" "43. Standard Modules" Not sure if that's a problem, but that's why I'm asking. That allows, however, having each contrib module in a section in this chapter and thus fits in one page. Though I agree I should concentrate on content, not style, having lots of very small pages isn't very nice either. You can see that in the docs I have online. In that case each module is a chapter as Tom suggests and it's a completely new Part after "Internals" IMHO having it in reference would make sense if contrib docs where organized like, well... references but that's not the case for most of them. After all you need some introduction to the module, some examples, etc. -- Albert Cervera i Areny http://www.NaN-tic.com ---(end of broadcast)--- TIP 4: Have you searched our list archives? http://archives.postgresql.org
