Roadrunner Wiki:Style guide
From RoadRunnerWiki
Contents |
Quick start
| What you want | Typing this in an edit window... | creates this on a wiki page |
|---|---|---|
| Internal Wiki link | [[FAQ]] | FAQ |
| Internal Wiki link w/ display name | [[FAQ|Frequently Asked Questions]] | Frequently Asked Questions |
| External Wikipedia link | [[wp:Eddy Merckx|The Cannibal]] | The Cannibal |
| Bare URL | http://www.google.com/ | http://www.google.com/ |
| URL w/ display name | [http://www.google.com/ Search Google] | Search Google |
| Files in Subversion repository | {{SVN|scripts/loadCompoundsSDF.pl}} | scripts/loadCompoundsSDF.pl |
| Put a page in category | [[Category:Community]] | (link to other Community in page footer) |
| Sign your name with date | ~~~~ | Smathias 16:20, 14 February 2006 (MST) (for example) |
| Filenames, paths, $ENV_VARS | <TT>$PREFIX/lib/DBAdaptor.class.php</TT> | $PREFIX/DBAdaptor.class.php |
| Inline code examples | <CODE>$fh->print("Hello")</CODE> | $fh->print("Hello")
|
| Blocks of code | Indent it, or use PRE tags: <PRE> <?php $dba = new DBAdaptor(); # if ($dba->error) { print "Error: " . $dba->errorMsg; } ?> </PRE> | <?php
$dba = new DBAdaptor();
if ($dba->error) {
print "Error: " . $dba->errorMsg;
}
?>
|
Wiki Links
Typing [[FAQ]] will create this FAQ link, to the FAQ page within the Roadrunner Wiki.
Wikipedia Links
As you know, Wikipedia has very good content, particularly in the areas of science and software. So, instead of creating a page for "XML" here in our Wiki use the existing entry over in Wikipedia.
[[wp:XML|XML]]
creates XML for you. Don't waste effort re-inventing the wheel!
URLs
- To link to a bare URL, simply type it as is: http://sf.net/
- To give it a display name, [http://sf.net/ SourceForge] creates SourceForge
Subversion Files
Typing {{SVN|scripts/loadCompoundsSDF.pl}} will create a link like this: scripts/loadCompoundsSDF.pl to the corresponding file in the trunk of the Subversion repository.
Important Categories
To place a page in category CATNAME, type [[Category:CATNAME]]. Just use multiple tags if a page is in more than one category. Important categories are:
- TODO - put pages that have "TODO" or "FIXME" strings here
- People - for pages that describe a person
There are also more finer grained categories, see Special:Categories for a list of them all.
Code markup
- Indent big blocks of code, or explicitly surround with <PRE></PRE> tags.
- Inline code samples, use <CODE></CODE> tags.
- Inline filenames, paths, environmental variables, ... use <TT></TT> tags.
Programming Language
You can use the Winter language if you want some Turing-completeness-but-with-syntactic-sugar in your macros aka Templates. It's "lotsa fun!"...
Be careful when calling other Wiki templates from this language. You have to enclose the paramters in <NOWIKI> tags to ensure they get passed as-is. See Template:Doclink for an example.
