Changes

Jump to: navigation, search

Code4Lib Journal WordPress Input Guidelines

1,584 bytes added, 19:04, 10 February 2021
no edit summary
==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 (Jon BrinleyTom Keays).
==Proofs for Authors==
==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>&lt;em&gt;</code> for emphasized text, <code>&lt;strong&gt;</code> for strongly emphasized text, <code>&lt;blockquote&gt;</code> when quoting blocks of text. Avoid such monstrosities as <code>&lt;font&gt;</code> and <code>&lt;blink&gt;</code>. ===Headings===The top-level header (<code>&lt;h1&gt;</code>) is used for the title of the post, so start with second-level headers (<code>&lt;h2&gt;</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>&lt;emh3&gt;</code> for emphasized textsub-sections, <code>&lt;strongh4&gt;</code> for strongly emphasized text, if you need a lower level. <code>&lt;blockquoteh2&gt;</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>&lt;fonth3&gt;</code> and <code>&lt;blinkh4&gt;</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===
Alternatively, use the [http://www.textfixer.com/html/convert-word-to-html.php Word DOC to HTML converter].
===Images and Attached ContentFigures & Tables===Figures and tables are centered, placed inside a P or DIV with class of "caption". In-line images should be no wider than 500pxgeneral, we bold the figure / table label using the strong tag.
The caption for an image should be entered in a p with class="caption"For example:<nowikipre><p class="caption">Figure 1. How to Caption an Image.</p> </nowiki>In general, we bold the figure / table label using the strong tag:<nowiki><p classimg src ="caption...."><strong>Figure 1X.</strong> How to Caption an Image.</p></nowiki>
<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
'''Uploading files manually'''
/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)
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 jrochkind 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 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/nobody.
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>&lt;pre&gt;</code> tags.
====Code Highlighting====
 
If the code is in a supported language, we can do syntax highlighting.
ibiblio has a PHPS extensionmCode samples entered as preformatted text, so if you an "s" on as in the end of .php filesfollowing example, e.g., <filename>.phpsit does syntax highlighting for you. We're still deciding if we like are automagically color highlighted in Wordpress by 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). Around your code, include [sourcecode language='langcode']http://wordpress...[org/extend/plugins/syntaxhighlighter/sourcecodeSyntaxHighlighter]plugin:
Replace <codepre>langcode<[sourcecode language='php']RAW HTML/PHP/XML/Etc. code> with the appropriate code from the following list (if more than one option for a language, any one will work). If the goes here; change language parameter is not set, it will default to "text" (no syntax highlightingin above line). For a full list consult: http:as needed[/sourcecode]</en.support.wordpress.com/code/posting-source-code/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/
{|!Language!!Code|-|C++||cppNote: do not surround code with <tt>&lt;pre&gt;</tt> tags, 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|-|Text||text (e.g. .conf file)|-|VB||vb, vb.net|-|XMLas the <tt>[sourcecode]</tt> tag itself will generate the necessary HTML||xml, html, xhtml, xslt|}.
Example:For more [sourcecode language='css'] body { font-sizesubtleties of code formatting, see this gist from editor Péter Király https: 0//gist.625em; background-color: #0000ff; color: #ffff00; } [github.com/pkiraly/sourcecode]c48193925ad3806c31ef010b58e8600f
====Ampersand Issues====
==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/ is no longer in service. ** If using this generator, enter '(COinS)' in the box for COinS Default Text and 'http An alternative is [https://journalwww.code4libzotero.org/coinsdownload/ Zotero' in s stand alone citation software].After creating a citation, simply right click the box for COinS Default Link at the bottomcitation and choose export / format: coins.** Paste the output provided at the end of the reference in HTML. You will need to delete the line breaks inserted into the output created by the generator for it to work properly.* Another option is to use 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 at all for books.
* 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>]'''
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==
Posts will have "UncagetorizedUncategorized" checked by default. Uncheck that box, and check the box next to the current issue, which will be a subcategory of "Issues." Do not check the "Issues" category. We generally do not add tags, except for Conference reviews
==WordPress Buttons==
# 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] )
# In the article tracking spreadsheet, cut the article rows from the current issue sheet and paste them at the bottom of the "Published" sheet. Delete current issue sheet now that it is empty.
# Send out announcements (see [[Code4Lib_Journal_Publicity_Venues]])
# Update [[http://journal.code4lib.org/editorial-committee#coordinating Coordinating Editor]] on the Editorial Committee page to list state the name of the editor for the next issue.
==Corrections==
8
edits

Navigation menu