Difference between revisions of "Code4Lib Style Guide"

From Code4Lib
Jump to: navigation, search
(Voting on Recommended Style:)
(Add link to CSE style guide)
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
 +
== A Note About This Guide ==
 +
 +
This is a brief style guide for authors.  For information about styles and conventions used in marking up articles for WordPress, see:  [http://wiki.code4lib.org/Code4Lib_Journal_WordPress_Input_Guidelines Code4Lib Journal WordPress Input Guidelines].
 
== Start of Article ==
 
== Start of Article ==
  
Line 5: Line 9:
 
== Headings ==
 
== 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.
+
Major section headings are in "Title Case" -- all words capitalized, short words (the, a, in, up, over, about) should not be.   
 
+
Subheadings are in "Sentence case" -- only the first word is capitalized.
== Figures & Tables ==
+
 
+
Figures and tables are centered, placed inside a P or DIV with class of "caption".  For example:
+
 
+
<pre>
+
&lt;p class = "caption"&gt;
+
&lt;img src = "...."&gt;
+
&lt;strong&gt;Caption for Figure&lt;/strong&gt;
+
&lt;p&gt;
+
 
+
&lt;div class = "caption"&gt;
+
&lt;table&gt;
+
&lt;tr&gt;...&lt;/tr&gt;
+
&lt;/table&gt;
+
&lt;/div&gt;
+
</pre>
+
 
+
Captions for figures appear beneath the figure, centered, with "Figure X:" in bold, the descriptive text in sentence case, plain text.
+
 
+
Captions for tables and code appear above the table, centered, with "Table X:" in bold, the descriptive text in sentence case, plain text.
+
 
+
== Code ==
+
 
+
Code samples entered as preformatted text, as in the following example, are automagically color highlighted in Wordpress by the [http://wordpress.org/extend/plugins/syntaxhighlighter/ SyntaxHighlighter] plugin:
+
 
+
<pre>
+
&lt;pre&gt;
+
[sourcecode language='php']
+
RAW HTML/PHP/XML/Etc. code goes here; change language (in above line) as needed
+
[/sourcecode]
+
&lt;/pre&gt;
+
</pre>
+
 
+
Supported formats include <tt>cpp, c, c++, c#, c-sharp, csharp, css, delphi, java, js, jscript, javascript, pascal, php, py, python, rb, ruby, rails, ror, sql, vb, vb.net, xml, html, xhtml, and xslt</tt>. Pretty much everything except <tt>perl</tt>.
+
  
 
== End of Document ==
 
== End of Document ==
  
=== Footnotes & Footnote References ===
+
=== Recommended Reference Style Discussion: ===
 
+
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 (layman's description) | COINS]] element after the note.
+
 
+
==== Recommended Reference Style Information: ====
+
 
+
[http://owl.english.purdue.edu/owl/resource/560/10/ APA Style Example (Purdue)]
+
  
[http://www.library.cornell.edu/resrch/citmanage/mla MLA Style Example (Cornell)]
+
[https://writing.wisc.edu/Handbook/DocCSE_NameYear.html Council of Science Editors (CSE) citation format] has been voted in as the official recommended style (see: [[Citation_discussion]])
  
[http://library.osu.edu/help/research-strategies/how-do-i-cite-references/cse-citation-guide CSE Style Example (Ohio State)]
+
=== Endnote & Endnote References ===
  
jrochkind's proposal: Citations should be clear and unambiguous, and reasonably consistent within an article. Authors are welcome but not required to use a formal style. Editors will ensure readability, clarity, and reasonable consistency of citations, but will not check citations for compliance with stylebooks.
+
A Bibliography and Notes section (if needed) immediately follows the last of the article's narrative text. References are indicated by author and year (Smith, 2007). Notes are indicated in the text by note number in square brackets [1]. More details can be found in the [[Code4Lib_Journal_WordPress_Input_Guidelines#Endnotes_style_and_HTML_coding|Input Guidelines for Endnotes]].  
  
==== Voting on Recommended Style: ====
+
CSE reference style is the Journal's recommended style for bibliographies.  An author may choose to use a different bibliographic reference style, but should follow that style accurately and consistently.
{| border="1" cellpadding="5" class="sortable"
+
|- style="text-align: left;"
+
  
!Name !! Recommend Style? (Y/N) !! Which Style? (Vote even if N)
+
Authors can refer to this guide for using the [[CSE Reference Style]]
|-
+
| Tim McGeary || Y || CSE
+
| J Rochkind || N ||
+
  
|-
+
Where notes refer to articles, books, etc., that are not available by direct link, insert a [[COinS (layman's description) | COINS]] element after the note.
| Your Name || Vote || Style
+
+
|}
+
  
 
=== About the Author ===
 
=== About the Author ===

Latest revision as of 20:32, 4 August 2018

A Note About This Guide

This is a brief style guide for authors. For information about styles and conventions used in marking up articles for WordPress, see: Code4Lib Journal WordPress Input Guidelines.

Start of Article

Article titles are in Title Case -- all major words capitalized. The title is followed by an abstract, which will be pulled from the excerpt section lower on the post page, and byline of the form "by Author" or "by Author 1, Author 2, and Author 3".

Headings

Major section headings are in "Title Case" -- all words capitalized, short words (the, a, in, up, over, about) should not be. Subheadings are in "Sentence case" -- only the first word is capitalized.

End of Document

Recommended Reference Style Discussion:

Council of Science Editors (CSE) citation format has been voted in as the official recommended style (see: Citation_discussion)

Endnote & Endnote References

A Bibliography and Notes section (if needed) immediately follows the last of the article's narrative text. References are indicated by author and year (Smith, 2007). Notes are indicated in the text by note number in square brackets [1]. More details can be found in the Input Guidelines for Endnotes.

CSE reference style is the Journal's recommended style for bibliographies. An author may choose to use a different bibliographic reference style, but should follow that style accurately and consistently.

Authors can refer to this guide for using the CSE Reference Style

Where notes refer to articles, books, etc., that are not available by direct link, insert a COINS element after the note.

About the Author

A sentence or two of brief biography, provided by the author(s), appears listed after the Notes.

Appendices

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