SPR 2007-05-14: Foie Gras (application shell)

["Szilveszter Farkas" <szilveszter farkas gmail com>]

Hello,

last week was also a very busy one for me (and the time of exams will
just arrive in two weeks), but I was able to find out the key features
that the documentation editor should have (some of these features will
probably be implemented after SoC ends, but most of them should be
done by that time - deciding priorities is still to be done).

Here comes the list:

- Easy to get started with
- Contribute easily (submit patches for review)
- Suitable for the hardcore people as well (commit to subversion/bazaar/etc.)
- Tight integration with Yelp
- WYSIWYG layout (done by Buddhika)
- Ability to cope with threaded comments from Mallard
- Integration with the metadata system (I still have to find out more
about this.)

=== above this line are essential ===

- Translator mode
   o split view: read-only original document + editable translated document
   o integration with i18n status page: pull the latest pot file from
there + show statistics
- Ability to review patches sent by contributors (Q: what format?
patch should be fine IMHO)
- "Start a New Project" wizard that creates the needed directory
structure and files
- TreeView of sections in a documentation and links between them
(needs good interaction between the application and the custom widget)
- Undo/redo (should be done by the editing widget)
- Spellchecking (also a task for the custom widget I think)
- Easy access to various documentation related guides

If you have any ideas that you think a documentation editor shouldn't
miss, please shoot :)

This week I'll try to come up with some mockups for the UI.

Keep up the good work everyone! :)

Cheers,
Szilveszter / phanatic