Help:Formatting conventions

From Wikisource
Jump to: navigation, search
Formatting conventions
Standard formatting conventions used for proofreading on Wikisource.

 

The following conventions are considered best practices for pages in the Page: namespace (DjVu files, PDFs and other files which use the ProofreadPage extension). For general article formatting conventions and guidelines see Wikisource:Style guide.

Running headers[edit]

  • A scanned page's header and footer often include page number and titles, each of which are not needed for the new page. Place this information in the header and footer edit boxes, accessed by clicking the Button category plus.png which appears above the edit window. The {{RunningHeader}} template is useful for formatting these headers, and is used as follows:
{{RunningHeader|left=|center=|right=}}
Text in the left, center, or right parameters will appear on the same line.
  • Remove end-of-line hyphens and line breaks. To start a new paragraph, MediaWiki pages use two line breaks (i.e. press return twice).

Hyphenated end of page words[edit]

{{hws|FIRST HALF OF WORD|WHOLE WORD}}
{{hwe|LAST HALF OF WORD|WHOLE WORD}}
  • When hyphenating words which contain a hyphen, include the complete words (including its hyphenation) in the WHOLE WORD. Otherwise, the words will be broken on transclusion. For example: the word "able-bodied"
{{hws|able-|able-bodied}} {{hwe|bodied|able-bodied}}
  • Alternatively, use {{lps}} and {{lpe}}. These templates are also used when a wikilink goes across a page break.
{{lps|hws=able-|hyph=|hwe=bodied}} {{lpe|hws=able-|hyph=|hwe=bodied}}

Paragraph ending at the bottom of a page[edit]

  • If a paragraph ends at the bottom of a page scan and a new paragraph in the same chapter will start on the next page, add {{nop}} at the bottom of the page (on its own line) to force a break in the text. Otherwise, when the pages are transcluded the separation between the two pages will be treated as single space rather than a new line. Example: (Page:Personal Recollections of Joan of Arc.djvu/476 and Personal Recollections of Joan of Arc/Book III/Chapter 14).
  • Using standard templates instead of other types of markup, gives Wikisource protection from undesirable external changes. eg. Use {{right}} instead of <p align="right">.
    • If you need to indicate a word/phrase should be in Small Caps, use the {{small-caps}} template.
    • If you need to indicate a word/phrase should be in a smaller (or larger) font, use the {{smaller}} template. Similarly, the {{xx-smaller}}, {{x-smaller}}, {{larger}}, {{x-larger}}, {{xx-larger}}, and {{font-size}} templates can be used to modify text size.
  • Footnotes in the print version of the book should be implemented using the <ref></ref> and <references/> (or {{smallrefs}}) mark up.