Difference between revisions of "Category:Code"

From ThinkWiki
Jump to: navigation, search
(clarify)
m
Line 7: Line 7:
 
<div style="background-color: #E0E0E0">
 
<div style="background-color: #E0E0E0">
 
<tt><nowiki>{{</nowiki>CodeHeader|</tt><br />
 
<tt><nowiki>{{</nowiki>CodeHeader|</tt><br />
<tt>|filename=foo</tt> &nbsp;(''filename this should be saved as, preferably the same as the <tt>foo</tt> in <tt>Code/foo</tt>'')<br />
+
<tt>|filename=foo</tt>
<tt>|context=<nowiki>[[</nowiki></tt>''primary page were code is introduced''<tt><nowiki>]]</nowiki></tt><br />
 
<tt>|author=<nowiki>[[</nowiki>User:</tt>''Yourself''<tt>|</tt>''Yourself''<tt>]]</tt><br />
 
<tt>|license=GPL v2 or higher, or GFDL v1.2 or higher </tt>''&nbsp;(preferably keep both. ThinkWiki default license is GFDL v1.2)''<br />
 
<tt><nowiki>}}</nowiki></tt>
 
</div>
 
 
 
See the pages in this categories for examples.
 
 
 
When referencing the code, always use this template:
 
 
 
<div style="background-color: #E0E0E0">
 
<tt><nowiki>{{CodeRef|</nowiki>''foo''<nowiki>}}</nowiki></tt>
 
</div>
 

Revision as of 10:16, 12 April 2007

Pieces of textual sourcecode (shell scripts, Perl scripts, C programs, patches etc.) of non-trivial length should be placed in dedicated articles called Code/foo.

The article page (Code/foo) itself should contain only the raw source file, without any Wiki markup.

The article's discussion page (Talk:Code/foo) should use the CodeHeader template to provide the file's metadata. Follow this example:

{{CodeHeader|
|filename=foo