The Mailer Review/Volunteer/Remediating Articles: Difference between revisions

m (→‎Working Banner: Added small detail.)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:<span style="font-size:22px;">{{BASEPAGENAME}}/</span>{{SUBPAGENAME}}}}
{{DISPLAYTITLE:<span style="font-size:22px;">{{BASEPAGENAME}}/</span>{{SUBPAGENAME}}}}
{{Large|A Guide for Volunteer Digital Editors}}
{{Large|A Guide for Volunteer Digital Editors}}
{{Byline|last=Lucas|first=Gerald R.|abstract=A digital editor’s guide for remediating print articles to digital for ''{{MR}}''.}}
{{shortcut|PM:RA}}
{{Byline|last=Lucas|first=Gerald R.|abstract=A digital editor’s guide for remediating print articles to digital for ''{{MR}}''. |url=http://prmlr.us/remediate}}
{{TOC right}}
{{TOC right}}
Welcome, volunteer, or Assistant Digital Editor. We’re glad you decided to lend your expertise and time in helping to grow our Digital Humanities project. This guide is written specifically for volunteer digital editors who want to help in moving, or “remediating,” our print version of ''{{MR}}'' to the digital version here on Project Mailer. Please read this document in for specific directions on remediating your article to be used on the screen.
Welcome, volunteer, or Assistant Digital Editor. We’re glad you decided to lend your expertise and time in helping to grow our Digital Humanities project. This guide is written specifically for volunteer digital editors who want to help in moving, or “remediating,” our print version of ''{{MR}}'' to the digital version here on Project Mailer. Please read this document in for specific directions on remediating your article to be used on the screen.
Line 19: Line 20:


=== Get Your Account ===
=== Get Your Account ===
First off, you need to request an account. If you have a particular user name in mind, let me know. Mine is '''Grlucas''', but yours can be anything you’d like. I will create an account for you with a temporary password using the email address you sent the request with. You will need to confirm your account, log in, and change your password. Then, you’re ready to edit. You might take a few minutes to created your user page by clicking your user name in the upper right, and adding a brief professional biography. If you are a student, this will likely be a requirement at some point.
First off, you need to request an account (see below under Get Your Article). If you have a particular user name in mind, let me know. Mine is '''Grlucas''', but yours can be anything you’d like. I will create an account for you with a temporary password using the email address you sent the request with. You will need to confirm your account, log in, and change your password. Then, you’re ready to edit. You might take a few minutes to created your user page by clicking your user name in the upper right, and adding a brief professional biography. If you are a student, this will likely be a requirement at some point.


=== Get Your Article ===
=== Get Your Article ===
Begin your journey by requesting an article from the editor. If you have no preference, just send an email to '''{{nospam|editor|projectmailer.net}}''' and ask for the next article, or request a red link article (meaning it needs to be added) from any [[{{ROOTPAGENAME}}|volume available]], being sure to give the volume number.{{efn|If you are editing as part of a class assignment, you likely will be assigned an article. Please see your syllabus for alternate directions.}} I will send you the article as a PDF from the above email address (be sure you whitelist it or check your spam folder if you do not receive it), including an abstract (if it has one) and writer biography.{{efn|PDF is how I get the final digital form of the journal, which is made for print, so it always contains digital errors. Part of our job is to be sure we catch and correct these errors.}}
Begin your journey by requesting an article from the editor; you can request an account with the same email. Send an email to '''{{nospam|editor|projectmailer.net}}''' and ask for the next article, or request a red link article (meaning it needs to be added) from any [[{{ROOTPAGENAME}}|volume available]], being sure to give the volume number.{{efn|If you are editing as part of a class assignment, you likely will be assigned an article. Please see your syllabus for alternate directions.}} I will send you the article as a PDF from the above email address (be sure you whitelist it or check your spam folder if you do not receive it), including an abstract (if it has one) and writer biography.{{efn|PDF is how I get the final digital form of the journal, which is made for print, so it always contains digital errors. Part of our job is to be sure we catch and correct these errors.}}


== Before Editing ==
== Before Editing ==
Line 65: Line 66:
Anything surrounded with double brackets calls a [[w:Help:A quick guide to templates|template]] to be [[w:Wikipedia:Transclusion|transcluded]]. Basically, templates are bits of code or boilerplate that can be used on multiple pages. This saves us from having to repeat the same information on multiple pages.
Anything surrounded with double brackets calls a [[w:Help:A quick guide to templates|template]] to be [[w:Wikipedia:Transclusion|transcluded]]. Basically, templates are bits of code or boilerplate that can be used on multiple pages. This saves us from having to repeat the same information on multiple pages.


This header should appear on the top of all ''Review'' content, just under the display title.
This header should appear on the top of all ''Review'' content, just under the display title. The header will also insert the correct volume category in at the bottom of the page (See '''Fig. 2''').


== Byline ==
== Byline ==
Line 75: Line 76:
</blockquote>  
</blockquote>  


For an explanation of all the variables, see <code>{{tl|byline}}</code>.
For an explanation of all the variables, see <code>{{tl|byline}}</code>. You needn’t worry about the “abstract,” “note,” or “url” variables; I’ll fill those in later, if necessary.


Once you’ve entered the code, check it by previewing. The author’s name should be in blue, showing that the link leads to his or her biography. If it’s red, check your spelling. I have entered all authors and editors, so this should be working correctly. Next, scroll to the bottom of the document. You should see the correct category listed (see '''Fig 2'''); we’ll discuss more categories below. This will either be “Written by First Last” or “Edited by First Last.” This link, too, should be blue.
Once you’ve entered the code, check it by previewing. The author’s name should be in blue, showing that the link leads to his or her biography. If it’s red, check your spelling. I have entered all authors and editors, so this should be working correctly. Next, scroll to the bottom of the document. You should see the correct category listed (see '''Fig 2'''); we’ll discuss more categories below. This will either be “Written by First Last” or “Edited by First Last.” This link, too, should be blue.
Line 83: Line 84:


{{Quote box|width=100%|align=center|title=Using Your Sandbox for Remediation|
{{Quote box|width=100%|align=center|title=Using Your Sandbox for Remediation|
The rest of the steps below could (should?) happen in your sandbox. This is a space where you can remediate (make edits and errors) without publishing to the main space. This way, you avoid unwanted attention until you are ready to transfer your article to it proper place. You can access your personal sandbox by clicking “Sandbox” on the top-right of this (and every) page.
The rest of the steps below could (should?) happen in your sandbox. This is a space where you can remediate (make edits and errors) without publishing to the main space. This way, you avoid unwanted attention until you are ready to transfer your article to it proper place. You can access your personal sandbox by clicking “Sandbox” on the top-right of this (and every) page. Put <code><nowiki>{{user sandbox|plain=yes}}</nowiki></code> at the top of your sandbox. This will put a banner on the top of your page notifying other users they are looking at your draft space.


I recommend this approach. Incomplete articles in the main space are fine; articles with errors should ''never'' appear there. A solid approach would be to edit (clean up typos, add references, tweak formatting, etc.) in your sandbox, then transfer each paragraph to the main space. After each paragraph, preview your article to see that you did not inadvertently introduce any errors. After a few paragraphs, save your work. With this approach, you can save a lot of time and potential headaches. For example, if you transfer an entire article from your sandbox, you might get a reference error. Tracking this down becomes much more difficult. If transfer by paragraph, then errors become much easier to identify and fix.
I recommend this approach. Incomplete articles in the main space are fine; articles with errors should ''never'' appear there. A solid approach would be to edit (clean up typos, add references, tweak formatting, etc.) in your sandbox, then transfer each paragraph to the main space. After each paragraph, preview your article to see that you did not inadvertently introduce any errors. After a few paragraphs, save your work. With this approach, you can save a lot of time and potential headaches. For example, if you transfer an entire article from your sandbox, you might get a reference error. Tracking this down becomes much more difficult. If transfer by paragraph, then errors become much easier to identify and fix.
Line 90: Line 91:
== Body ==
== Body ==
[[File:Mr-orig.jpg|thumb|400px|'''Fig 3'''. Original PDF. Copy the paragraph.]] [[File:Mr-errors.jpg|thumb|400px|'''Fig 4'''. Errors indicated.]] [[File:Mr-corrected.jpg|thumb|400px|'''Fig 5'''. Errors Fixed.]]
[[File:Mr-orig.jpg|thumb|400px|'''Fig 3'''. Original PDF. Copy the paragraph.]] [[File:Mr-errors.jpg|thumb|400px|'''Fig 4'''. Errors indicated.]] [[File:Mr-corrected.jpg|thumb|400px|'''Fig 5'''. Errors Fixed.]]
Here is where you remediate from PDF (essentially the printed page) to the wiki. Adding the body of the article will take the most effort and attention to detail, as many typos are introduced into the digital text as part of the PDF creation process. I recommend proceeding paragraph by paragraph.
Here is where you remediate from PDF (essentially the printed page) to the wiki. Adding the body of the article will take the most effort and attention to detail, as many typos are introduced into the digital text as part of the PDF creation process. I recommend proceeding paragraph by paragraph, as pasting the whole essay into the article and then trying to edit it will just be overwhelming. Take this a step at a time to maximize your attention to perfection.


Open the PDF, highlight and copy a paragraph, paste the paragraph into the editing window, and proofread for errors (see '''Figs. 3–5'''; click the images to enlarge). Common errors include hyphenated words (these will be broken words with a hypen and space), numbers, lack of necessary text decoration like italics, missing spaces, and superfluous print information like page numbers. All of these must be corrected. Use the original PDF as your guide. All text needs to be verbatim and look as much like the original document as possible.
Open the PDF, highlight and copy a paragraph, paste the paragraph into the editing window, and proofread for errors (see '''Figs. 3–5'''; click the images to enlarge). Common errors include hyphenated words (these will be broken words with a hypen and space), numbers, lack of necessary text decoration like italics, missing spaces, and superfluous print information like page numbers. All of these must be corrected. Use the original PDF as your guide. All text needs to be verbatim and look as much like the original document as possible.
Line 130: Line 131:
== Sourcing ==
== Sourcing ==
There are two approaches to sourcing, depending on the complexity of the author’s citations. If the article has just a handful of sources that are cited sparingly, you might just include them in the body of the article and just use a “Citations” section at the end of the document. If there are '''many sources''' that are '''cited multiple times''', you should have a “Citations” section and a “Works Cited” section and use the '''shortened footnotes''' approach. Most articles will use the latter approach.
There are two approaches to sourcing, depending on the complexity of the author’s citations. If the article has just a handful of sources that are cited sparingly, you might just include them in the body of the article and just use a “Citations” section at the end of the document. If there are '''many sources''' that are '''cited multiple times''', you should have a “Citations” section and a “Works Cited” section and use the '''shortened footnotes''' approach. Most articles will use the latter approach.
Please note: some articles, particularly creative pieces, transcripts, and some essays will not cite any secondary sources. If this is the case, then this section on sourcing may be skipped.


=== Works Cited ===
=== Works Cited ===
Line 137: Line 140:
<code><nowiki>===Works Cited===</nowiki></code><br />
<code><nowiki>===Works Cited===</nowiki></code><br />
<code><nowiki>{{Refbegin}}</nowiki></code><br />
<code><nowiki>{{Refbegin}}</nowiki></code><br />
<code><nowiki>* {{cite book |last= |first= |date= |title= |url= |location= |publisher= |pages= |isbn= |author-link= |ref=harv }}</nowiki></code><br />
<code><nowiki>* {{cite book |last= |first= |date= |title= |url= |location= |publisher= |pages= |ref=harv }}</nowiki></code><br />
<code><nowiki>* {{cite journal |last= |first= |title= |url= |journal= |volume= |issue= |date= |pages= |access-date= |ref=harv }}</nowiki></code><br />
<code><nowiki>* {{cite journal |last= |first= |title= |url= |journal= |volume= |issue= |date= |pages= |access-date= |ref=harv }}</nowiki></code><br />
<code><nowiki>* {{cite magazine |last= |first= |date= |title= |url= |magazine= |pages= |access-date= |ref=harv }}</nowiki></code><br />
<code><nowiki>* {{cite magazine |last= |first= |date= |title= |url= |magazine= |pages= |access-date= |ref=harv }}</nowiki></code><br />
Line 162: Line 165:


<blockquote>
<blockquote>
<code><nowiki>This novella was first published in ''New Short Novels 2'', 1956.{{sfn|Lennon|2018|p=25}}</nowiki></code>
<code><nowiki>. . . first published in ''New Short Novels 2'', 1956.{{sfn|Lennon|2018|p=25}}</nowiki></code>
</blockquote>
</blockquote>


This is a Wikipedia template. “Sfn” calls the template in the code; the author’s last name follows the first pipe (this must correspond with the name that follows <code><nowiki>|last=</nowiki></code> in the detailed citation in your works cited list); the year of the publication follows the next (exactly the same as <code><nowiki>|date=</nowiki></code> in the citation); and the page number(s) are put last. This will insert a footnote in the text; when a user clicks it, she is taken to the citation and if she clicks the citation, she is taken to the longer works cited entry. Notice its placement in the text: right up against the period with no space in between. Footnote indications should always come after punctuation; never before. Try it on the example article I linked above. Simple and elegant.
This is a Wikipedia template. “Sfn” calls the template in the code; the author’s last name follows the first pipe (this must correspond with the name that follows <code><nowiki>|last=</nowiki></code> in the detailed citation in your works cited list); the year of the publication follows the next (exactly the same as <code><nowiki>|date=</nowiki></code> in the citation); and the page number(s) are put last. This will insert a footnote in the text; when a user clicks it, she is taken to the citation and if she clicks the citation, she is taken to the longer works cited entry. Rendered on the page, it will look like:
 
: . . . first published in ''New Short Novels 2'', 1956.{{sfn|Lennon|2018|p=25}}
 
Notice its placement of the footnote code: '''right up against the period with no space in between'''. Footnote indications should always come ''after'' punctuation; never before. Try it on the example article I linked above. Simple and elegant.


See the [[w:Template:Sfn|Template:Sfn]] on Wikipedia for more options and explanation.
See the [[w:Template:Sfn|Template:Sfn]] on Wikipedia for more options and explanation.
Line 178: Line 185:


== Categories ==
== Categories ==
Finally, you need to add the appropriate categories to the article: the volume/year and type. The former is presented like <code><nowiki>[[Category:V.# 20xx]]</nowiki></code>, where <code><nowiki>#</nowiki></code> is the volume number and <code><nowiki>xx</nowiki></code> is the year that volume was published; for example <code><nowiki>[[Category:V.10 2016]]</nowiki></code>.
Article categories are classified as follows. Choose the most appropriate for the article you’re remediating:
Article categories are classified as follows. Choose the most appropriate for the article you’re remediating: