Pavel, One advantage of having the manuals in the HTML the same as the PDF manuals is you can search the whole thing very easy. Another is the PDF and the HTML are the same layout which makes it easier to find things in either one. One thing that I don't care for is the TOC in the HTML. In the larger documents it is too long and too far away from the subject matter. I'm not sure what to suggest, perhaps having only the parts and chapters in the TOC or maybe sections too but dropping subsections to shorten up the TOC. I don't know if it is possible to have the chapter and possibly the section headers have a link to the TOC as this would make it easier to navigate to the TOC in the larger documents.
All that said, I like what you have done. John Pavel Shramov wrote: > On Fri, Jan 14, 2011 at 06:34:47PM +0300, Pavel Shramov wrote: > >> In the light of upcoming 2.5 version and new branch I want >> to bring up again question about documentation format. >> > This is call for bug hunting. > > I've done initial conversion of docs to asciidoc and created branch > with new docs [1]. Thanks to Jeff's lyxtree script and AsciiDoc > simplicity conversion was pretty simple. > > But now I need Your's help. Please take a look into docs and if you > find something wierd/incorrect/lost in transition - tell me. > > http://psha.org.ru/tmp/src/Master_Integrator.html > http://psha.org.ru/tmp/src/Master_User.html > http://psha.org.ru/tmp/src/Master_HAL.html > http://psha.org.ru/tmp/src/Getting_Started.html > > Individual docs are living in subsequent dirs, for example > > http://psha.org.ru/tmp/src/gui/touchy.html > http://psha.org.ru/tmp/src/hal/intro.html > ... > > To view source of any document replace .html with .txt. PDF docs are > not provided since they are nearly useless for reviews - it's possible > to share link to bug in HTML but not in PDF... > > French translation is not yet converted since I think that moving it to > own dir (fr) woule be better then rename all files to filename_fr.* > > Also if you have some objections or arguments not to do this - please > don't stay silent. > Pavel > -- > [1] http://psha.org.ru/cgit/psha/emc2.git/log/?h=asciidoc > > ------------------------------------------------------------------------------ > Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)! > Finally, a world-class log management solution at an even better price-free! > Download using promo code Free_Logger_4_Dev2Dev. Offer expires > February 28th, so secure your free ArcSight Logger TODAY! > http://p.sf.net/sfu/arcsight-sfd2d > _______________________________________________ > Emc-developers mailing list > Emc-developers@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/emc-developers > ------------------------------------------------------------------------------ Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)! Finally, a world-class log management solution at an even better price-free! Download using promo code Free_Logger_4_Dev2Dev. Offer expires February 28th, so secure your free ArcSight Logger TODAY! http://p.sf.net/sfu/arcsight-sfd2d _______________________________________________ Emc-developers mailing list Emc-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/emc-developers
