I'd like to bring, (actually re-bring), up some things that would help
address these directions:
2. Newbies can learn Leo's main features easily.
> 3. *Good* documentation exists for all important plugins and main features.
>
Most of these suggestions come with my open source work with a previous
editor.
Have a robust examples folder containing leo documents showing:
- how to use leo (e.g. the QuickStart document)
- demo a plugin's functionality and use
- could use its own setting section to let the user try out plugins
they don't have enabled
- allows the plugin author to show use cases
- show how to write a plugin
- demonstrate each language mode's functionality and use
- show what syntax coloring they do
- what completion/expansions are availiable
- other language specific support they give
- demo how to do specific things in leo
- how to add support for a new language
Most of these documents are meant to be used interactively, or as
templates. Language mode demos would have hints that are meant to be
completed. The adding language support would discuss how to add support
for a language and have the bare outline structure to do that, requiring
just filling in and a "Save as".
It is for this type of thing that I've suggested adding a
"open-as-template" setting. This also acts as style and format guides and
helps create consistent contributions.
Such a scheme adds a more light weight, focused, and accessible help system
that would well complement the more monolithic Sphinx documentation and
encourage small, personal, documentation "forays".
Tom
--
You received this message because you are subscribed to the Google Groups
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/leo-editor?hl=en-US.
For more options, visit https://groups.google.com/groups/opt_out.
