You are here: start » migration » kamailio-module-docbook

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
migration:kamailio-module-docbook [2009/04/21 22:10]
miconda created 		migration:kamailio-module-docbook [2009/04/24 10:21] (current)
miconda
Line 1: Line 1:
 ====== Kamailio Module Docbook Migration ====== ====== Kamailio Module Docbook Migration ======
  
-* add to your module 'doc' folder a Makefile following the next pattern:+<hi #87ceeb>Kamailio module's docbook documentations have been migrated.</hi>
  
-<code> +===== For new modules =====
-# +
-# The list of documents to build (without extensions) +
-# +
-DOCUMENTS = module_name+
  
-# +* make a **doc** directory in your module 
-# The root directory containing Makefile.doc +* take the Makefile from another module's **doc** directory and copy to your module's **doc**. Should look like:
-# +
-ROOT_DIR=../../..+
  
-# +<code> 
-# Validate docbook documents before generating output +docs = modulename.xml
-# (may be slow) +
-# +
-#VALIDATE=1+
  
-# +docbook_dir = ../../../docbook 
-# You can override the CSS used in generated +include $(docbook_dir)/Makefile.module
-# HTML documents here +
-# +
-#HTML_CSS=/style/docbook.css +
- +
-# +
-# You can override the stylesheet used to generate +
-# xhtml documents here +
-# +
-#XHTML_XSL=$(ROOT_DIR)/doc/stylesheets/xhtml.xsl +
- +
-# +
-# You can override the stylesheet used to generate +
-# plain text documents here +
-# +
-#TXT_XSL=$(XHTML_XSL) +
- +
-# +
-# K documentation style +
-# +
-DOCBOOK_MODE=k +
- +
-include $(ROOT_DIR)/Makefile.doc+
 </code> </code>
  
-* replace in the Makefile the word 'module_name' from the assignment of DOCUMENTS variable with the real name of the module. For example, in case of dispatcher module:+For **dispatcher** module is:
  
 <code> <code>
-DOCUMENTS = dispatcher+docs = dispatcher.xml 
 + 
 +docbook_dir = ../../../docbook 
 +include $(docbook_dir)/Makefile.module
 </code> </code>
  
-* edit doc/module_name.xml and replace: +* replace in the **Makefile** the name of the file **modulename.xml** from the assignment of **docs** variable with the name of your main docbook file. See above for example of **dispatcher** module. 
-** entities.xml with kam_entities.xml +* write your **modulename.xml** and other docbook files you include in it
-** module_faq.xml with kam_module_faq.xml+
  
-You are done. Add the new Makefile to repository and then commit and upload to sip-router.org GIT.+You are done. Add the new **Makefile** and the docbook files to repository, then commit and upload to sip-router.org GIT.
  

Trace:

Navigation

Wiki

Other

QR Code
QR Code migration:kamailio-module-docbook (generated for current page)