User:Acunning40/guidelines/2.0

From DPWiki
Jump to navigation Jump to search

These are suggested guidelines changes (made in the forums or through other means) that were changed in guidelines revision 2.0 of March 2009.

Content changes

General

  • forumpost:220845: suggested reorganization by topics
  • try to get the order of topics to be pretty similar, if not the same, in the P & F guidelines
  • forumpost:206421: clarify that hyphenation still gets rejoined & em-dashes clothed despite the phrasing of "retain line breaks" in various places (in various sections of the guidelines, e.g. sidenotes & tables); see also forumtopic:30524
  • forumpost:187831: alphabetized TOC or index in each set of guidelines; see also forumpost:217532, the discussion before & after forumpost:317665, and forumpost:220845
  • forumtopic:19522: "Back to top" links in each section of the guidelines
  • forumpost:175420: link from one set of guidelines to the other at the top of each
  • forumpost:219814: change terminology: chapter & section "headings" not "headers"
  • briefly define what proofreading & formatting actually are
  • remove nested tables from examples--unnecessarily complicated markup, makes it harder to read the php file
  • look at margins: maybe right margin so that "Back to top" links stand out more
  • forumpost:461288: link to the wiki jargon guide
  • maybe use "at the ___ level" (using at rather than on) (suggestion made on Jabber, 6/7)

Proofreading

  • forumpost:187831: list all topics that are handled in formatting, not proofreading
  • forumpost:387282: add in thought breaks somewhere (added in preexisting formatting section)
  • forumpost:437148: mention parentheses -> curly brackets scannos
  • forumpost:461658: change the quiz link to show_only=PQ
  • usage of WordCheck (from PM received 6/5)

Formatting

  • forumpost:178066: and forumpost:220697 in the F guidelines, remove the parts that are identical to P (see Juliet's decision here)
  • include the statement "The markers will ensure the individual lines are not rewrapped during post-processing." where it's not already present for uses of /* */ markup
  • forumpost:317594: mention that markup should be closed on every page where it's opened
  • forumpost:462970: clarify placement & blank lines around /**/ and /##/ when appearing right before/after other markup (also forumpost:467313)

The Primary Rule

Proofreading

  • forumpost:222905: remove mention of italics & bold
  • maybe revise the phrase "consistently formatted" since now that implies formatting activities ("consistently formed")

Formatting

  • change EOL hyphenation to something F-related (since EOL hyphenation is now gone from F)

About This Document

  • forumpost:284001: clarify P/F distinction, and state which rounds each set of guidelines applies to

Fixing errors on Previous Pages

  • maybe move that first sentence up to the Project Comments section of the guidelines

Formatting

  • at the end of this section, there's a blank line in the F guidelines that's not present in the P guidelines (This is due to mismatched markup somewhere below, I think in one of the tables. Confirm that when markup is fixed the line sorts itself out.)

Double Quotes

Proofreading

  • forumpost:208950: guideline for quotes „like this” (use "these" or guillemets?)
  • revise the phrase "quotes from non-English languages" (really it means any form of double quotes that aren't "--right now could be interpreted to mean quoted material rather than the punctuation marks)
  • forumpost:468461: mention inserting the quote mark if necessary at the start of a chapter

Formatting

  • remove as proofreading-only

Single Quotes

Formatting

  • remove as proofreading-only

Quote Marks on each line

  • last paragraph in F version isn't in P

Proofreading

  • forumpost:174806: don't remove extra quote marks in poetry
  • make it clear that "each paragraph should have an opening quote mark" only applies to quote marks on each line (i.e. don't add opening quote marks to paragraphs where there aren't any to begin with)
  • add an example
  • forumpost:461715: change "the paragraph" to "each paragraph"
  • forumpost:463192: suggested combination of 1st 2 paragraphs

Formatting

  • remove as proofreading-only

End-of-sentence Periods

Formatting

  • remove as proofreading-only

Punctuation

Proofreading

  • forumtopic:19743: clarify which punctuation needs space before it and which doesn't
  • forumpost:222866: mention spacey quotes -- in Double Quotes
  • mention the need for a space after many punctuation marks, & that such a space should be inserted if it isn't there
  • change "comma" to something else, like colon, question mark, or exclamation point (commas & periods pretty much never have spaces before them in the scans, but the others often do)

Formatting

  • remove as proofreading-only

Extra spaces or tabs between Words

Formatting

Trailing Space at End-of-line

Proofreading

  • change this to say that the system removes end-of-line spaces upon save
  • forumtopic:23208: add "When the text is post-processed, ends of lines will be converted to spaces."

Formatting

  • remove as proofreading-only

Large, Ornate opening Capital letter (Drop Cap)

Formatting

  • remove as proofreading-only

Dashes, Hyphens, and Minus Signs

Proofreading

  • forumpost:218545: clarify em-dashes & long dashes, how to distinguish them; fix terminology ("long em-dash")
  • forumpost:271243: add example showing em-dash and long dash
  • forumpost:349205: add example for start-of-paragraph em-dash -- adapted in an existing example
  • forumtopic:20226: clarify wording for omitted/censored words
  • forumpost:252855: make it clear that the censored words part only applies when there's a dash in the original, not when the word is censored using asterisks or ellipses
  • 4th example: change the type to "Hyphen & Em-dash"
  • example that's listed as "Longer Em-dash" should be "Long dash"
  • forumpost:363345 put the instructions for SOP & EOP dashes here instead of under EOP Hyphenation -- moved EOP and EOL dashes to the hyphenation sections instead
  • forumpost:468461: rephrase "–14° below zero"
  • forumpost:470475: remove the mention of a possible PM exception for end-of-sentence em-dashes

Formatting

  • remove as proofreading-only

End-of-line Hyphenation

Proofreading

  • forumtopic:27139: remove "or dialog" from the note about clothing em-dashes
  • forumpost:461288: swap 2nd & 3rd paragraph to put all EOL hyphenation instructions together

Formatting

  • remove as proofreading-only

End-of-page Hyphenation

Proofreading

Formatting

  • remove as proofreading-only

Period Pause "..." (Ellipsis)

Proofreading

  • forumpost:326523: clarify ellipses: what counts as "ending punctuation", how to decide between 3 & 4 dots
  • forumtopic:27277: clarify ellipsis spacing with other punctuation, such as quotation marks
  • forumpost:379668: end-of-sentence instructions aren't clear (maybe talk about 3 dots + period instead of 4 dots?)
  • forumpost:463149: examples still not clear for phrase trailing off (suggested revision in following post)
  • forumpost:464863: include LOTE instructions in random rule

Formatting

  • remove as proofreading-only

Contractions

Proofreading

  • say that this only applies to English (or that other languages should follow the modern spacing convention?)
  • "This was often an early printers' convention" -- it may have been common in the 1800s, but it wasn't in the 1600s or 1700s, so "early" doesn't seem accurate
  • forumpost:458245: mention whether or not this guideline applies to 'tis
  • forumpost:461305: maybe add in poetry to the list of situations where the PM is likely to ask for an exception to this guideline

Formatting

  • remove as proofreading-only

Fractions

Proofreading

  • forumpost:441695: put the instructions here that appear in the footnote to the Latin-1 shortcut tables

Formatting

  • remove as proofreading-only

Accented/Non-ASCII Characters

Proofreading

  • forumtopic:18516: clarify usage of degree, ordinal, superscript
  • forumpost:219799: mention that accentuation has changed over time, not to modernize (just a brief phrase near the start about matching the image)
  • maybe move the computer-specific information and shortcut tables to a separate document, just keeping the basic instructions in the guidelines? (this section of the guidelines seems more about how to use your computer than how to proof) -- moved to the end, but still in same document
  • briefly explain what "Latin-1" means; maybe change the title of the section to "Accents/Latin-1 Characters"? (not exactly, but there's now some info)
  • forumpost:460812ff: say to keep symbols as in the original, such as section symbol & ampersand
  • forumpost:461715: examples of words for ae & oe ligatures
  • forumpost:468461: reduce the stuff about different encodings for different PGs & DPs

Formatting

  • remove as proofreading-only

Characters with Diacritical marks

Proofreading

  • forumpost:281485: remove one of the options for ['x] vs. [/x], and [`x] vs. [\x]
  • forumpost:417340: markup for diacritics over more than one letter
  • "modifying diacritical marks" in utf-8 material -- German translation group comments, "There's no such thing in Unicode; that should be 'spacing modifier letters'."

Formatting

  • remove as proofreading-only

Non-Latin Characters

Proofreading

  • change the other languages part so that it doesn't imply you should leave the OCR garbage in place ("leave it as scanned")
  • the Cyrillic link seems to be broken (removed
  • does "Distributed Proofreaders" really need to be a link to the DP front page? (removed)
  • add link to DP Wiki Transliterating Greek article

Formatting

  • remove as proofreading-only

Superscripts

  • mention that this doesn't apply to footnote markers; link to the Footnotes section
  • forumpost:465208: remove scientific/technical exception (make it a PM-requested exception instead)

Proofreading

Subscripts

Proofreading

  • move braces to P (yes, per Juliet's email 4/7)

Italics

Proofreading

Formatting

  • forumtopic:23201: guidelines for italicized British currency: 9<i>l.</i> 4<i>s.</i> 1<i>d.</i> vs. <i>9l. 4s. 1d.</i>
  • forumtopic:26512 mark up paragraphs of italics separately
  • forumtopic:24100: italics and quotation marks
  • extra <tr> markup in table, before last example
  • forumpost:382738: change "entire section" to "entire paragraph"

Bold Text

Formatting

  • "Punctuation goes outside the bold tags ...": maybe change this sentence to "The placement of punctuation around bold tags follows the same rules as italics" or add a sentence like "See the italics section for examples of markup placement."
  • "Some Project Managers may specify in the Project Comments that bold text be rendered as all caps.": is this ever done now? If not, the line could be removed.

Spaced Out Text

Formatting

  • reference the italics section in some way for specifics of where to put markup

Font Changes

Formatting

  • reference the italics section in some way for specifics of where to put markup
  • maybe add something like "Some Project Managers may request that you" at the start of the first sentence, and make corresponding changes elsewhere in the section as necessary
  • define blackletter (email received 6/9)

Words in Small Capitals

Proofreading

  • forumtopic:25573: maybe change "they" in the last sentence to something more specific, like "the OCRed characters"
  • forumpost:461748: put this section next to drop caps (done by moving drop cap section)

Formatting

  • have the same rules apply for punctuation around markup here as elsewhere

Line Breaks

Proofreading

  • paragraph about extra blank lines missing in P
  • forumtopic:23208: clarify blank lines at the bottom of the page (now automatically removed)

Formatting

  • remove as proofreading-only

Chapter Headers

Formatting

Section Headers

Formatting

  • add example

Other Major Divisions

Formatting

  • make "chapter headings" a link (this is from me, 6/7)

Paragraph Spacing/Indenting

Proofreading

Page Headers/Page Footers

  • forumpost:468461: insert "usually" for the part about a chapter heading starting lower on the page than a page header

Proofreading

  • mention printer's marks (suggestion made by alisea on Jabber, 4/23)

Formatting

  • remove as proofreading-only (but the example should be retained; move that to Chapter Headers)

Thought Breaks

Formatting

  • "The proofreading interface has the "thought break" marker available to cut and paste.": this isn't mentioned in other cases where it's also true, like for italics and block quotes. Should probably remove this line (it was more relevant when it was a row of spaced stars)
  • forumtopic:30760: change "chapters" to "chapters or sections"
  • task:620: "Most paragraphs start on the line immediately after the end of the previous one" -- make it clear that this is talking about the image, not the proofed/formatted text
  • forumpost:461587: have an example with a regular paragraph break to distinguish it from a thought break (original image is here)
  • forumpost:466155: add the phrase "thought breaks" to the title of the section
  • forumtopic:18419: rows of dots representing omitted lines--treat as thought breaks?

Illustrations

Proofreading

Footnotes/Endnotes

  • forumpost:445835: "series of special characters": clarify that this applies even if there's only one such character
  • forumpost:463192: blank line before each footnote rather than between

Proofreading

  • forumtopic:22279: instruct proofers to remove punctuation from footnote tags
  • forumpost:415770: don't worry about continued footnotes (under common problems, new formatting section)

Formatting

  • forumpost:178764: footnotes in tables; see also forumpost:256685 (discussion continues onto the next page); maybe change to say footnotes stay where they are
  • "During formatting, this means:" any reason for this line? (previous paragraph could end with "This means:", but I don't see a reason for the "during formatting" part since these are the F guidelines anyway)
  • "the Project Manager may ask that you move the footnotes in-line": we can probably remove this whole line at this point, since I don't think we ever use in-line footnotes any more
  • unmatched parentheses in the paragraph starting "If a footnote continues on the next page..."

Paragraph Side-Descriptions (Sidenotes)

Block Quotations

Formatting

  • forumpost:275896: block quote markup for any text that's set apart, not just quoted text
  • forumtopic:19318: using /# #/ for chapter summaries (taken care of by the previous item)
  • move the 3rd paragraph to be the 1st (definition before explaining how to mark it)
  • "are often (but not always) printed with wider margins or in a smaller font size": maybe change this to something like "are distinguished from the surrounding text by wider margins, a smaller font size, or other means"
  • maybe change "The markers will ensure the block quotation is formatted properly during post-processing." to say something about indenting while still allowing for rewrap (i.e. say specifically what the markup does, not just that it makes it "formatted properly")
  • forumpost:462963: clarify blank lines (handled in new section for /##/ and /**/)

Multiple Columns

  • "placing the text from the left-most column first, the text from the next one after it" -- maybe change "after" to "below" to make this clearer

Proofreading

Formatting

  • remove as proofreading-only

Tables

  • forumpost:413665: mention how to proof/format curly braces that span multiple lines (replace 1st example with a new one showing braces)
  • forumtopic:23214: currently the raised decimal points in the "tables" example are shown proofed/formatted as periods. Should that be the default, or the middle dot? (remove example)

Proofreading

Formatting

  • forumtopic:318437ff: account for conversion to ASCII when aligning tables with inline markup
  • forumtopic:26512 mark up each table cell separately
  • say not to split tables in order to fit width

Poetry/Epigrams

Proofreading

  • forumtopic:22481: add example for long lines of poetry not rejoined (replaced existing example)
  • "Do insert a blank line between stanzas": possibly clarify that this is when there's a blank line in the original (sometimes people think an occasional indented line should get a blank line, like an indentation for a paragraph)
  • forumpost:463192: remove the line about footnotes

Line Numbers

Letters/Correspondence

Formatting

Right-aligned text

Formatting

Single word at bottom of page

Formatting

  • remove as proofreading-only

Blank Page

  • forumpost:443854: "If there is text in the proofreading text area and a blank image, or if there is an image but no text, follow the directions for a Bad Image or Bad Text." -- "an image but no text" could be misunderstood as talking about an illustration without a caption; adjust wording to talk about text in the image but nothing in the text box

Front/Back Title Page

Formatting

  • "<i>WITH FRONTISPIECE BY</i><;br><i>C. ALLAN GILBERT</i>": possibly use one set of italics here, not start & stop on each line
  • forumtopic:30057: printer's emblem isn't marked with [Illustration]

Table of Contents

  • remove the sentence about keeping the page numbers

Proofreading

  • forumpost:347856: reference small caps in some way
  • forumpost:461305: "Ignore any periods or asterisks" but the example has commas in the OCR so that isn't really covered by these instructions. Maybe make "periods or asterisks" more general (like "punctuation marks" or something)

Indexes

  • forumtopic:18520: reference multiple columns in the index section
  • forumpost:179091: clarify that the page numbers to be retained are those in the body of the index, not in the page headers. Maybe "page number references" (like in the TOC section of the F guidelines) rather than "page numbers" -- actually, just remove the phrase/sentence as it's no longer needed

Formatting

  • "the first word of each letter": this can be a bit confusing. Maybe change "letter" to "section"?
  • maybe remove the blank lines between main entries in the original for the 2nd example, to show that we insert a blank line anyway even if there isn't one in the original
  • forumpost:426278ff: "You don't need to align the numbers as they appear in the scan; just put a comma or semicolon, followed by the page numbers.": Clarify whether such punctuation should be added if there's none in the scan (and if so, which do you pick to add?).
  • add an example for a TOC-style index
  • forumpost:461544: mention that semicolons often identify new subentries

Plays: Actor Names/Stage Directions

  • fix use of the word "between" in "treat a change in speaker as a new paragraph, with one blank line between"
  • forumpost:461544: mention how to handle characters' names if they're on their own line and not clearly separated from the dialog in the image (see also the next item)
  • forumpost:468461: "please treat this like normal end-of-line hyphenation" change to "please rejoin the word as per normal..."

Proofreading

  • use of word "format" twice -- consider revising

Formatting

  • forumpost:182144: clarify blank lines for Acts & Scenes; see also forumpost:249321 (i.e. make the instructions more precise, giving # of blank lines for before and after acts & scenes, like the chapter headers section of the guidelines)
  • forumpost:192214: change "six" to "at least six"; or change the example to have exactly six (forumpost:405606)
  • "metrical plays: (Plays written as rhymed poetry)": it doesn't have to rhyme to be metrical. Maybe change this to mention capital letters at the start of each line, or the text not being justified, as indicative of meter (just removed the word "rhymed")
  • "metred": British spelling; generally the guidelines use American spelling, I think. Something to look at
  • forumpost:383086: markup placement in example
  • forumpost:461544: add the phrase "using the same 2, 4, 6, etc. spacing as poetry" in the indentation part; also, 3rd drama example has indentation with 9 spaces

Anything else that needs special handling or that you're unsure of

  • forumpost:209859: clarify leaving a note and posting in the discussion
  • forumtopic:19329: instructions to sign notes with the round
  • this section largely overlaps the "Previous Proofreaders' Notes" section that follows; maybe separate them better, or join them into one

Specific Guidelines for Special Books

Formatting

  • forumpost:223788: probably remove these special guidelines, or extensively revise them (remove)

Preexisting Formatting

Proofreading

OCR Problems: 1-l-I

Proofreading

  • add in something about Arabic numeral one often looking like a small-capped i (suggestion made on Jabber by yralih)

Formatting

  • remove as proofreading-only

OCR Problems: 0-O

Formatting

  • remove as proofreading-only

OCR Problems: Hyphens and Dashes

Formatting

  • remove as proofreading-only

OCR Problems: Scannos

Formatting

  • remove as proofreading-only

Handwritten Notes in Book

Formatting

  • remove as proofreading-only

Bad Image

  • forumpost:370392: require notifying the PM (by marking the page bad or posting in the project discussion) if there's a scan problem
  • forumpost:443875: button is only available in P1, so the instructions need to be revised
  • forumpost:461305: maybe add here a mention of zoom to figure out unclear spots

Wrong Image for Text

  • forumpost:443875: button is only available in P1, so the instructions need to be revised

Printer Errors/Misspellings

Inserting Special Characters

  • forumtopic:24229: The tables (both platforms) include œ, which is not in Latin-1
  • the chart is missing ý and Ý
  • fix background color left from capital Y w/umlaut (was removed in version 1.9.d)
  • multiplication symbol in Mac chart should use Dagger not dagger html entity
  • German translation group says, "Kchar is no longer part of a regular KDE distribution. It has been replaced by guchar."
  • forumpost:468461: say how to handle superscripts, not just link to the section


General things to check

  • check TOC against body
  • check for use of * in the source php (I think the utf-8 sections are the only spots where single *'s remain that should be [**notes])
  • sometimes there's a series of one-sentence paragraphs. Consider joining related sentences together to make fewer paragraphs
  • headings used on examples: for the "original," I'm seeing a combination of Original Image, Sample Image, Original Text, Scanned Text, and others. make consistent
  • usage of the word "need": sometimes the guidelines say "there is no need" for something that's optional, while other times it's just a polite way of saying "don't do it". Check the phrases "no need" & "not need" to make sure that each one is clear on whether it's required, optional, or forbidden. (see forumpost:284790 and the two after that for different interpretations of a given phrase)
  • links to other sections of the guidelines wherever needed (this is particularly lacking for references to the project discussion)
  • check capitalization of sections of the guidelines (e.g. "Extra spaces or tabs between Words"—strange capitalization!)
  • (from email received 10/10) avoid using "between" with a singular noun, as in: "a blank line between each footnote" and "a change in speaker ... with one blank line between". See email for possible revisions.
  • check image alts & table summaries
  • run the files through the W3C validator to check for markup errors
  • check locations of the "END RR" html comments


Proofreading summary

  • after the full guidelines are revised, add or remove things as necessary to address changes
  • forumtopic:16651: proofed text uses the dagger, which isn't Latin-1
  • forumtopic:18108: the poem near the end no longer rhymes.
  • forumtopic:18108: coöperate, prêt-à-porter)," and "Æsop, Cæsar," in the right column shouldn't be in bold
  • chapter title shouldn't be in bold
  • revise wording on dashes, clarifying long dashes vs. em-dashes (some done, but needs more extensive work later on)
  • "block quotes": P guidelines don't mention block quotes
  • add ellipses


Formatting summary

  • after the full guidelines are revised, add or remove things as necessary to address changes
    • in particular, remove proofing-only topics


Miscellaneous things to update

  • add appropriate entries to revision history for whatever gets changed in this update (mostly done, but a few minor things need to be filled in)
  • contact people about translation
  • update pdf shortcut charts to reflect the guidelines changes
  • update quizzes if needed
  • add a { } button in the proofreading interface
Retrieved from "https://www.pgdp.net/w/index.php?title=User:Acunning40/guidelines/2.0&oldid=53192"