> What I think we need is an agreed upon format for comments (usually > python doc. strings but not always) which can be spidered by some > script which makes a keyword searchable index for finding things. The > top of .../leo/doc/plugin_catalog.py has > > Extract plugin status and docs. from docstrings > > :last_update: 20100301 > :plugin_status: inital development > :gui: qt and tk > :maintainer: [email protected] > > as an example, although I think it needs more thought.
It would be good to have a short description/summary and as well, though I wouldn't add a trigger word for that. Personally I'm not generally a fan of "markup" for things like descriptions or summaries. I much prefer taking from context. For example instead of: :short_desc: Foo plugin takes the bar and serves drinks, use sparingly. :long_desc: Foo plugin takes the bar and serves drinks, use sparingly. It's syntax is.... Do: from destination page, use the first <p> (or X words from first <p>) as the short description/summary, and the first two <p> (or all words from first <p>) as the extended description. <p>Foo plugin takes the bar and serves drinks, use sparingly. It's syntax is: praesent consectetur felis non urna pellentesque in vulputate magna porta. Nulla non risus mi. Curabitur libero metus, dignissim in venenatis ut, laoreet vel sem. Curabitur elit augue, accumsan adipiscing gravida nec, porttitor ac ligula. Integer sollicitudin, nibh vel placerat tristique...</p> I've implemented this on wikis a couple of times and found it quite liberating. It means not having to hide the trigger word when rendering for reading, or remembering the syntax/spelling when writing (was that :short_desc: or [summary]?), and it usually doesn't need to be explained to users, it's just natural. The same way of thinking can pull :title: from <h1> and so on. Anyway, I've blathered enough on that, use or not as it suits. -matt -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/leo-editor?hl=en.
