The Mailer Review/Volunteer/Remediating Articles: Difference between revisions
m Added shortcut. |
m →Title: Tweaked format. |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
{{Large|A Guide for Volunteer Digital Editors}} | {{Large|A Guide for Volunteer Digital Editors}} | ||
{{shortcut|PM:RA}} | {{shortcut|PM:RA}} | ||
{{Byline|last=Lucas|first=Gerald R.|abstract=A digital editor’s guide for remediating print articles to digital for ''{{MR}}''.}} | {{Byline|align=right|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 42: | Line 42: | ||
If you clicked on the red link to begin creating the article, the title has been chosen for you. However, we want to tweak the display title, so we have to use a code called <code><nowiki>{{DISPLAYTITLE}}</nowiki></code>. With this element, you can insert necessary text formatting, like [[w:MOS:ITALIC|italics]]: | If you clicked on the red link to begin creating the article, the title has been chosen for you. However, we want to tweak the display title, so we have to use a code called <code><nowiki>{{DISPLAYTITLE}}</nowiki></code>. With this element, you can insert necessary text formatting, like [[w:MOS:ITALIC|italics]]: | ||
<code><nowiki>{{DISPLAYTITLE:<span style="font-size:22px;">{{BASEPAGENAME}}/</span>{{SUBPAGENAME}}}}</nowiki></code> | |||
<code><nowiki>{{DISPLAYTITLE:<span style="font-size:22px;">{{BASEPAGENAME}}/</span>{{SUBPAGENAME}}}}</nowiki></code | |||
The <code><nowiki><span></nowiki></code> tag shrinks the root page names to highlight the title of the page. The code above will work for most article titles. However, if the title contains italicized elements, like the title of a novel, you must replace <code><nowiki>{{SUBPAGENAME}}</nowiki></code> with the actual title, so you can include the italics. For example: | The <code><nowiki><span></nowiki></code> tag shrinks the root page names to highlight the title of the page. The code above will work for most article titles. However, if the title contains italicized elements, like the title of a novel, you must replace <code><nowiki>{{SUBPAGENAME}}</nowiki></code> with the actual title, so you can include the italics. For example: | ||
<code><nowiki>{{DISPLAYTITLE:<span style="font-size:22px;">{{BASEPAGENAME}}/</span>''An American Dream'': The Singular Nightmare}}</nowiki></code> | |||
<code><nowiki>{{DISPLAYTITLE:<span style="font-size:22px;">{{BASEPAGENAME}}/</span>''An American Dream'': The Singular Nightmare}}</nowiki></code | |||
Putting two apostrophes (<code><nowiki>''</nowiki></code>) on both sides of <code><nowiki>An American Dream</nowiki></code> will italicize the novel’s name in the published document (see [[mediawikiwiki:Help:Formatting|Help:Formatting]]); check out the [[The Mailer Review/Volume 1, 2007/An American Dream: The Singular Nightmare|published article]]. Once you’ve entered your title, click the “Show preview” button under the editor window to see the results.{{efn|Get into the habit of clicking this button with every bit that you add to the article. It allows you to quickly see if you’ve made a mistake, so you can fix it before saving.}} Note that the title must otherwise be exactly the same, or the system will ignore the code and spit out an error. If it does, just review your code carefully and fix what’s needed. | Putting two apostrophes (<code><nowiki>''</nowiki></code>) on both sides of <code><nowiki>An American Dream</nowiki></code> will italicize the novel’s name in the published document (see [[mediawikiwiki:Help:Formatting|Help:Formatting]]); check out the [[The Mailer Review/Volume 1, 2007/An American Dream: The Singular Nightmare|published article]]. Once you’ve entered your title, click the “Show preview” button under the editor window to see the results.{{efn|Get into the habit of clicking this button with every bit that you add to the article. It allows you to quickly see if you’ve made a mistake, so you can fix it before saving.}} Note that the title must otherwise be exactly the same, or the system will ignore the code and spit out an error. If it does, just review your code carefully and fix what’s needed. | ||
Line 72: | Line 68: | ||
The byline template <code>{{tl|byline}}</code> should come next. It will include the writer’s or editor’s name, an abstract (if applicable), a note(s) (if applicable), and a short url. Here’s an example of the <code>byline</code> code: | The byline template <code>{{tl|byline}}</code> should come next. It will include the writer’s or editor’s name, an abstract (if applicable), a note(s) (if applicable), and a short url. Here’s an example of the <code>byline</code> code: | ||
<code><nowiki>{{Byline|last=Dickstein|first=Morris|url=https://prmlr.us/mr07dick|abstract=Mailer has been . . . uniform edition.|note=This paper served . . . me to participate.}}</nowiki></code> | |||
<code><nowiki>{{Byline|last=Dickstein|first=Morris|url=https://prmlr.us/mr07dick|abstract=Mailer has been . . . uniform edition.|note=This paper served . . . me to participate.}}</nowiki></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. | 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. | ||
Line 91: | Line 85: | ||
== 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 102: | Line 96: | ||
Many articles use block quotation when quoting longer passages of primary texts. Just paste in the quotation like you would a paragraph, then surround it with the <code><nowiki><blockqoute> . . . </blockquote></nowiki></code> tags, for example: | Many articles use block quotation when quoting longer passages of primary texts. Just paste in the quotation like you would a paragraph, then surround it with the <code><nowiki><blockqoute> . . . </blockquote></nowiki></code> tags, for example: | ||
<code><nowiki><blockquote>To the savage, dread was the natural result of any invasion of the supernatural: if man wished to steal the secrets of the gods, it was only to be supposed that the gods would defend themselves and destroy whichever man came too close. By this logic, civilization is the successful if imperfect theft of some cluster of these secrets, and the price we have paid is to accelerate our private sense of some enormous if not quite definable disaster which awaits us.{{sfn|Mailer|1965|p=159}}</blockquote></nowiki></code> | |||
<code><nowiki><blockquote>To the savage, dread was the natural result of any invasion of the supernatural: if man wished to steal the secrets of the gods, it was only to be supposed that the gods would defend themselves and destroy whichever man came too close. By this logic, civilization is the successful if imperfect theft of some cluster of these secrets, and the price we have paid is to accelerate our private sense of some enormous if not quite definable disaster which awaits us.{{sfn|Mailer|1965|p=159}}</blockquote></nowiki></code | |||
Note this quotation contains a citation—as all quotations should; see [[#Sourcing|Sourcing]] below for an explanation. | Note this quotation contains a citation—as all quotations should; see [[#Sourcing|Sourcing]] below for an explanation. | ||
Line 110: | Line 102: | ||
=== Images === | === Images === | ||
Most articles will not contain images. However, for those that do, see [[The Mailer Review/Volunteer/Advanced Editing|Advanced Editing]]. | Most articles will not contain images. However, for those that do, see [[The Mailer Review/Volunteer/Advanced Editing|Advanced Editing]]. | ||
=== Page Numbers === | |||
In order to aid researchers who still rely on the conventions of print culture, we will insert page numbers on our articles as they appear in the print version. For this use the <code>{{tl|pg}}</code> template, like: | |||
<code><nowiki>{{pg|first page #|next page #}}</nowiki></code> | |||
For example, indicating a page break after page 203 would look like: | |||
<code><nowiki>{{pg|203|204}}</nowiki></code> | |||
This code can be inserted directly in a paragraph. See [[The Mailer Review/Volume 1, 2007/An American Dream: The Singular Nightmare|this article]] for an example. | |||
== Endnotes == | == Endnotes == | ||
This section houses an author’s explanatory endnotes or footnotes, like the “Notes” section at the bottom of this page. Notes may be inserted in the body of the text, using <code>{{tl|efn}}</code>, for example: | This section houses an author’s explanatory endnotes or footnotes, like the “Notes” section at the bottom of this page. Notes may be inserted in the body of the text, using <code>{{tl|efn}}</code>, for example: | ||
<code><nowiki>. . .opportunity with a "lady's magazine",{{efn|In ''Double Life'', Lennon explains that Pearl Kazin, an editor at ''Harper's Bazaar'' had invited Mailer to write something for the magazine, to which Mailer replied: "I'm still too young and too arrogant to care to write the kind of high-grade horseshit you print in ''Harper's Bazaar''" (142–43).}} Mailer conceived . . .</nowiki></code> | |||
<code><nowiki>. . .opportunity with a "lady's magazine",{{efn|In ''Double Life'', Lennon explains that Pearl Kazin, an editor at ''Harper's Bazaar'' had invited Mailer to write something for the magazine, to which Mailer replied: "I'm still too young and too arrogant to care to write the kind of high-grade horseshit you print in ''Harper's Bazaar''" (142–43).}} Mailer conceived . . .</nowiki></code | |||
This note will be indicated by a superscript, small letter, like <sup>[a]</sup> —except it will be a hyperlink. Now, you must have place for these notes to be listed near the end of the document, just above the Citations section: | This note will be indicated by a superscript, small letter, like <sup>[a]</sup> —except it will be a hyperlink. Now, you must have place for these notes to be listed near the end of the document, just above the Citations section: | ||
<code><nowiki>=== Notes ===</nowiki><br /> | |||
<code><nowiki>=== Notes ===</nowiki><br /> | <nowiki>{{notelist}}</nowiki></code> | ||
<nowiki>{{notelist}}</nowiki></code | |||
See [[The Mailer Review/Volume 9, 2015/“Up to the Nostrils in Anguish”: Mailer and Bellow on Masculine Anxiety and Violent Catharsis|this article]] for another, more complex example. For a more thorough discussion of this function, see [[w:Template:Efn|Template:Efn]] on Wikipedia. | See [[The Mailer Review/Volume 9, 2015/“Up to the Nostrils in Anguish”: Mailer and Bellow on Masculine Anxiety and Violent Catharsis|this article]] for another, more complex example. For a more thorough discussion of this function, see [[w:Template:Efn|Template:Efn]] on Wikipedia. | ||
Line 131: | Line 130: | ||
== 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 === | ||
A list of works cited should be the last section in the document. It is sorted alphabetically by author’s last name and uses [[w:Wikipedia:Citation templates|citation templates]]. This is easier for two reasons: (1) you only need to list the reference '''once''' in the article, and (2) it cleans up your body text of much of the confusing code. This section is created like this: | A list of works cited should be the last section in the document. It is sorted alphabetically by author’s last name and uses [[w:Wikipedia:Citation templates|citation templates]]. This is easier for two reasons: (1) you only need to list the reference '''once''' in the article, and (2) it cleans up your body text of much of the confusing code. This section is created like this: | ||
<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= |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 /> | <code><nowiki>* {{cite news |last= |first= |date= |title= |url= |work= |location= |access-date= |ref=harv }}</nowiki></code><br /> | ||
<code><nowiki>* {{cite news |last= |first= |date= |title= |url= |work= |location= |access-date= |ref=harv }}</nowiki></code><br /> | <code><nowiki>* {{cite web |url= |title= |last= |first= |date= |website= |publisher= |access-date= |quote= |ref=harv }}</nowiki></code><br /> | ||
<code><nowiki>* {{cite web |url= |title= |last= |first= |date= |website= |publisher= |access-date= |quote= |ref=harv }}</nowiki></code><br /> | <code><nowiki>{{Refend}}</nowiki></code><br /> | ||
<code><nowiki>{{Refend}}</nowiki></code><br / | |||
This might look a bit confusing, but I’ll go through it. The first line adds a new section to the article. All references should appear between <code><nowiki>{{Refbegin}}</nowiki></code> and <code><nowiki>{{Refend}}</nowiki></code> in a bulleted list (notice each reference is on its own line and begins with <code><nowiki>*</nowiki></code>. | This might look a bit confusing, but I’ll go through it. The first line adds a new section to the article. All references should appear between <code><nowiki>{{Refbegin}}</nowiki></code> and <code><nowiki>{{Refend}}</nowiki></code> in a bulleted list (notice each reference is on its own line and begins with <code><nowiki>*</nowiki></code>. | ||
Line 155: | Line 154: | ||
For in-text citations, what will usually appear as MLA-style parenthetical, we use [[w:Template:Sfn|shortened footnotes]] <code><nowiki>{{sfn}}</nowiki></code>. First, add a section where your citations will appear, just above your works cited section: | For in-text citations, what will usually appear as MLA-style parenthetical, we use [[w:Template:Sfn|shortened footnotes]] <code><nowiki>{{sfn}}</nowiki></code>. First, add a section where your citations will appear, just above your works cited section: | ||
<code><nowiki>===Citations===</nowiki></code><br /> | |||
<code><nowiki>===Citations===</nowiki></code><br /> | <code><nowiki>{{Reflist}}</nowiki></code> | ||
<code><nowiki>{{Reflist}}</nowiki></code | |||
Here’s an example of the shortened footnote at work in the body of the article: | Here’s an example of the shortened footnote at work in the body of the article: | ||
<code><nowiki>. . . first published in ''New Short Novels 2'', 1956.{{sfn|Lennon|2018|p=25}}</nowiki></code> | |||
<code><nowiki> | |||
</ | 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. |