Difference between revisions 5094648 and 5095932 on enwikisource

{{process header
 | title    = {{TPSMProject}}<br />
 | section  = Proofreading guide 
 | previous = [[Wikisource:WikiProject Popular Science Monthly|Project home page]]
 | next     = 
 | shortcut = 
 | notes    =  Last update: 
}}

{{Dhr}}

{{TOCcenter}}

{{Dhr}}⏎

== Background information ==

* This manual is focused on the proofreading formats used in {{TPSMProject}}. The information here is specifically lays out the style for this project and information on templates and methods which are not not used, are omitted from this guide. Nevertheless, the information provided here may be of help in other projects.

* This project began in the autumn of 2009 and at the time of this writing in the autumn of 2014 five years later, we have 28 of 87 volumes proofread. The additional volumes no longer deal with the original premise of the publication, but they are available for proofreading.

* The elements of the project are standardized and consistency is enforced. This applies to the page layout, font sizes, article headers. ⏎
⏎
=== Breakdown of the approach used to proofread ===

* The volumes have no table of contents and this was constructed by paging through and collecting article titles, authors, tagging pages containing images and tables - and proofreading the indexes which are located at the back of each volume. 
* The content of the volume indexes also revealed what subject needs to be linked to the index (anchored).
* The titles and the volume indexes collected are stored in 87 offline MSAccess databases which are linked into a single master database which is also. This database contains the nearly 2,500 author names, identifies the list of identified monthly recurring article titlsections, formats the multipart article list, formats the main namespace article headers, generates author page headers and the volume indexes.

=== What was completed overall ===

* Article title pages.
* Index pages at the end of each volume.
* Pages with images.
* Pages with tables.
* Table of contents.
* Main namespace article pages.
* Major categorization of the main namespace articles.

=== What needs to be done ===

* Proofreading of pages.
* Inserting overlooked tables.
* Inserting overlooked images.
* Replacing font size templates with PSM specific font templates.
* Linking the volume index entry anchors to the titles.

=== Relevant namespaces, a short explanation ===

* Index namespace - Container storing the individual pages of a book.
* Page namespace - page by page storage contained by the Index container. It is where most of the work takes place, the proofreading of the pages.
* Transclusion process - links the proofread pages and the Main namespace.
* Main namespace - Assembled display of the transcluded pages from the Page namespace.⏎
⏎
== Typographic formats ==

=== Hyphenation ===

* Hyphenated words, which by themselves are correct, are left as is, being the typesetting style at the time.
* A hyphen at the end of line is often used to justify the text. Use your judgement if the words should be hyphenated.
* If the last word of the page is hyphenated, check nextfollowing page for the complete word and enclose the first part of the hyphenated word at the bottom of the page {{color|blue|<nowiki>{{hyphenated word start|comp|complete}}</nowiki>}} and enclose the second part of the hyphenated word at the top of the following page {{color|blue|<nowiki>{{hyphenated word end|lete|complete}}</nowiki>}} and this will result inmerge the two parts into the word {{color|blue|complete}} when transcluded in the main namespace. 
* The abbreviated form of the hyphenation templates are {{tl|hws}} and {{tl|hwe}} {{sc|EClick to see this example:}}[[Page:Popular_Science_Monthly_Volume_24.djvu/16 |Pages 16 and 17]]

=== Single and double quotes ===

* Use standard English typewriter double quotes " (ANSI 034)  and not international glyphs or the Unicode slanted/curved quotes.
* Check for matching opening and closing quotes and close up the space between the marks and the enclosed text.
* There is an occasionally occurringused typographical style applied to a series of paragraphs where the beginning of each paragraph is opened without a closing double quotation mark.
* For single quotes use the standard English typewrite single quote ' (ANSI 039) They are used to enclose text, within, or in place of, double quotation marks.

=== Typographic characters, ligatures, and symbols ===

* Check for the missing 'em—dash' — (ANSI 0151) character. This is available on the advanced editor toolbar, or, by request can be added to the user's Charinsert preference, or use the {{tl|--}} template. 
* Check for {{color|blue|''<nowiki>italics</nowiki>''}} in the text. ''Referenced publication names are always italicized''.
* CheIn some volumes, symbols and characters are ignored by the OCR. These include the em dash (—), currency symbols ($ and £), the temperature indicator º, and the centered decimal point, etc.
* Check for {{color|blue|''<nowiki>italics</nowiki>''}} in the text. ''Referenced publication names are always italicized''.
* Check for the missing 'em—dash' — (ANSI 0151) character. This is available on the advanced editor toolbar, or, by request can be added to the user's Charinsert preference, or use the {{tl|--}}template. 
* Check for ambiguous text. They may be incorrectly rendered scientific, technical, or currency symbols like, fractions , degrees '°' (ANSI 0176), currency '£' symbols {ANSI 0163} or centered decimal points '·' (ANSI 0183).­­
* Check for the characters 'ae', and 'oe', which are most likely to be the ligatures of 'æ', (ANSI 0230) and the 'œ' (ANSI 0156). Assumptions can be made of their existence in the text, based on the article's subject matter.
* In some volumeCharacters, symbols and characters are ignored by the OCR. These include the em dash (—), currency symbols ($ and £), and the temperature indicator º, etc.
* Characters,ligatures can also be inserted by using their HTML equivalents. [[{{SUBPAGENAME}}#HTML & ANSI characters and symbols|See References for the HTML ANSI codes]].
* All the above mentioned symbols cand ligatures can also be inserted by using their HTML equivalents. See References for the HTML ANSI codes be had in the "User" selection  of the Charinsert gadget. Just post a request in the Scriptrium/help.

== Fonts sizes and font templates ==

* Fonts larger than 100% are of no concern. Use any size as you deemed to be matching the original.
* For font sizes that are less thatn 100%, the following list of templates were designed for the project because they havinclude line heights proportional to the font size.<ref>The {{tl|fsx}} template doesn't reduce the line height proportionately.</ref>

* {{tl|fs90}} is used to enclose Author names, 
* {{tl|fs90/s}} {{tl|fs90/e}} used to enclose a bloc of paragraphs and/or span pages. When used to span pages, the {{color|blue|<nowiki>{{fs90/e}}</nowiki>}} is placed in the footer of the first page, to terminates the block and {{color|blue|<nowiki>{{fs90/s}}</nowiki>}} is placed in the header of the following page to begin the new block. This way the transcluded text in the main namespace will be enclosed with a single set of templates because headers and footers are excluded.[[Page:Popular Science Monthly Volume 24.djvu/723|''Click on this link to see an example'']].
* {{tl|fs85}} 85% font size and 100% line height. - Used exclusively for image captions and subtitled sections of recurring monthly features.
* {{tl|fs75}} 75% font size and 95% line height. - Used to enhance the diversity of font sizes of article sub-titles.
* {{tl|fs70}} 70% font size and 90% line height. - Used inline to match the line height of fraction templates {{color|blue|<nowiki>{{fs70|{{over||}}}} and {{fs70|{{frac||}}}}</nowiki>}}.
* Named font templates are not used in the PSM project
* Link to the [[Help:Beginner's guide to typography#100% and smaller font size and style comparisons table|100% and smaller font size and style comparisons table]].

=== Titles ===

* Articles' main titles are set by templates. [[User:Ineuw/TPSM_Proofreading_guide{{SUBPAGENAME}}#PSM_  article_  title_  templates|See list of title templates in the Reference section at the end.]].
* [[Page:Popular Science Monthly Volume 30.djvu/198|This page provides examples of the article title, author, subtitles and Roman numeral paragraph numbering]].

=== Author names ===

* The main title is followed by the author's name for which there is no template. The name is enclosed in the {{tl|Ssmall caps}} template, then the set to font size is 90% always using the {{tl|fs90}} template and finallythen centered on the page.

<pre>
{{c|{{fs90|{{sc|By AUTHOR NAME}}}}}}
</pre>
{{c|{{fs90|{{sc|By AUTHOR NAME}}}}}}
{{Dhr}}

{{Dhr}}
{{rule|65%}}
{{Dhr}}⏎
⏎
=== Secondary title font sizes ===

* If there is a second subtitle below the author's name, then theit is centered and wrapped with the is 75% font size is 75%, using the {{tl|fs75}} template and the subtitle is centered.
* If there is a tertisecondary subtitle, center it an enclosed wrap it with a font size comparable to the original, which might be 100% or. This may be 100% or if smaller, use the 85% font size using the {{tl|fs85}} template.
* {{sc|Example:}}[[Page:Popular Science Monthly Volume 1.djvu/71|This page]] has one main and five sub titles. Otherwise, article titles consist of one main and, at most, three sub-titles. Since the styles differ, there is good visual contrast, even when the font-size difference is less than 10%. TitNew articles can start anywhere on a page.

== Paragraphs ==

* Contrary to the original scan, proofread paragraphs are not indented. However, there are exceptions in poems in which alternate lines are indented, and indented lists, where inserting a table is not warranted. In such cases there are two templates available: 
** ThUse {{tl|gap}} template accepts width parameters. Use it where the gap in the text, or the indent is wide. where there is a wide gap or indent in the text.
** ThUse {{tl|spaces}} template requiwhered the number of spaces to spacere is a short gap or indent in the text.
* All Roman numeral numbered paragraphs are indicateor are 90% font size and enclosed with the {{tl|fs90}} template. 
* Main article first paragraph ''leadin'' is a dropped initial, usingUse the {{tl|Dropped initial) or {{tl|Di}} template to format an article's first letter.
* The double height row template {{tl|Dhr}} is used in places where 2 or more empty lines separate paragraphs. This template also accepts a height specification if the space between two sections {{color|blue|<nowiki>{{|Dhr|4em}}</nowiki>}} indicates a vertical spacing of 4em. {{sc|Example:}}[[Page:Popular Science Monthly Volume 24.djvu/440|this pageClick to see this page and open it in edit mode]].
* If the end of a paragraph is also the end of the page, terminate a page with the {{tl|nop}} template. This prevents the transclusion process from joining this paragraph to the subsequent paragraph. This template must be placed on it's own line and must not be followed by any character or space.

=== Paragraph titles ===

* Paragraph titles of monthly recurring sections are CAPITALIZED LETTERS centered, and enclosed with the {{tl|fs85}} template. This includes Letter titles in the Correspondence section, 
* Paragraph titles of the Editor's Table are also the same font size, but the title is italicized, as is the original.

=== Paragraph spacing and separators ===

* Where a line separates topics in the original, paragraph separators are standardized to be {{tl|rule}} of 4em in length, and padded before and after with {{tl|Dhr}}.

<pre>
End of topic⏎
space
{{Dhr}}
{{rule|4em}}
{{Dhr}}
space
Start of topic (Header)⏎
</pre>

=== Poems ===

* Poems, without exception, are wrapped starting innermost with the {{tl|fs90/s}} {{tl|fs90/e}} font template, followed by the {{color|blue|<nowiki><poem></poem></nowiki>}} tags, and then enclosed in {{tl|block center/s}} {{tl|block center/e}} templates.
* The template order is necessary because the font template line height is not applied to the contents, unless it is the innermost template.
* The {{tl|block center/s}} template is the bestmost versatile template for multiple paragraphs and page spanning.
* In any case, tThe {{color|blue|<nowiki><poem></poem></nowiki>}} tags can't span pages. In poems that span pages the tag must be terminated at the last line of the poem and inserted anew in the following page.

<pre>
{{block center/s}}<poem>{{fs90/s}}Lorem ipsum dolor sit amet,
consectetur adipisicing elit,
sed do eiusmod tempor incididunt
ut labore et dolore magna aliqua.
Ut enim ad minim veniam,
quis nostrud exercitation ullamco
laboris nisi ut aliquip ex ea
commodo consequat.{{fs90/e}}</poem>{{block center/e}}
</pre>

{{block center/s}}<poem>{{fs90/s}}Lorem ipsum dolor sit amet,
consectetur adipisicing elit,
sed do eiusmod tempor incididunt
ut labore et dolore magna aliqua.
Ut enim ad minim veniam,
quis nostrud exercitation ullamco
laboris nisi ut aliquip ex ea
commodo consequat.{{fs90/e}}</poem>{{block center/e}}

=== References, footnotes and endnotes ===

* Use the {{tl|smallrefs}} template in the page footer, to render footnotes in small font. Footnote references are automatically numbered. 
* Footnotes which span over pages requires a named reference tag on the first pagethe page where it begins {{color|blue|<nowiki><ref name=D723>reference text</ref></nowiki>}} and a "follow" reference tag on the subsequest page(s) as {{color|blue|<nowiki><ref follow=D723>reference text</ref></nowiki>}}. An example of a footnote spanning two pages can be seen [[Page:Popular Science Monthly Volume 1.djvu/723|on this page]], when viewed in edit mode. [[Page:Popular Science Monthly Volume 1.djvu/723|Click to see an example of a footnote spanning two pages]].
* In the main namespace footnotes are converted into numbered endnotes.

=== OCR shortcomings ===

* In several instances, tThe OCR process has difficulty in distinguishing certain characters and commonly misreads the following:
* Words beginning especially beginning with "W are preceded by a double quotation mark. Compare to the original.
* Short words beginning with 'w' are occasionally garbled as in 'w T here', which is supposed to be 'where'. Correct these by searching for ' w ' surrounded by spaces.
* Occasionally, the lowercase 'h' is rendered as 'b'.
* Words containing 'g' is problematic.
* Words containing 'p' are often rendered as 'jj'.
* Uppercase 'N' is often rendered incorrectly.
* The uppercase "R" is often rendered as 'K' 'E', or 'B'. Spell check finds the error, unless the change is a meaningful word.
* Ligatures.

== Tags ==

* When a page specific code is required, the .djvu number of the page is used because it guarantees uniqueness. Printed page numbers are not unique or accurate. In addition, if the code contains no spaces, then enclosing the code with quotes can be omitted.

=== Section tags ===

* The codes are made up of the following segments:

* End of article begin and end section code segments:

  E = End of article
 27 = .djvu page number
 {{colors|blue||<nowiki><section begin=E27 /><section end=E27 /></nowiki>}}

* The article following on the same page uses the code segments, except prefixed by 'B' to indicate the beginning section of the article.

  B = Beginning of article
 27 = .djvu page number
 {{colors|blue||<nowiki><section begin=B27 /><section end=B27 /></nowiki>}}

* An example of the above coding scheme is visible on the edit view of .djvu page 27/17 [[Page:Popular Science Monthly Volume 1.djvu/27|here]], with the final results are visible  [[Popular Science Monthly/Volume 1/May 1872/The Recent Eclipse of the Sun|on this page]].

=== Anchors and how they are numbered ===

* Consider all article titles, correspondence and editor's table topic titles, literary notices' reviewed publications, and popular miscellany paragraphs to be anchored for linking to the index at the back of the volume. {{sc|Example:}}
* The anchor is made up of the .djvu number of the page preceded by the uppercase "D" without space, and always followed by a hyphen and a number beginning with "1" indicating the order of appearance on the page. [https://en.wikisource.org/w/index.php?title=Page:Popular_Science_Monthly_Volume_21.djvu/287&action=edit Example of two anchored recurring monthly titles on the same page]

* Main article title anchors are always "1" as their order of appearance because two main article titles never appear on the same page.
* Recurring monthly section title order of appearance is "0", as in {{color|blue|<nowiki>{{anchor|D437-0}}</nowiki>}} If there are two recurring sections on a page, (which can happen), the second is identified with two zeros, "00" as in {{color|blue|<nowiki>{{anchor|D437-00}}</nowiki>}}. The reason for this is that recurring monthly section titles can fall between two anchored paragraphs of two different sections which always follow the order of appearance rule. [link to example]
* Recurring monthly sections can have several anchors on the same page and they are numbered in their order of appearance from top to bottom As in {{color|blue|<nowiki>{{anchor|D437-1}}, {{anchor|D437-2}}</nowiki>, etc.}},regardless of which section they belong to [link to example]

=== Volume index anchors ===

* Volume index anchors are generated from the same database as the article titles. Since their order of appearance on the page is not known, they are always assigned "1". After the titles are anchored, 50% to 60% percent of the links are correct and the rest are edited while the index is in edit preview mode, which permits editing and testing the link simultaneously.

== Images ==

* With the implementation of [[User:George Orwell III|George Orwell III]]’s {{tl|FreedImg/span}} {{tl|FIS}}, the abbreviated form) makes Image display and the accompanying caption much simpler with the use of a single template.

=== {{tl|FIS}} Template for center, left or right offset inline images ===

<pre>
{{FIS
 | cstyle       = margin-top:8px; margin-bottom:8px <!-- no dhr needed -->
 | file         = 
 | width        = 430px|215px <!-- 430px is page width -->
 | float        = center|left|right <!-- One of the three -->
 | caption      = 
 | talign       = center|justify <!-- One of the two -->
 | tstyle       = font-variant:small-caps
 | margin-right = 8px <!-- if floating to the left -->
 | margin-left  = 8px <!-- if floating to the right -->
 | tmleft       = 11px <!-- For Caption Indent when justified -->
 | indent       = -11px <!-- For Caption outdent when justified -->
}}</pre>

=== Centered image examples ===

# [[Page:Popular Science Monthly Volume 69.djvu/434|Stacked images with various primary and secondary captions & styles.]]
# [[Page:Popular Science Monthly Volume 69.djvu/115|Full page width 430px image]]
# [[Page:Popular Science Monthly Volume 71.djvu/292|Mixed text style in caption]]

=== Offset image examples ===

* Please note how the text abbuts to the open and close brackets of the template to provide seamless flow without a paragraph break.

* [[Page:Popular Science Monthly Volume 17.djvu/215|Image offset to the right, width is less than than half the page width (215px.) and having mixed text style]].
*[[Page:Popular Science Monthly Volume 65.djvu/390|Image offset to the left half page width and a short caption]].
* [[Page:Popular Science Monthly Volume 65.djvu/430|Image offset to the left half page width and a long caption]].

=== Special templates ===

=== One image file and two cells for centered or justified hanging indent descriptions ===

* {{sc|Note:}} Combined image and caption width must equal to the overall table width.

{|align=center width="430" {{ts|sm85|bc|lh95}} border = 1[[[[Page:Popular Science Monthly Volume 1.djvu/27|Click to see an example of the above coding scheme in edit view of .djvu page 27/Page 17]]. The final results are visible [[Popular Science Monthly/Volume 1/May 1872/The Recent Eclipse of the Sun|on this transcluded page]].

=== Anchors and how they are numbered ===

* Consider all article titles, correspondence and editor's table topic titles, literary notices' reviewed publications, and popular miscellany paragraphs to be anchored for linking to the index at the back of the volume. [[Click to see an example of]].
* The anchor is made up of the .djvu number of the page preceded by the uppercase "D" without space, and followed by the hyphenated number beginning with "1" indicating the order of appearance on the page. [[Page:Popular_Science_Monthly_Volume_21.djvu/287|[[Click to see an example of two anchored titles on the same page]].

* Articles main title anchors are always "1" as their order of appearance because two titles never appear on the same page.
* Recurring monthly section titles are "0", as in {{color|blue|<nowiki>{{anchor|D437-0}}</nowiki>}} If there are two recurring sections on a page, (which does happen), the second is identified with two zeros, "00" as in {{color|blue|<nowiki>
{{anchor|D437-00}}</nowiki>}}. The reason for this is that recurring monthly section titles can fall between two anchored paragraphs of two different sections.
* Recurring monthly sections can have several anchors on the same page and they are numbered in their order of appearance from top to bottom as in {{color|blue|<nowiki>{{anchor|D437-1}}, {{anchor|D437-2}}</nowiki>, etc.}}, regardless of which section they belong to. Thus the anchors always follow the order of appearance.[[Click to see an example of]].

=== Volume index anchors ===

* Volume index anchors are generated from the same database as the article titles. Since their order of appearance on the page is not known, they are always assigned "1". After the titles are anchored, Most of the links are correct and the rest are edited while the index is in edit preview mode, which permits editing and testing the link simultaneously.

== Image templates ==

* With the implementation of [[User:George Orwell III|George Orwell III]]’s {{tl|FreedImg/span}} {{tl|FIS}}, the abbreviated form) makes Image display and the accompanying caption much simpler. The caption is part of the template.

* In the offset floating mode the text flows unbroken around the temmplate. 

=== One {{tl|FIS}} template layout for center, or offset images ===

* PSM only uses the following parameters and unused parameters are to be removed from the template.
* The required parameters are the File name, image width and the float position.

<pre>
{{FIS
 | file         = 
 | width        = 430px|215px <!-- 430px is page width -->
 | float        = center|left|right <!-- One of the three -->
 | caption      = 
 | talign       = center|justify <!-- One of the two -->
 | tstyle       = font-variant:small-caps
 | margin-right = 8px <!-- if floating to the left -->
 | margin-left  = 8px <!-- if floating to the right -->
 | tmleft       = 11px <!-- For Caption Indent when justified -->
 | indent       = -11px <!-- For Caption outdent when justified -->
 | cstyle       = margin-top:8px; margin-bottom:8px <!-- no dhr needed -->
}}
</pre>

==== Centered image examples ====

* [[Page:Popular Science Monthly Volume 69.djvu/434|Stacked images with various primary and secondary captions & styles.]]
* [[Page:Popular Science Monthly Volume 69.djvu/115|Full page width 430px image]]
* [[Page:Popular Science Monthly Volume 71.djvu/292|Mixed text style in caption]]

==== Offset image examples ====

* Note how the text abbuts to the open and close brackets of the template to provide seamless flow without a paragraph break.

* [[Page:Popular Science Monthly Volume 17.djvu/215|Image offset to the right, width is less than than half the page width (215px.) and having mixed text style]].
* [[Page:Popular Science Monthly Volume 65.djvu/390|Image offset to the left half page width and a short caption]].
* [[Page:Popular Science Monthly Volume 65.djvu/430|Image offset to the left half page width and a long caption]].

=== Special image templates ===

==== One image file and two cells for centered or justified hanging indent captions ====

* {{sc|Note:}} The image and the combined caption width must equal to the overall table width.

{|align=center width="430" {{ts|sm85|bc|lh95}} 
|-
|colspan=3 |[[File:PSM V54 D323 Two simple shapes creating optical illusions.png|frameless|center|430px|]]
|-
|width=210px {{ts|aj|it|vtt}}|{{sc|Fig. 11.}}—This represents an ordinary table-glass, the bottom of the glass and the entire rear side, except the upper portion, being seen through the transparent nearer side, and the rear apparently projecting above the front. But it fluctuates in appearance between this and a view of the glass in which the bottom is seen directly, partly from underneath, the (contracted; show full)
{{Dhr}}

[[Page:Popular Science Monthly Volume 52.djvu/649|Single image with two short captions]].

{{Dhr}}

=== Separate images with side by side cells for centered or justified hanging indent 
descricaptions ===

<pre>
{|align=center width="430" {{ts|sm85|bc|lh95}}
|width=210px |[[File:|frameless|center|210px|]]
|width=10px|
|width=210px |[[File:|frameless|center|210px|]]
|-
(contracted; show full)|-
|Volume title page 3||{{ts|ac}}|No||From Volume 57 to Volume 87||[[:Template:TPSM3|TPSM3]]||||Page
|-
|}
</center>
{{Dhr}}

=== HTML
/ & ANSI characters and symbols ===

{{c|This list was copied (stolen, absconded with, appropriated) from [[User:Mpaa]]'s home page.}}

{{Dhr}}

<center>
<table border cellspacing="0" cellpadding="3" width="70%">
(contracted; show full)  </tr>
</table>

{{Dhr}}

=== General templates ===

* Attempt was made to use [[:Category:Formatting templates|Templates]] almost exclusively. HTML tags are limited to the minimum where a template wasn't available or possible.