140
edits
Changes
m
Two options for images and other attached content/media: # use WordPress uploaded content managing feature, or # upload the content to our host '''Uploading files manually. '''
jrochkind found To upload images or other attached media / files, you will need to upload the WordPress content managing feature to be more of a pain than it was worth, so is uploading content our ibiblio host site manually. To do that, sftp to c4ljeditor@login.ibiblio.org. Ask jrochkind See the Administrivia tab in the shared "C4LJ Article Tracking" doc for the username and password for the c4ljeditor account (or see this [http://groups.google.com/group/c4lj-articles/browse_thread/thread/7d66327ef69c507a/6dceb7d578676334?lnk=gst&q=account+upload#6dceb7d578676334 post] on c4lj-articles).
====Code===='''Uploading media via WordPress'''
Put all code Before uploading files to WordPress, you will need to change permissions on the directory where you are putting the files.# Login to c4ljeditor@login.ibiblio.org. Ask Tom Keays for the password for the c4ljeditor account (or see this [http://groups.google.com/group/c4lj-articles/msg/fad004416f12ac25 post] on c4lj-articles).# Change the directory to /public/vhost/c/c4lj/html/wp-content/uploads/# WordPress tries to write the files to /public/vhost/c/c4lj/html/wp-content/uploads/[current year]/[current month]. If the current year or month directory does not yet exist, create them, "mkdir [current year]" or mkdir "[current month]" in <code><pre><the appropriate directory. Creating the directory while logged in makes the owner and group of the directory c4ljeditor and c4lj respectively. Wordpress will create the directories as nobody/code> tagsnobody.# Change the permissions on the [current month] directory from 755 to 777, "chmod 777 [current month]".# In the WordPress editor, click the "Add an Image" button.# Browse to and select your image/file.# Click the Upload button.# File in the Alternate text and Caption fields.# Select the size of the image you want to display in the article.# Click "Insert into Post".# On the ibiblio.org server, change the permissions on the current month's directory back to 775, "chmod 775 [current month]"
If 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 is , which works fine in a supported languageour wordpress html source, we can do syntax highlightingand 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.
it does syntax highlighting for you.
We're still deciding if we like the syntax highlighting, don't feel compelled to make it work if it's not working for you (but please let other editors know what your experience is). To make this work, you still wrap your Put all inline code in <code><pre></code> tags. Inside of ====Code Highlighting====If the <code><pre></code> tagsis in a supported language, but around your codewe can do syntax highlighting. Code samples entered as preformatted text, includeas in the following example, are automagically color highlighted in Wordpress by the [http://wordpress.org/extend/plugins/syntaxhighlighter/ SyntaxHighlighter] plugin: <pre> [sourcecode language='langcodephp']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/
Replace <Note: do not surround codewith <tt>langcode<pre></codett> with the appropriate code from the following list (if more than one option for a languagetags, any one as the <tt>[sourcecode]</tt> tag itself will work)generate the necessary HTML.
{|!Language!!Code|-|C++||cppFor more subtleties of code formatting, c, c++|-|C#||c#, c-sharp, csharp|-|CSS||css|-|Delphi||delphi, pascal|-|Java||java|-|JavaScript||js, jscript, javascript|-|PHP||php|-|Python||py, python|-|Ruby||rb, ruby, rails, ror|-|SQL||sql|-|VB||vb, vbsee this gist from editor Péter Király https://gist.net|-|XMLgithub.com/HTML||xml, html, xhtml, xslt|}pkiraly/c48193925ad3806c31ef010b58e8600f
Example: <pre>[sourcecode language='css']body {===Ampersand Issues==== font-size: 0We've had some problems with ampersand handling in the sourcecode sections.625emIf you notice extra amp; background-color: #0000ffs in your article, such as "& color: #ffff00amp; }[/sourcecode]<amp;/pre" and ">amp;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.
While you are editing Abstracts should be placed in the articleExcerpt box, there is a box labeled "Optional Excerpt" displayed a little ways below the "Post" field. Put If you do not see the Excerpt box, look under "Screen Options" in the top right of the page. Selecting the down arrow will display fields to show on the screen. Make sure that 'Excerpt' is selected. This will display the Excerpt (abstract here) input box on the page. Use HTML markup as appropriate. What you put in this field is what will be distributed in our syndication feed and what will appear before the article as the abstract.
Every article in issue 1 should be put in a category Posts will have "Issue 1Uncategorized"checked by default. Etc. This should make it easier Uncheck that box, and check the box next to generate the current issue specific RSS feeds and do other stuff at , which will be a later datesubcategory of "Issues. " Do not check the "Issues" category. We generally do not add tags, except for Conference reviews
[[Category:Code4Lib Journal]]==Publishing an Issue==
==Dates # Let everyone on the c4lj-articles list know you are getting ready to publish (so they can save and close any open articles).# Log in to WordPress# Make sure that all articles for the issue have the correct issue category selected and have been set to 'Pending Review'. Make sure that the "Uncategorized" and "Issues" categories are unchecked (only the specific issue should be selected).# Sanity check: count the number of posts which should appear in the publish list# Click on Posts--order > Issues (on ToC==the left side)The dates # Click on "Publish" for the issue you'd like to publish.## You'll get a list of every "Pending Review" article in that issue. Make sure the number of articles in the list matches your previous count. Don't see all the articles you think you should see? They could be still in Draft status, or not in the correct Issue category, or still have "Uncategorized" selected, or someone may still have it in edit mode. Go back to the posts list and make any necessary changes, and start from #5 again.# Drag and drop the article titles until they're in Word Press control the order you want. The order you see there is the order you'll see on the home page (and probably the opposite of the order you'll see in your feed reader).## Note: It's the coordinating editor's responsibility to decide what order they will he or she would like the articles to show up in , and order them appropriately when publishing the issue. In general, we try to put the articles with the widest appeal first, and special types (columns, special reports, book reviews, etc.) at the end.# Click on Posts -> Categories (on the left side)# Make sure all three fields for the current issue table are filled in and correct:## The human-readable name of contentsthe issue goes into the Name field -- e.g., "Issue 15".## The date of publication goes into the Description field -- e.g., "2011-10-31".## The URL name goes into the Slug field -- e.g., "issue15" would give the URL of the issue, http://journal.code4lib.org/issues/issue15# Click "Publish Issue" (optionally setting the publication time, first). Setting the time should only have an impact on readers who are not logged into the c4lj site. Editors will be able to see the published articles.# Go to the Journal front page; check the number of articles is correct (again) and that they are in the right order. If there is a problem, go back to the admin interface, click on Posts -> Issues and click Unpublish for the issue. Make whatever corrections are needed and proceed from #5 again.# Once the issue is finally published, go to [[Code4Lib_Journal_Entries_in_Directory_of_Open_Access_Journals]] and follow the directions to upload the issue metadata to DOAJ.# Submit URLS to Internet Archives for harvest ([https://gist.github.com/ruthtillman/fa7562989f299e4904c7fb0448d1fc83#file-waybacksubmit-py Wayback Submission Script] )# Send out announcements (see [[Code4Lib_Journal_Publicity_Venues]])# Update [http://journal.code4lib.org/editorial-committee#coordinating Coordinating Editor] on the Editorial Committee page to state the name of the editor for the next issue.
I think it's ==Corrections==See [http://groups.google.com/group/c4lj-articles/browse_thread/thread/8eaabcff2d9c000d/a0aeeb9367fcea5f?lnk=gst&q=errata#a0aeeb9367fcea5f|the coordinating editoreditors's responsibility list] for how to decide what order he or she would like them to show up in, and set the dates appropriatelymake corrections. For issue 1Generally, I did this by setting them all to use an Errata or Correction section at the same date, and mucking end with information about the change that was made and have the actual hour/minute/second time text link down to control order. The most 'recent' (ie, the latest) time will show up firstthat section.See also [[Code4Lib_Corrections]]
<del>I also made a mistake with issue 1 though, thinking the date didn't really matter except for this. In fact, the date/time should be set as close to the actual publication (that is, making public) time as reasonably possible to keep feed readers from getting confused. When I had the date of the post set to a few days before the actual make-public time, this caused the code4lib planet feedreader to put the posts down at the bottom of it's screen the first time they showed up in the feed, since it was ordering by date (reversed). So coordinating editor should probably set the date/hour to be close to date of actual publication, and then mess with minutes to determine order on ToC?</del> Don't worry about exactly which date and time you use, just make sure they're in order. The Issue Manager plugin will take care of setting it to the right date.[[Category:Code4Lib Journal]]
→Bibliographies/Endnotes
==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/wp-admin/). If you don't have a WordPress editor login and need one, talk to our web admin (Jon BrinleyTom 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===
In-line images should be no wider than 500px. See above section for captioning and image
Change directory to:
/public/vhost/c/c4lj/html/media
in there you'll find an "issue1" subdir (or issueX 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/smith/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)
=====Code Highlighting=Video ====
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 extensionmextension, so if you an "s" on the end of .php files, e.g.,it will display the code rather than try to interpret the page:
<filename>.phps
==Abstract==
Assigned editors are ultimately responsible for a good abstract. Authors aren't always the best at writing good abstracts for their articles, you should probably revise or even write a new one from scratch as necessary, even when the author has provided one. Some of the abstracts for my assigned articles haven't even mentioned what I consider the most significant features of the article.
==Bibliographies/Endnotes==
Items in a bibliography should be linked to the resource whenever possible. <!--We would like to provide COinS information with every appropriate citation that does not have a publically publicly accessible url. * Recommended It appears the COinS generator: at http://generator.ocoins.info/* Another option is to use the WP COinS pluginno longer in service. Open the Code tab An alternative is [https://www.zotero.org/download/ Zotero's stand alone citation software].After creating a citation, put the cursor before simply right click the citation, and click COinSchoose export / format: coins. Enter * Paste the appropriate informationoutput provided at the end of the reference in HTML. This works so-so You will need to delete the line breaks inserted into the output created by the generator for journals, and not at all for booksit to work properly.
* 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 that . Square brackets themselves are not part of the link. HTML coding examplefor 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)", 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==
==WordPress Buttons==
:Use for not yet complete articles. Only editors can see these.
;Pending Review
:Use for sharing the article with authors. Editors and anyone logged in with user ID 17 (i.e., the author account) can see these. See this [http://groups.google.com/group/c4lj-articles/browse_thread/thread/d31f58a145ef877b/1ed35fa6bcd01e86?lnk=gst&q=author+preview#1ed35fa6bcd01e86 1231b06c09f1289f post] on c4lj-articles for the login information for the author account(username: author).
;Private
:We don't use this option anymore.
:A published post is visible to everyone. It is part of the RSS feed. If you're editing an already published post, don't select anything in the post status form, just hit Save.
