Difference between revisions of "Template:ChadoTableDesc"

From GMOD
Jump to: navigation, search
m
m
Line 5: Line 5:
 
# Chado module name
 
# Chado module name
 
# Table name
 
# Table name
 +
# Emphasis - how to emphasize the table name header line.  This string will be placed on either side of the header line text.  Examples are <tt><nowiki>==</nowiki></tt> or <tt><nowiki>'''</nowiki></tt>.
 
# Description from SQL.
 
# Description from SQL.
  
 
Example:
 
Example:
: <tt><nowiki>{{ChadoTableDesc|General|db|A database authority. Typical databases in bioinformatics are FlyBase, GO, UniProt, NCBI, MGI, etc. The authority is generally known by this shortened form, which is unique within the bioinformatics and biomedical realm. To Do - add support for URIs, URNs (e.g. LSIDs). We can do this by treating the URL as a URI - however, some applications may expect this to be resolvable - to be decided.}}</nowiki></tt>
+
: <tt><nowiki>{{ChadoTableDesc|General|db|===|A database authority. Typical databases in bioinformatics are FlyBase, GO, UniProt, NCBI, MGI, etc. The authority is generally known by this shortened form, which is unique within the bioinformatics and biomedical realm. To Do - add support for URIs, URNs (e.g. LSIDs). We can do this by treating the URL as a URI - however, some applications may expect this to be resolvable - to be decided.}}</nowiki></tt>
 
</noinclude>
 
</noinclude>
 +
{{{3}}}Table: {{{2}}} {{{3}}}
  
 
'''Module: {{ChadoModuleLink|{{{1}}}|{{{1}}}}}'''
 
'''Module: {{ChadoModuleLink|{{{1}}}|{{{1}}}}}'''
Line 15: Line 17:
 
{{ChadoTableName|{{{2}}}}} description from schema:
 
{{ChadoTableName|{{{2}}}}} description from schema:
 
<div class="indent">
 
<div class="indent">
{{{3}}}
+
{{{4}}}
 
</div>
 
</div>

Revision as of 00:22, 18 November 2010

This template is used in the generated Chado table descriptions. It displays the table description that comes from withing the PostgreSQL table comment.

Parameters:

  1. Chado module name
  2. Table name
  3. Emphasis - how to emphasize the table name header line. This string will be placed on either side of the header line text. Examples are == or '''.
  4. Description from SQL.

Example:

{{ChadoTableDesc|General|db|===|A database authority. Typical databases in bioinformatics are FlyBase, GO, UniProt, NCBI, MGI, etc. The authority is generally known by this shortened form, which is unique within the bioinformatics and biomedical realm. To Do - add support for URIs, URNs (e.g. LSIDs). We can do this by treating the URL as a URI - however, some applications may expect this to be resolvable - to be decided.}}

{{{3}}}Table: {{{2}}} {{{3}}}

Module: [[Chado {{{1}}} Module|{{{1}}}]]

{{{2}}} description from schema:

{{{4}}}