NOTE: This style guide was written for gmod.org when it was hosted in a MediaWiki server and may not make a lot of sense in the markdown context.
Stolen wholesale from BioPerl wiki Style Guide. See also the Site Guidelines.
What you want | Enter this | To create this |
---|---|---|
Internal Wiki link | [[GMOD_Middleware|GMOD Middleware]] |
GMOD Middleware |
Internal Wiki link w/ display name | [[GMOD_Middleware|GMOD middleware meeting]] |
GMOD middleware meeting |
BioPerl wiki link | BioPerl|Style_guide |
Style_guide |
BioPerl interWiki link | [[bp:BioPerl:Style_guide|Bioperl Style Guide]] |
Bioperl Style Guide |
Wikipedia interWiki link | [[wp:The Beatles|The Fab Four]] |
The Fab Four |
BioPerl module link | BPM|Bio::SeqIO |
Bio::SeqIO |
GMOD SourceForge SVN file/directory | SF_SVN|schema/trunk/chado/INSTALL.Chado|Chado install instructions |
Chado install instructions |
CPAN module link | CPAN|Class::DBI |
Class::DBI |
Bare URL | http://www.google.com/ |
http://www.google.com/ |
Display an image | [[Image:Bioperl-pub-data.png]] |
Not working yet |
URL w/ display name | [http://www.google.com/ Search Google] |
Search Google |
Put page in category | [[Category%253ATools]] |
(link to other Tools in page footer) |
Sign your name with date | ~~~~ |
scott 02:11, 28 December 2005 (EST) |
Filenames, paths, $ENV_VARS | <tt>$PREFIX/lib/perl.so</tt> |
$PREFIX/lib/perl.so |
Inline code examples | <code>$fh->print("BioPerl")</code> |
$fh->print("BioPerl") |
Blocks of code | Indent it, or use PRE tags, or custom language
tags:<syntaxhighlight lang="perl"> #!/usr/bin/perl -w use strict; use Bio::Perl; my $db = Bio::DB::GenBank->new<br></syntaxhighlight> |
|