As for righting a manual, I am attaching some information that I had posted back in April of 2004. Feedback or assistance would be greatly appreciated. *Wonders if this is something I should have also sent to the Users list and/or Forums*
I have attached a copy of the outline I worked on for the RoundCube documentation.
It is an outline along with a few notes. I think I have covered all the pertinent areas.
I would appreciate it if anyone that is willing would go through the document and make suggestions, etc.
There are some areas that I will need to verify how things work, etc.
I have included both a PDF and an ODT file.
Again, the document is currently on Google Docs. There are currently two others that have access to the document. If anyone else would like access to the Google Doc, just let me know.
I look forward to your replies.
Kevin L.
A.L.E.C wrote:
Thomas Bruederli wrote:
A.L.E.C wrote:
I think it would be nice to have Help item in taskbar. We can add there tabs: About, License. I also plan to add there Help tab with user manual (for RC or my plugins) or other info (e.g. supported browsers list). What do you think?
Good idea but we need to create the help pages before we should discuss where to add a link.
And here we get some new questions:
Should the help be part of the localization files or just a link to our wiki?
In which format should it be created (HTML, LaTex, other)?
Where to store the help of the plugins (in all languages)
I think that we should start with About and License pages. The manual page is problematic as we haven't got it yet, but we should add a possibility to create it by users in skins. We should just create a tab with mechanism for its content change with skins. I have no time to write manual, I was thinking only about manual to most important features/plaugins accessible in my system and in my language, so I need a place in UI ;)
ps. need icon image for help link, any suggestions?
--- 8< --- detachments --- 8< --- The following attachments have been detached and are available for viewing. http://detached.gigo.com/rc/3j/vhgcIOGh/RoundCube-User-Guide.pdf http://detached.gigo.com/rc/3j/vhgcIOGh/RoundCube-User-Guide.odt Only click these links if you trust the sender, as well as this message. --- 8< --- detachments --- 8< ---
List info: http://lists.roundcube.net/dev/