Using CMSMS As Front End of Code Documentation System
Posted: Thu Jan 24, 2008 11:15 am
Hi,
I am investigating the possibility of using CMSMS as the front end for our code documentation. We already have a 'knowledge wiki' based on mediawiki which could possibly also be integrated in the same cms. By 'code documentation' I broadly refer to web pages like those that Doxygen (http://www.stack.nl/~dimitri/doxygen/) and Doc-o-matic (http://www.doc-o-matic.com/index.html) produce. Please look at: http://www.stack.nl/~dimitri/doxygen/projects.html for example sites .... they document classes, methods, properties, etc.
The main difference from these automated code documentation generators is that we want to have the content in a database (rather than in static html pages) and construct the pages dynamically based on templates (like CMS systems do...). Assuming that we have a way to initially export the code structure directly in a format suitable for import to an SQL database (... please propose any alternative approach ... ), could you please give me some guidance on how to best integrate this database with CMSMS. In addition we would like to subsequently be able to edit the documentation directly from the CMSMS admin site. Is it possible to setup some kind of sub-templates (one for writing/editing each method specifically and another for editing each class properties specifically, etc) so that the users of the system dont have to write any HTML layout code if the want to modify the documentation manually?
I would really appreciate any guidance on this problem.
Thank you.
I am investigating the possibility of using CMSMS as the front end for our code documentation. We already have a 'knowledge wiki' based on mediawiki which could possibly also be integrated in the same cms. By 'code documentation' I broadly refer to web pages like those that Doxygen (http://www.stack.nl/~dimitri/doxygen/) and Doc-o-matic (http://www.doc-o-matic.com/index.html) produce. Please look at: http://www.stack.nl/~dimitri/doxygen/projects.html for example sites .... they document classes, methods, properties, etc.
The main difference from these automated code documentation generators is that we want to have the content in a database (rather than in static html pages) and construct the pages dynamically based on templates (like CMS systems do...). Assuming that we have a way to initially export the code structure directly in a format suitable for import to an SQL database (... please propose any alternative approach ... ), could you please give me some guidance on how to best integrate this database with CMSMS. In addition we would like to subsequently be able to edit the documentation directly from the CMSMS admin site. Is it possible to setup some kind of sub-templates (one for writing/editing each method specifically and another for editing each class properties specifically, etc) so that the users of the system dont have to write any HTML layout code if the want to modify the documentation manually?
I would really appreciate any guidance on this problem.
Thank you.