Difference between revisions of "Chado Tables to Wiki"

From GMOD
Jump to: navigation, search
m
m (Instructions)
Line 8: Line 8:
  
 
* Install postgresql_autodoc (http://www.rbt.ca/autodoc/)
 
* Install postgresql_autodoc (http://www.rbt.ca/autodoc/)
* Download the template for the entire schema page
+
* Save [[html.tmpl.main|this text]] as ''html.tmpl'' if you want to create table documentation for the entire schema
* Download the template for the module page
+
* Save [[html.tmpl.module|this text]] as ''html.tmpl'' if you want to create table documentation for a single module

Revision as of 03:50, 15 April 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 (Chado Tables, where all links are internal) and another template to create table documentation for a module (e.g. Chado Organism Module, where all links go to Chado Tables page). A simple Perl script converts the HTML to Wiki text.

  • 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