[Laszlo-dev] docs.openlaszlo.org -- wouldn't that be nice?
jsundman at laszlosystems.com
Wed Jan 10 10:27:11 PST 2007
All the examples in the Dguides are called out using the syntax:
<example title=" " . . .>
Not all of the example titles are very helpful, although I have tried
to make them so.
All of the examples *used to be* called out the same way in the
"wrapper pages" that were used to build the Reference, but with the
doctools overhaul, wrapper pages have gone away, so the syntax for
calling out examples presumably has changed a little, but I'm not
sure exactly how.
Yesterday Raju and I were exploring some ideas of expanding the
syntax of the <example> tag, perhaps by adding a "tags" attribute.
<example title="Using States to Animate SomethingorOther"
tags="states state aninmate aninmator animatorgroup somethingorother">
This would make it possible to sort examples by title and by tags.
Presumably grepping through the examples in the reference and
normalizing them into the same format as used in the Dguides would
not be hard. If that surmise is correct, it would not be hard to
make a combined database of examples from the Dguides, Reference,
etc. But I'm not the doctools guy, so I don't want to be presumptuous.
Of course, we need to be careful, because not all examples apply to
all runtimes and deploy modes (i.e. SOLO and proxied).
More on this general theme to follow in a day or two.
On Jan 10, 2007, at 1:08 PM, Benjamin Shine wrote:
> Google does the indexing for us. If Yossie can do the url rewriting
> in a few minutes, I think it's worth doing. As the doc effort comes
> up with better technologies for indexing and searching the docs, we
> can replace or augment these simple google tricks.
> There's a lot of traffic on the forums where one person says, "I
> can't find documentation on xxx" and then someone else says "here's
> a link to the docs you need" or "here's a google search that will
> give you the docs you need." Constructing the right google search
> is a learned skill and requires knowledge of where the right
> content lives.
> We should also have better searching of the demos and examples...
> not everyone has
> $ grep onclick `find demos -name *.lzx`
> hard-wired into their fingertips.
> On Jan 10, 2007, at 9:52 AM, John Sundman wrote:
>> In theory, the new tools will give us many better options for
>> indexing and sorting and accessing the content. Please stay
>> tuned for some ideas from me/Jim/Raju on how to best structure
>> this. . . Your ideas would mesh nicely, I think.
>> On Jan 10, 2007, at 12:34 PM, Benjamin Shine wrote:
>>> I always struggle to remember the url to the laszlo documentation
>>> that I want to get to.
>>> Wouldn't it be fantastic to have docs.openlaszlo.org always point
>>> to the latest doc?
>>> and, docs.openlaszlo.org/<version> always point to the docs for
>>> that version?
>>> and -- docs.openlaszlo.org/search/<searchstring> return the
>>> search results for that text?
>>> And maybe also, reference.openlaszlo.org always point to the
>>> I bet that our masters of mod_jk and mod_rewrite can make all of
>>> this happen!
>>> benjamin shine
>>> software engineer
>>> ben at laszlosystems.com
> benjamin shine
> software engineer
> ben at laszlosystems.com
More information about the Laszlo-dev