I have been working on improving the layout of help articles, specifically the way that the introductory text and groups of $subsection links are rendered and spaced apart from each other. I believe that the changes are ready to be merged (I bootstrapped, tested and ran help-lint-all), but if there are any stylistic issues, please let me know as I am still learning The Factor Way.
Principal changes: - $subsection now displays the definition-icon next to the link rather than a plain bullet symbol - If $subsection is used to display a link to a word's documentation, the word's stack effect is now drawn in a dark green color, making it easier to read the word name at a glance - Refactored $link, $long-link and $pretty-link to increase code reuse. - Added a new $subsections markup element which is a plural form of $subsection. The advantage of the plural forum is that the group of links can be styled as a group (for instance, with a light background color behind the group, although I chose not to style it that way currently) and it provides enough context so that we can insert an extra newline after the last subsection link so that the next batch of text is nicely spaced apart from the group. - Some documentation has been updated to use $subsections (specifically all of the "sequences" documentation). - The "html.streams" vocab now knows how to create an <img> HTML element from the formatted streams' "image" character style. One caveat is that the image is *not* directly embedded in the img tag, instead the image must be manually copied to "/images" in your webserver path, preserving the nested vocabulary directory structure. So if your image resource is at "vocab:definitions/icons/foo.tiff", then you must copy it to "/images/basis/definitions/icons/foo.tiff" on your webserver (notice that the vocab-root is expanded). My code is available at: git://github.com/klazuka/factor.git (branch "articles") In order to make the definition icons available via http://docs.factorcode.org, you will have to manually copy the definition-icons such that they are accessible via "/images/basis/definitions/icons/*.tiff" on the webserver. Since the definition icons are TIFFs, web browsers that cannot natively display the TIFF format will not be able to display the icons. As far as I know, only Safari natively supports TIFFs. Hopefully we can get either images.png or images.gif working soon (I am looking at images.gif right now). -keith ------------------------------------------------------------------------------ Come build with us! The BlackBerry® Developer Conference in SF, CA is the only developer event you need to attend this year. Jumpstart your developing skills, take BlackBerry mobile applications to market and stay ahead of the curve. Join us from November 9-12, 2009. Register now! http://p.sf.net/sfu/devconf _______________________________________________ Factor-talk mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/factor-talk
