[asterisk-commits] mvanbaak: branch group/appdocsxml r143403 - /team/group/appdocsxml/

[SVN commits to the Asterisk project]

Author: mvanbaak
Date: Wed Sep 17 15:41:22 2008
New Revision: 143403

URL: http://svn.digium.com/view/asterisk?view=rev&rev=143403
Log:
update TODO

Modified:
    team/group/appdocsxml/TODO_appdocsxml

Modified: team/group/appdocsxml/TODO_appdocsxml
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/TODO_appdocsxml?view=diff&rev=143403&r1=143402&r2=143403
==============================================================================
--- team/group/appdocsxml/TODO_appdocsxml (original)
+++ team/group/appdocsxml/TODO_appdocsxml Wed Sep 17 15:41:22 2008
@@ -12,26 +12,19 @@
 based on arguments/results/types of dialplan applications,
 functions, and anything else that can be regulated to some degree.
 
-A documentation.xml with all the source documentation.
-(Probably call it core-docs.xml or something) 
-For a specific language (small, compact, easy).
+A file (doc/core-en_US.xml) with all the source documentation.
 Then, I could parse ANY xml files in the doc/ folder in the 
 same format I parse documentation.xml, if you have an <application> tag,
 it would just get added, and boom, it works.
 
 You could deal with conflicts as a first come, first serve nature.
 
-If there is something you are overwriting, submit it upstream.
-
 **** Todo ****
-
-Make the description etc work again now we have <para> tags in there.
 
 ONCE we have a acceptable format that most agree on, we will
 need to convert all the applications to use this method (obviously).
 Format documentation is in doc/xmldocumentation.txt. 
 Feel free to comment on it.
-It needs a node for return values of functions. (noted by snuff-home on #asterisk-dev)
 
 Define a set of rules/ideas that you want to pull out of the documentation.
 
@@ -40,48 +33,6 @@
 can be pulled out in a reliable way. Now we have to do that for
 all the Documentation we have already converted.
 
-The loader should look at the documentation_language setting as it is there now in /etc/asterisk.conf
-and load the correct xml file. If the localised version is not present we should fallback
-to core-en.xml
 One step further is to parse other xml files as well for not-in-tree modules.
 On conflict (two defenitions of the same application in the same language) the core-$lang.xml version should be used.
 If possible, a note should be shown to the user that they should send the differences upstream.
-
-One thing we should do as soon as possible is generate the syntax for an application/function based on the XML nodes.
-This way we can prove we really have everything we need !
-
-=== DONE ===
-
-Move to libxml2 because libxml is LGPL and thus not ok to link in the asterisk core.
-
-Possibly, instead of passing NULL, NULL on ast_register_application
-and ast_function_register, just:
-#define ast_register_application_xml(a, b) ast_register_application(a, b, NULL, NULL) ?
-
-Finish ast_register_application_xml
-
-Finish the parsing of /var/lib/asterisk/documentation.xml
-
-Fix the XML parsing, it seems that is not returning the right
-XML blob. I will have to talk to russell....Adding the language
-finding support messed up the accuracy of the parsing.
-(yay)
-
-Add the parsing of files to one xml blob, and copying to
-/var/lib/asterisk/documentation.xml
-
-Change from iksemel to some other XML
-parsing library (libxml?)
-
-mvanbaak added an example in apps/app_dial.c of 
-an XML tree of the Dial application.
-
-(Added RetryDial as well)
-(Added MeetMe as well)
-
-Multiple Language Support :D
-
-Only document the applications/functions/etc in english in the sourcecode
-Make the build setup extract those as doc/core-en.xml
-Others can use this file to make localized versions (ex. core-nl.xml)
-