8
edits
Changes
no edit summary
Please follow the guidelines below when creating or editing Code4Lib Journal articles in WordPress. Enter all articles as "Posts".
==The WP Admin Interface==
To get to WordPress interface for entering an article, choose 'Site Admin' from the footer of any Journal page, login if necessary, and then choose Write//Write Post from the WP admin menus. (Alternatively, go to http://journal.code4lib.org/wp-admin/). If you don't have a WordPress editor login and need one, talk to our web admin (Tom Keays).
==Proofs for Authors==
A read-only login that is shared with authors can be found in the 'Administrivia' tab/worksheet of our Google Docs article tracking spreadsheet.
==Title==
Title, including the subtitle, goes in the "Title" field.
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".
==Article Content==
The body of the article goes in the "Post" field. Use HTML markup appropriately and semantically, ''e.g.'', <code><em></code> for emphasized text, <code><strong></code> for strongly emphasized text, <code><blockquote></code> when quoting blocks of text. Avoid such monstrosities as <code><font></code> and <code><blink></code>. ===Headings===The top-level header (<code><h1></code>) is used for the title of the post, so start with second-level headers (<code><h2></code>) for sections of the article. Any header from second- to sixth-level may be used as appropriate. Use HTML markup appropriately and semantically, ''e.g.'', <code><emh3></code> for emphasized textsub-sections, <code><strongh4></code> for strongly emphasized text, if you need a lower level. <code><blockquoteh2></code> when quoting blocks of textare in "Title Case" -- all words capitalized, short words (the, a, in, up, over, about) should not be. Avoid such monstrosities as <code><fonth3></code> and <code><blinkh4></code>are in "Sentence case" -- only the first word is capitalized. Any header from second- to sixth-level may be used as appropriate.
===Pasting from Word===
If you just paste content from Word into WP, it ends up with REALLY BAD html. Fortunately, WP has a built-in feature to help with this. Open the 'advanced toolbar' in editing GUI (right-most link), then click on the paste-from-word icon. This transforms Word's html into really nice pretty html. Alternatively, use the [http://www.textfixer.com/html/convert-word-to-html.php Word DOC to HTML converter].
===Figures & Tables===
Figures and tables are centered, placed inside a P or DIV with class of "caption". In general, we bold the figure / table label using the strong tag.
For example:
<pre>
<p class = "caption">
<img src = "....">
<strong>Figure X.</strong> How to Caption an Image.
</p>
<div class = "caption">
<strong>Table X.</strong> How to Caption a Table.
<table>
<tr>...</tr>
</table>
</div>
</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.
===Images and Attached Content===
Change directory to:
/public/vhost/c/c4lj/html/media
in there you'll find an "issue1" subdir. Inside THERE (or other issue dirissueX subdir--if you don't, create one or ask for help creating one!). Inside THERE, create a subdir with the last name of the first author, and put all your image and other attached content in there. It will now have this This sort of urlwill be used in the "<img src>" tag:http://journal.code4lib.org/media/issue1/lastnamesmith/imagename.png
Add to your img src or a href's as desired. You can use this not just for images, but for extended code attachments, etc. (see below)
====External ContentVideo ==== We haven't had too much video, but we just had one (a screencast). The option we used was hosting on archive.org. Upload the video, click on the IA 'pillars' icon on the resulting video on the archive.org page to get an 'iframe' embed code, which works fine in our wordpress html source, and I believe the archive.org infrastructure will take care of translating the video to multiple formats and delivering in the proper format for a given browser. Very convenient. Include a visible link to the archive.org URL for the individual video page as a caption, so printed or otherwise captured versions of the article will always have that link. You don't need to use archive.org if you or we figure out a better way, it's just one option that worked very conveniently so far. ===Code=== If code is attached as a file, follow the directions above for attached images, except: * If there is not a folder for the author, create it, according to the guidelines above for images* Create a subfolder under the author's folder for "code". Insert code files here* In the article link to the files using the path format http://path-to-the-server/media/issueNumber/authorname/code/filename (e.g., http://journal.code4lib.org/media/issue1/smith/code/something.pl) ibiblio also has a PHPS extension, so if you an "s" on the end of .php files it will display the code rather than try to interpret the page: <filename>.phps Put all inline code in <code><pre></code> tags. ====Code Highlighting====If the code is in a supported language, we can do syntax highlighting. 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> If the language parameter is not set, it will default to "text" (no syntax highlighting). Supported languages 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>. For a full list consult: http://en.support.wordpress.com/code/posting-source-code/ Note: do not surround code with <tt><pre></tt> tags, as the <tt>[sourcecode]</tt> tag itself will generate the necessary HTML. For more subtleties of code formatting, see this gist from editor Péter Király https://gist.github.com/pkiraly/c48193925ad3806c31ef010b58e8600f ====Ampersand Issues====We've had some problems with ampersand handling in the sourcecode sections. If you notice extra amp;s in your article, such as "&amp;amp;" and "&amp;amp;amp;", and you're comfortable using only the HTML editor for article entry, try checking the "Disable the visual editor when writing" box on your profile page in the admin.
==Abstract==
==Bibliographies/Endnotes==
Items in a bibliography should be linked to the resource whenever possible. <!--We would like to provide COinS information with every appropriate citationthat does not have a publicly accessible url. * To enter COinS, one option is to use It appears the WP COinS plugin. Open the Code tab, put the cursor before the citation, and click COinS. Enter the appropriate information. This works so-so for journals, and not generator at all for books. * You can also use jrochkind's umlaut coins generator:** books: http://finditgenerator.libraryocoins.jhuinfo/ is no longer in service.edu An alternative is [https:/search/books?umlautwww.display_coins=true** journals: http:zotero.org/download/finditZotero's stand alone citation software].libraryAfter creating a citation, simply right click the citation and choose export / format: coins.jhu* Paste the output provided at the end of the reference in HTML.edu:3000/search/journals?umlautYou will need to delete the line breaks inserted into the output created by the generator for it to work properly.display_coins=true
* COinS should really always have an ISSN or ISBN.
* Inside the span tag, put the string "(COinS)" with a link to our coins explanation page. Ie:
<pre><a href="http://journal.code4lib.org/coins">(COinS)</a></pre>
This is so the user without a browser extension will see that something is there she might be interested in, and get an explanation of COinS and how to make use of it. For an example see the [http://journal.code4lib.org/articles/7922 References section of a published article including coins].
-->
===Endnotes style and HTML coding===
* Endnote number in text: The number is the link which appears in square brackets. Square brackets themselves are not part of the link. HTML coding for the text: '''[<a id="ref1" href="#note1">1</a>]'''
* The link should work both ways. So, the endnote will link back to the text. HTML coding for the endnote: '''[<a id="note1" href="#ref1">1</a>]'''
==Author Information==
Start off each article with a paragraph stating the name(s) of the author(s). Something simple like "By Jonathan Rochkind". If desired, the author's name can be a link to something appropriate.
End each article with a second-level header that says "About the Author(s)", then with class="abouttheauthor" set. Then give a short paragraph about each author. Italicize the author's name when it is first used (for example, "''Foo Bar'' is a librarian at..."). We do want to have some kind of contact information published (personal web page, email address (obscured if desired), etc.) for each author. There is a box beneath the article-editing box with the label "Author(s)". Anything you put in this field will be treated as the author of the article. This will show up in the ToC and in the syndication feeds. If you don't populate this field, WordPress will use the username of the editor, instead.
==Categories/Tags==
[[Category:Code4Lib Journal]]