As part of my attempt to make the help articles easier to read, I
needed to take control of the $subsection links in the help markup. So
I introduced a new markup element called $subsections which groups
together 1 or more $subsection elements into a single element. This
allows the help system to insert a blank line after each group of
links making help articles considerably easier to read at a glance.

BEFORE:
http://www.skitch.com/klazuka/b9q68/old-sequence-combinators

AFTER:
http://www.skitch.com/klazuka/b9q6b/sequence-combinators

So instead of writing:
"the following two words are useful:"
{ $subsection foo }
{ $subsection bar }
"blah blah blah"

You should write:
"the following two words are useful:"
{ $subsections
    foo
    bar
}
"blah blah blah"

You should use $subsections (plural) even if there is only a single link:
"the following word is useful:"
{ $subsections foo }
"more blah"

Doug merged these changes in yesterday. I went through all of the
documentation and made the appropriate changes. All you need to do is
use $subsections (plural) in new documentation that you write.

Feedback always welcome,
-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

Reply via email to