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. After playing a bit more with RST and AsciiDoc and trying to implement suggestions from #emc-devel i believe that AsciiDoc is suitable as docs format.
There were two requests - cross document links (so HTML pages will be usable) and picking different images for PDF and HTML (with same source file). Both of them may be done for asciidoc with simple config files and small helper scripts (images: [1], [2], [3]; links: [4], [5]). However images then be incompatible with stock configs - it won't find 'image-name.*'. Also Alex noticed issue that documentation fixes for released (2.4) branch need to be duplicated but that's will be same if LyX will be upgraded to one in ubuntu 10.04. I've done some cleanup on part of docs so here are examples of how it looks like. Small page/pdf with different images for pdf and html: http://psha.org.ru/tmp/lathe-user.pdf http://psha.org.ru/tmp/lathe-user.html Large User Manual document http://psha.org.ru/tmp/src/Master_User.html http://psha.org.ru/tmp/src/Master_User.pdf Source (.txt files named as their .lyx conterparts) are living in http://psha.org.ru/tmp/src/ If you have some other thoughts about what's needed or missing - I'd try to explore if/how it's possible to do. However there is question is switch really needed or not... And this is out of my knowledge... Pavel [1] http://psha.org.ru/tmp/src/xhtml11-image.conf [2] http://psha.org.ru/tmp/src/docbook-image.conf [3] http://psha.org.ru/tmp/src/image-wildcard [4] http://psha.org.ru/tmp/src/xhtml11-links.conf [5] http://psha.org.ru/tmp/src/links.py ------------------------------------------------------------------------------ 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
