Code4Lib Style Guide - Revision history

DataGazetteer: Add link to CSE style guide

2018-08-04T20:32:19Z

Add link to CSE style guide

Bean: /* End of Document */

2015-03-27T12:25:06Z

‎End of Document

Samato: /* Headings */

2015-02-04T18:37:21Z

‎Headings

Samato at 18:36, 4 February 2015

2015-02-04T18:36:33Z

Tomkeays: /* Code */

2012-10-16T14:32:35Z

‎Code

Timmcgeary: /* End of Document */

2010-08-10T14:45:19Z

‎End of Document

Timmcgeary: /* End of Document */

2010-08-10T14:44:51Z

‎End of Document

Timmcgeary: /* End of Document */

2010-05-25T12:52:18Z

‎End of Document

Timmcgeary: /* End of Document */

2010-05-25T12:51:42Z

‎End of Document

Timmcgeary: /* End of Document */

2010-05-25T12:50:27Z

‎End of Document

@@ Line 16: / Line 16: @@
 === Recommended Reference Style Discussion: ===
-CSE has been voted in as the official recommended style (see: [[Citation_discussion]])
+[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]])
 === Endnote & Endnote References ===

@@ Line 20: / Line 20: @@
 === 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 either by note number in square brackets [1].
+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]].
-Bibliographies are recommended to follow CSE reference style.  An author may choose to use a different bibliographic reference style, but should follow that style accurately.
+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]]

← Older revision		Revision as of 18:37, 4 February 2015
Line 12:		Line 12:
	Subheadings are in "Sentence case" -- only the first word is capitalized.		Subheadings are in "Sentence case" -- only the first word is capitalized.

−
	== End of Document ==		== End of Document ==

@@ Line 1: / Line 1: @@
 == Start of Article ==
@@ Line 5: / Line 9: @@
 == 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>
-[sourcecode language='php']
-RAW HTML/PHP/XML/Etc. code goes here; change language (in above line) as needed
-[/sourcecode]
-</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>.
-−
-Note: do not surround code with <tt>&lt;pre&gt;</tt> tags, as the <tt>[sourcecode]</tt> tag itself will generate the necessary HTML.
 == End of Document ==

@@ Line 33: / Line 33: @@
 <pre>
 [sourcecode language='php']
 RAW HTML/PHP/XML/Etc. code goes here; change language (in above line) as needed
 [/sourcecode]
 </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 ==

@@ Line 54: / Line 54: @@
 Bibliographies are recommended to follow CSE reference style.  An author may choose to use a different bibliographic reference style, but should follow that style accurately.
-Authors can refer to this guide for using the [CSE Reference Style]
+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 (layman's description) | COINS]] element after the note.

@@ Line 44: / Line 44: @@
 == 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.
+CSE has been voted in as the official recommended style (see: [[Citation_discussion]])
-==== Recommended Reference Style Discussion: ====
+=== Endnote & Endnote References ===
-Editors, please vote at [[Citation_discussion]]
+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 either by note number in square brackets [1].
 === About the Author ===

← Older revision		Revision as of 12:52, 25 May 2010
Line 49:		Line 49:

	==== Recommended Reference Style Discussion: ====		==== Recommended Reference Style Discussion: ====
−
−	Tim McGeary proposes that the Editorial Committee chose a recommended style for all authors. Authors that do not choose recommended style need to follow another documented style and communicate that to their assigned editor. Using a documented style will provide a clear editorial guidelines for consistency, and ensure proper citations and references of literature and resources.
−
−	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.
−
−	~~==== Voting on Recommended Style: ====~~
−	~~{\| border="1" cellpadding="5" class="sortable"~~
−	~~\|- style="text-align: left;"~~

	Editors, please vote at [[Citation_discussion]]		Editors, please vote at [[Citation_discussion]]

@@ Line 58: / Line 58: @@
 |- style="text-align: left;"
-Editors, please vote at [Citation_discussion]
+Editors, please vote at [[Citation_discussion]]
 === About the Author ===

@@ Line 48: / Line 48: @@
 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: ====
+==== Recommended Reference Style Discussion: ====
 Tim McGeary proposes that the Editorial Committee chose a recommended style for all authors.  Authors that do not choose recommended style need to follow another documented style and communicate that to their assigned editor.  Using a documented style will provide a clear editorial guidelines for consistency, and ensure proper citations and references of literature and resources.
 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.
@@ Line 64: / Line 58: @@
 |- style="text-align: left;"
-!Name !! Recommend Style? (Y/N) !! Which Style? (Vote even if N)
+Editors, please vote at [Citation_discussion]
-|-
-| Tim McGeary || Y || CSE
-|-
-| J Rochkind || N ||
-|-
-| Carol Bean || Y || CSE
-−
-|-
-| Your Name || Vote || Style
-−
-|}
 === About the Author ===