U++ framework
Do not panic. Ask here before giving up.
Home » U++ TheIDE » U++ TheIDE: Other Features Wishlist and/or Bugs » An idea for improved documentation
Re: An idea for improved documentation [message #14694 is a reply to message #14692] Sun, 09 March 2008 11:23 Go to previous messageGo to previous message
mdelfede is currently offline  mdelfede
Messages: 1310
Registered: September 2007
Ultimate Contributor
I think the best and the simplest (for now) would be to put upp docs in upp format on a svn server.
Converting them to Html should be quite simple, then, if we want to have html docs too. The way around (from html to upp) would be almost impossible.
Having docs in a simple format (even xml would be good) could make it possible to convert docs in many format.

What we need is a way to add docs from inside theide in a SIMPLE way, and a SIMPLE way (just a click...) to update a repository with it. No need to have same format in Upp and in repository, just some sort of easy-to-convert format (which is not the case of html).
The wiki could then be kept updated by simple scripts running daily.

Example of a cycle :
1- you need a function that does something... you look in docs, none. You search in upp code (what for now happens often), and you find it undocumented.
2- just select some 'add doc to item' menu item, and than have an input dialog to add some docs.
3- press a button and update central repo

Ciao

Max

Report message to a moderator

[Message index]
 
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Previous Topic: [BUG] Command in temp-aux's context menu
Next Topic: Drag and Drop files
Goto Forum:
  

[ Syndicate this forum (XML) ] [ RSS ] [ PDF ]

Current Time: Wed Apr 29 10:22:10 GMT+2 2026

Total time taken to generate the page: 0.00658 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.2.0.
Copyright ©2001-2025 FUDforum Bulletin Board Software