Difference between revisions of "Code4Lib Style Guide"

From Code4Lib
Jump to: navigation, search
(Started a style guide)
 
(Added code instructions)
Line 14: Line 14:
  
 
Captions for tables appear above the table, centered, with "Table X:" in bold, the descriptive text in sentence case, plain text.
 
Captions for tables appear above the table, centered, with "Table X:" in bold, the descriptive text in sentence case, plain text.
 +
 +
== Code ==
 +
 +
Code samples are entered as preformatted text, as in the following example:
 +
 +
<pre>
 +
&lt;pre&gt;
 +
[sourcecode language='php']
 +
RAW HTML/Perl/PHP/XML/Etc. code goes here; change language (in above line) as needed
 +
[/sourcecode]
 +
&lt;/pre&gt;
 +
</pre>
  
 
== End of Document ==
 
== End of Document ==

Revision as of 15:01, 10 December 2008

Start of Article

Article titles are in Title Case -- all major words capitalized. The title is followed by an abstract and byline of the form "by Author" or "by Author 1, Author 2, and Author 3".

Headings

Use H2 for main section headings, H3 for sub-sections, H4 if you need a lower level. H2 are in "Title Case" -- all words capitalized, short words (the, a, in, up, over, about) should not be. H3 and H4 are in "Sentence case" -- only the first word is capitalized.

Figures & Tables

Figures and tables are centered.

Captions for figures appear beneath the figure, centered, with "Figure X:" in bold, the descriptive text in sentence case, plain text.

Captions for tables appear above the table, centered, with "Table X:" in bold, the descriptive text in sentence case, plain text.

Code

Code samples are entered as preformatted text, as in the following example:

<pre>
[sourcecode language='php']
RAW HTML/Perl/PHP/XML/Etc. code goes here; change language (in above line) as needed
[/sourcecode]
</pre>

End of Document

Footnotes & Footnote References

A Notes section (if needed) immediately follows the last of the article's narrative text. Notes are indicated in the text either by note number in square brackets [1] or by author and year [Smith, 2007]. Where notes refer to articles, books, etc., that are not available by direct link, insert a COINS element after the note.

Author Biography

Text provided by each author is listed after the Notes.


Appendices

If there are appendices, they appear after the author biography.