On 7/4/07, Cromwell Enage <[EMAIL PROTECTED]> wrote: > --- Matias Capeletto wrote: > > Hi Cromwell. > > Hi, Matias. > > > I recommend you read this guide, it is very fresh > > stuff (four days I think) so we can really use your > > feedback. > > > > > http://svn.boost.org/trac/boost/wiki/DocsOrganization > > Okay, I'll play with the IBD distro before I give real > solid feedback.
That will be great. > However, I am curious about a couple > of things: > > 1. The DocsOrganization page recommends that images be > in either *.png or *.svg format. However, I see no > inherent downside to using *.jpeg images in certain > cases (other than the usual lossy-compression issues). > For example, StarUML (homepage at > http://staruml.sourceforge.net/ ) can, at present, > export UML diagrams only to the *.jpeg format. I'm > simply pointing out that being a good netizen with > regard to images is more than just using a recommended > format. I am not against jpeg. The DocsOrganization recommends pngs to try to have a common image format in Boost. If you can not use pngs, you can use other format. We must recommend one. Do you think jpeg is a better recommendation? > 2. Is the example/doc subdirectory the only place > Quickbook will look for code chunks? In my automata > library, I also pull code from programs in the test > subdirectory, so at the very least I would like to be > able to keep the code there (or move them to a > test/doc subdirectory, if necessary). Again, it is just a recommendation. If you have to write code snippets only for your docs, put them there. If you want to extract snippets that are in your test suite, your example folder or your library headers, you just do it. This is done in qbk with: [import file_path] > Otherwise, this is good stuff! Keep it up! Thanks for the feedback. Please keep coming! Best regards Matias ------------------------------------------------------------------------- This SF.net email is sponsored by DB2 Express Download DB2 Express C - the FREE version of DB2 express and take control of your XML. No limits. Just data. Click to get it now. http://sourceforge.net/powerbar/db2/ _______________________________________________ Boost-docs mailing list [email protected] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
