This is an old revision of the document!


Kamailio Module Docbook Migration

* add to your module 'doc' folder a Makefile following the next pattern:

#
# The list of documents to build (without extensions)
#
DOCUMENTS = module_name

#
# The root directory containing Makefile.doc
#
ROOT_DIR=../../..

#
# Validate docbook documents before generating output
# (may be slow)
#
#VALIDATE=1

#
# You can override the CSS used in generated
# 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

* 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:

DOCUMENTS = dispatcher

* edit doc/module_name.xml and replace: entities.xml with kam_entities.xml 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.


Navigation

Wiki

Other

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