Difference between revisions of "Category:Code"

From ThinkWiki
Jump to: navigation, search
m (Undo corruption)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Pieces of textual sourcecode (shell scripts, Perl scripts, C programs, patches etc.) of non-trivial length should be placed in dedicated articles called <tt>Code/''something''</tt>.  
+
Pieces of textual sourcecode (shell scripts, Perl scripts, C programs, patches etc.) of non-trivial length should be placed in dedicated articles called <tt>Code/''foo''</tt>.  
  
−
The article page itself should contain only the raw source file, '''without any Wiki markup'''.
+
The article page (<tt>Code/''foo''</tt>) itself should contain only the raw source file, '''without any Wiki markup'''.
  
−
The discussion page should use the <tt>CodeHeader</tt> template to provide the file's metadata. Follow this example:
+
The article's discussion page (<tt>Talk:Code/''foo''</tt>) should use the <tt>CodeHeader</tt> template to provide the file's metadata. Follow this example:
  
 
<div style="background-color: #E0E0E0">
 
<div style="background-color: #E0E0E0">
−
<tt><nowiki>{{</nowiki>CodeHeader|<br />
+
<tt><nowiki>{{</nowiki>CodeHeader|</tt><br />
−
|filename=''informative filename''<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 />
−
|context=<nowiki>[[</nowiki>''primary page were code is introduced''<nowiki>]]</nowiki><br />
+
<tt>|context=<nowiki>[[</nowiki></tt>''primary page were code is introduced''<tt><nowiki>]]</nowiki></tt><br />
−
|author=<nowiki>[[</nowiki>User:''Yourself''|''Yourself'']]<br />
+
<tt>|author=<nowiki>[[</nowiki>User:</tt>''Yourself''<tt>|</tt>''Yourself''<tt>]]</tt><br />
−
|license=GPL v2 or higher, or GFDL v1.2 or higher ''(or whatever you prefer, if it's your code)''<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 />
−
<nowiki>}}</nowiki></tt>
+
<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>
 
</div>

Latest revision as of 10:30, 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  (filename this should be saved as, preferably the same as the foo in Code/foo)
|context=[[primary page were code is introduced]]
|author=[[User:Yourself|Yourself]]
|license=GPL v2 or higher, or GFDL v1.2 or higher  (preferably keep both. ThinkWiki default license is GFDL v1.2)
}}

See the pages in this categories for examples.

When referencing the code, always use this template:

{{CodeRef|foo}}

Retrieved from "https://www.thinkwiki.org/w/index.php?title=Category:Code&oldid=29255"