Difference between revisions of "Chado Tables to Wiki"

From GMOD
Jump to: navigation, search
m (Instructions)
m (Instructions)
Line 5: Line 5:
 
==Instructions==
 
==Instructions==
  
The postgresql_autodoc script uses template files to create HTML documentation of Postgres schemas. To create table documentation for this Wiki you will use one template file to create the documentation for the entire Chado schema ([[Chado_Tables|Chado Tables]], where all links are internal) and another template to create table documentation for a module (e.g. [[Chado_Organism_Module|Chado Organism Module]], where all links go to [[Chado_Tables|Chado Tables]] page). A simple Perl script converts the HTML to Wiki text.
+
The postgresql_autodoc script uses template files to create HTML documentation of Postgres schemas. To create table documentation for this Wiki you will use one template file to create the documentation for the entire Chado schema (as in this [[Chado_Tables|Chado Tables page]], where all links are internal to the page) and another template to create table documentation for a module (e.g. [[Chado_Organism_Module|Chado Organism Module]], where all links go to the [[Chado_Tables|Chado Tables page]]). A simple Perl script converts the HTML to Wiki text.
  
 
First, the Chado tables or schema that you want to document has to be installed in Postgres. Then:
 
First, the Chado tables or schema that you want to document has to be installed in Postgres. Then:

Revision as of 19:17, 8 May 2007

Description

This page shows you how to create the Chado table documentation seen on pages like Chado Tables and Chado Organism Module.

Instructions

The postgresql_autodoc script uses template files to create HTML documentation of Postgres schemas. To create table documentation for this Wiki you will use one template file to create the documentation for the entire Chado schema (as in this Chado Tables page, where all links are internal to the page) and another template to create table documentation for a module (e.g. Chado Organism Module, where all links go to the Chado Tables page). A simple Perl script converts the HTML to Wiki text.

First, the Chado tables or schema that you want to document has to be installed in Postgres. Then:

  • Install postgresql_autodoc (http://www.rbt.ca/autodoc/)
  • Save this text as html.tmpl if you want to create table documentation for the entire schema
  • Save this text as html.tmpl if you want to create table documentation for a single module
  • Run the postgresql_autodoc script in the same directory as the html.tmpl file. The command will be something like this:
  >postgresql_autodoc -f chado -u user -d chado --password=passwd -l . 
  • This should create an HTML file called chado.html
  • Run this Perl script to convert the HTML to Wiki text (this script will work with the Chado v. 1.6 schema)
  • If you're creating table documentation for the entire schema the command will look something like this:
  >print-wiki-tables.pl -all > allmodules.wiki
  • If you're creating table documentation for a module the command will look something like this:
 >print-wiki-tables.pl -m cv > cv.wiki