Difference between revisions of "Article Standards"

From PacificNG
m
 
(16 intermediate revisions by one other user not shown)
Line 1: Line 1:
This page is a work in progress while article standards are refined for the site.
This page is a work in progress while article standards are refined for the site.<br />
A standardized article for reference: [[Colusa & Lake Railroad]]
<span style="float:right;">__TOC__</span>
<span style="float:right;">__TOC__</span>
Please see the page: [[Colusa & Lake Railroad]] for an example of a standardized article.<br />


==Article Types==
==Quick Tips==
 
===Line Breaks===
As you space lines in the editor, MediaWiki will automatically insert a page brake on double spaces.
 
To insert a hard page break use: <code><nowiki><br /></nowiki></code><br/>
This will break the line and start text on the next line like this.
 
===Categories===
Pages should include any relevant categories. Examples include the gauge: [[:Category:36in Gauge Railroads|36in]], or the major commodities hauled by the railroad: [[:Category:Sugar|Sugar]]
 
===MediaWiki Reference===
 
[https://www.mediawiki.org/wiki/Help:Contents MediaWiki Help]
 
[https://www.mediawiki.org/wiki/Cheatsheet MediaWiki Cheatsheet]
 
===Table of Contents===
For now use: <code><nowiki><span style="float:right;">__TOC__</span></nowiki></code><br />
The default table of contents uses <code>_TOC_</code>. In the future it will default to right alignment.
 
==Short Description==
 
Short description used on the state index pages. This is to be no more than 3-4 sentences max that provide the most basic description of the road. See any state index page for examples. Note: This brief description is not required for submitting articles.


All article pages for railroads should start with the heading: History (H3)
In addition to the short description, the location of the railroad and dates of operation should be included.
When possible they should be formatted in the following manner:<br />
<Location> to <Location>, Region, State/Provence. <Start Date> - <End Date>


===Short or "Wiki" style article===
==Article Types==


Short description used on the state index pages. This is to be no more than 3-4 sentences max that provide the most basic description of the road. See any state index page for examples.  
All article pages for railroads should start with the heading: History (H3).<br />
Note: This brief description is not required for submitting articles.
In our parlance, "Article" refers to a page on the site discussing a subject. The initial page for a railroad should serve as the landing page for more detailed information. Limit the landing page to the discussion of the railroad from construction to scrapping.


'''Basic Histories by Definition'''<br />
'''Basic Histories by Definition''':<br />


===Type A or “Compiled”===
===Type A or “Compiled”===
Line 20: Line 45:
  These histories are fully fleshed out with citations (Biblio style minimum, in line citations are optional but welcomed) and provide a consistent telling of the railroad’s history. Articles of this type are generally going to be researched and take some time to get written and put on the site. All histories of this type should carry attribution to the author in the form of “By XXXXXX”.
  These histories are fully fleshed out with citations (Biblio style minimum, in line citations are optional but welcomed) and provide a consistent telling of the railroad’s history. Articles of this type are generally going to be researched and take some time to get written and put on the site. All histories of this type should carry attribution to the author in the form of “By XXXXXX”.


Initial railroad article pages not be longer than 4-5 paragraphs. Additional histories on detailed subjects should be stubbed from the main railroad page, keeping the landing page text to a minimum. For extended and/or thorough histories, see “Expanded Articles” below. Some operations worked in multiple areas, under the same Corporate Parent. (SNW&L, Truckee Lumber, etc). For these operations the railroad should be listed as a sub-company of the parent.  
Initial railroad article pages not be longer than 4-5 paragraphs. Additional histories on detailed subjects should be stubbed from the main railroad page, keeping the landing page text to a minimum. Whenever possible, create additional articles for the different corporate names. Example: the [[Carson & Colorado Railroad|Carson & Colorado]] became the Nevada & California Railway in 1906 and later merged into the Southern Pacific System. Each of those three corporate identities should have an individual page. The idea is to break up the longer narratives into smaller pieces and focus on each identity.


On the site we’ve been listing them in the following format: '' This needs revision ''
For extended and/or thorough histories on specific topics, see “Expanded Articles” below. Some operations worked in multiple areas, under the same Corporate Parent. (SNW&L, Truckee Lumber, etc). For these operations the railroad should be listed as a sub-company of the parent.
Lake Tahoe Narrow Gauge Railroad. (Heading)
 
Carson & Tahoe Lumber & Fluming Company. (Sub-Heading)
On the site we’ve been listing them in the following format: '' This needs revision ''<br />
Lake Tahoe Narrow Gauge Railroad. (Heading)<br />
Carson & Tahoe Lumber & Fluming Company. (Sub-Heading)<br />


This formatting will allow for the eventual connection to the Corporate Parent directly.
This formatting will allow for the eventual connection to the Corporate Parent directly.


Article Tips:  
'''Article Tips:'''<br />


1. Always remember to include: Who, What, When, Where, Why
1. Always remember to include: Who, What, When, Where, Why. Expect your reader to have a casual understanding of railroads for general articles. Expanded articles can be as technical as the writer desires.


2. Always write the complete company name one or two times before switching to abbreviations.  
2. Always write the complete company name one or two times before switching to abbreviations. Use the full name in situations where similar companies are being discussed. Example: [[South Pacific Coast Railroad]] and [[South Pacific Coast Railway]] both go by the short name "South Pacific Coast" but represent different time periods of the railroad.  


3. In-Linking to articles on our site and/or Wikipedia (or Mindat) within your narrative is encouraged. One of our goals with PacificNG is to build interest in other railroads/companies in our focus.
3. In-Linking to articles on our site and/or Wikipedia (or Mindat) within your narrative is encouraged. One of our goals with PacificNG is to build interest in other railroads/companies in our focus.  


'''Expanded Articles'''<br />
===Expanded Articles===
In addition to the history of a particular railroad, other topics can be expanded upon on their own page. This can include People, Companies, and specific pieces of equipment.
In addition to the history of a particular railroad, other topics can be expanded upon on their own page. This can include People, Companies, and specific pieces of equipment.
Examples: [[BLW-CN3971-1876|South Pacific Coast #3]], [[HK Porter-CN-848-1882|Eureka Mill #1 '' "Eureka" '']], [[Hyman-Michaels_Company|Hyman-Michaels Company]], [[Monterey & Salinas Valley Railroad Combine 1]]
Examples: [[BLW-CN3971-1876|South Pacific Coast #3]], [[HK Porter-CN-848-1882|Eureka Mill #1 '' "Eureka" '']], [[Hyman-Michaels_Company|Hyman-Michaels Company]], [[Monterey & Salinas Valley Railroad Combine 1]]
Line 44: Line 71:
For equipment use: ROADABRV-CARTYPE-NUMBER<br />
For equipment use: ROADABRV-CARTYPE-NUMBER<br />
Example: MSV-COMBINE-1-1874<br /> [[TOWLE-PAYCAR]]
Example: MSV-COMBINE-1-1874<br /> [[TOWLE-PAYCAR]]
==Article Formatting==


===Article Graphics===
===Article Graphics===
For initial articles on a railroad, it is suggested to avoid adding more than 1 or 2 graphics inline. Extended articles can include more graphics dependent on length. These images should be placed to match the narrative of the article as closely as possible. Additional images and galleries should be placed at the end of the article or on a separate page as needed. See: Galleries and Locomotive / Equipment Pages
For initial articles on a railroad, it is suggested to avoid adding more than 1 or 2 graphics inline. Extended articles can include more graphics dependent on length. These images should be placed to match the narrative of the article as closely as possible. Additional images and galleries should be placed at the end of the article or on a separate page as needed. See: Galleries and Locomotive / Equipment Pages
'' Note: All articles are subject to editorial/layout changes as the Webmaster and/or Editor see fit to match the site's overall style. ''
'' Note: All articles are subject to editorial/layout changes as the Webmaster and/or Editor see fit to match the site's overall style. ''


===Units, Measures and Dates===
===Units, Measures and Dates===
Line 77: Line 110:


===Creative Commons===
===Creative Commons===
Whenever possible, articles written for the site should be issued a creative commons license. All photographs or documents attributed to PacificNG are to be covered by CC For public, non commercial use: http://creativecommons.org/licenses/by-nc/4.0/
Whenever possible, articles written for the site should be issued a creative commons license. All photographs or documents attributed to the PacificNG Collection are to be covered by Creative Commons For public, non commercial use: http://creativecommons.org/licenses/by-nc/4.0/
Cite: “<DocName>” by <Creator> is licensed under CC BY-NC 4.0
Cite: “<DocName>” by <Creator> is licensed under CC BY-NC 4.0
See examples: https://wiki.creativecommons.org/wiki/Marking_your_work_with_a_CC_license#Example:_Image
See examples: https://wiki.creativecommons.org/wiki/Marking_your_work_with_a_CC_license#Example:_Image
Authors retain copyright control on their own works or submissions.  
Authors retain copyright control on their own works or submissions.


===Data Column===
===Data Column===
Line 86: Line 119:
Examples of information to be included: Incorporation Dates, Corporate Ownership, Length of Road, Rail Weights, Tie Dimensions
Examples of information to be included: Incorporation Dates, Corporate Ownership, Length of Road, Rail Weights, Tie Dimensions
Railroads that had several owners listed under the Corporate Ownership heading should link to the related page.
Railroads that had several owners listed under the Corporate Ownership heading should link to the related page.
Railroads that operate with multiple names / corporate owners should include a list of these names and dates. These names will be used to in-link to related pages.
Railroads that operate with multiple names / corporate owners should include a list of these names and dates. These names will be used to in-link to related pages. ''A revised design format for data columns is forthcoming''
 
===Breadcrumb===
Breadcrumb links are required for every page and need to be created manually.
 
For railroads including the state and railroad type, example:
 
[[Narrow Gauge Railroads of California|California]] / [[Narrow Gauge Railroads of California#Common Carriers|Common Carriers]] / [[Bodie & Benton Railway & Land Company]]<br />
<code><nowiki>[[Narrow Gauge Railroads of California|California]] / [[Narrow Gauge Railroads of California#Common Carriers|Common Carriers]] / [[Bodie & Benton Railway & Land Company]]</nowiki></code>
 
For reference pages start with Reference:
 
[[Reference]] / [[Car Builders]]<br />
<code><nowiki>[[Reference]] / [[Car Builders]]</nowiki></code>


==Reference Standards==
==Reference Standards==
Line 115: Line 161:
Every railroad album in our image gallery. In lieu of linking to the Album, linking to the relevant keyword (i.e Porter, Baldwin, 4-4-0).
Every railroad album in our image gallery. In lieu of linking to the Album, linking to the relevant keyword (i.e Porter, Baldwin, 4-4-0).
Additional external links to galleries (SPNGHS, SVRY) should be linked under this heading. Images placed inline the article text can be excluded from image galleries on an article page.  
Additional external links to galleries (SPNGHS, SVRY) should be linked under this heading. Images placed inline the article text can be excluded from image galleries on an article page.  
Photographs or graphics that are hosted offsite must either be linked, or uploaded to PacificNG (with citation link in description) to be used inline on a page for security purposes.


===Manuscripts===
===Manuscripts===
Line 133: Line 180:
Additional sources that are noteworthy, but not used in the primary history article should be listed on a page stubbed from the primary article.  
Additional sources that are noteworthy, but not used in the primary history article should be listed on a page stubbed from the primary article.  
PngES reports? Oral histories.
PngES reports? Oral histories.


===Links===
===Links===
Line 141: Line 186:
===Video===
===Video===
Links to video (historic or contemporary) that pertains to the subject. In most cases these will be contemporary videos.  
Links to video (historic or contemporary) that pertains to the subject. In most cases these will be contemporary videos.  


==Organization and Collection Links==
==Organization and Collection Links==

Latest revision as of 11:23, 28 February 2023

This page is a work in progress while article standards are refined for the site.

Please see the page: Colusa & Lake Railroad for an example of a standardized article.

Quick Tips

Line Breaks

As you space lines in the editor, MediaWiki will automatically insert a page brake on double spaces.

To insert a hard page break use: <br />
This will break the line and start text on the next line like this.

Categories

Pages should include any relevant categories. Examples include the gauge: 36in, or the major commodities hauled by the railroad: Sugar

MediaWiki Reference

MediaWiki Help

MediaWiki Cheatsheet

Table of Contents

For now use: <span style="float:right;">__TOC__</span>
The default table of contents uses _TOC_. In the future it will default to right alignment.

Short Description

Short description used on the state index pages. This is to be no more than 3-4 sentences max that provide the most basic description of the road. See any state index page for examples. Note: This brief description is not required for submitting articles.

In addition to the short description, the location of the railroad and dates of operation should be included. When possible they should be formatted in the following manner:
<Location> to <Location>, Region, State/Provence. <Start Date> - <End Date>

Article Types

All article pages for railroads should start with the heading: History (H3).
In our parlance, "Article" refers to a page on the site discussing a subject. The initial page for a railroad should serve as the landing page for more detailed information. Limit the landing page to the discussion of the railroad from construction to scrapping.

Basic Histories by Definition:

Type A or “Compiled”

These can range in length depending on the information available, but at a minimum should be a full paragraph. Write ups of this type do not need citations, nor a specific author. Articles of this type are suggested for the initial listing of a railroad on the site. Attribution for this type of history is solely up to the discretion of the author. Should the history be assembled from common knowledge or vague sources, it is recommended NOT to include an author’s attribution (ala wiki). In cases where extensive research was required, attribution should always say: “Compiled by XXXXXX”

Type B or “Narrative”

These histories are fully fleshed out with citations (Biblio style minimum, in line citations are optional but welcomed) and provide a consistent telling of the railroad’s history. Articles of this type are generally going to be researched and take some time to get written and put on the site. All histories of this type should carry attribution to the author in the form of “By XXXXXX”.

Initial railroad article pages not be longer than 4-5 paragraphs. Additional histories on detailed subjects should be stubbed from the main railroad page, keeping the landing page text to a minimum. Whenever possible, create additional articles for the different corporate names. Example: the Carson & Colorado became the Nevada & California Railway in 1906 and later merged into the Southern Pacific System. Each of those three corporate identities should have an individual page. The idea is to break up the longer narratives into smaller pieces and focus on each identity.

For extended and/or thorough histories on specific topics, see “Expanded Articles” below. Some operations worked in multiple areas, under the same Corporate Parent. (SNW&L, Truckee Lumber, etc). For these operations the railroad should be listed as a sub-company of the parent.

On the site we’ve been listing them in the following format: This needs revision
Lake Tahoe Narrow Gauge Railroad. (Heading)
Carson & Tahoe Lumber & Fluming Company. (Sub-Heading)

This formatting will allow for the eventual connection to the Corporate Parent directly.

Article Tips:

1. Always remember to include: Who, What, When, Where, Why. Expect your reader to have a casual understanding of railroads for general articles. Expanded articles can be as technical as the writer desires.

2. Always write the complete company name one or two times before switching to abbreviations. Use the full name in situations where similar companies are being discussed. Example: South Pacific Coast Railroad and South Pacific Coast Railway both go by the short name "South Pacific Coast" but represent different time periods of the railroad.

3. In-Linking to articles on our site and/or Wikipedia (or Mindat) within your narrative is encouraged. One of our goals with PacificNG is to build interest in other railroads/companies in our focus.

Expanded Articles

In addition to the history of a particular railroad, other topics can be expanded upon on their own page. This can include People, Companies, and specific pieces of equipment. Examples: South Pacific Coast #3, Eureka Mill #1 "Eureka" , Hyman-Michaels Company, Monterey & Salinas Valley Railroad Combine 1

When creating an expanded article for a specific locomotive, use the format: BUILDER-CN####-YEAR. "CNXXX" should be the prefix CN with the construction or builder's number for that specific object.

For equipment use: ROADABRV-CARTYPE-NUMBER
Example: MSV-COMBINE-1-1874
TOWLE-PAYCAR

Article Formatting

Article Graphics

For initial articles on a railroad, it is suggested to avoid adding more than 1 or 2 graphics inline. Extended articles can include more graphics dependent on length. These images should be placed to match the narrative of the article as closely as possible. Additional images and galleries should be placed at the end of the article or on a separate page as needed. See: Galleries and Locomotive / Equipment Pages Note: All articles are subject to editorial/layout changes as the Webmaster and/or Editor see fit to match the site's overall style.


Units, Measures and Dates

Railroad gauge should always be expressed in inches. 36” rather than 3' and avoid using ' or " to represent feet and inches, instead use 36in. Meter and other gauges should always be expressed in longhand (Meter Gauge, Monorail). All units and measurements should be written in Imperial and Metric units in the following style: 2.5 mi (4km)

Tables

Tables are complex and difficult to format without a reference. Multiple online tools exist like: [1] allowing for simplified table creation including copying and pasting the data into the table before hand. Large spreadsheets of data should be uploaded to the site in .pdf format rather than posted directly to a page. This may be revised down the road

Citations

All citations should conform to the standards set by the Chicago Manual of Style 17th Edition.

Contributors/Authors are not required to furnish citations in this format, the Webmaster/Editor is expected to reformat these when the page is created. The Webmaster and/or Editor does appreciate the effort however.

At present we are only using Bibliography and/or Inline Citations as outlined by the Chicago Manual. For editorial notes and additional sources (not used in the history), please see: “Additional Sources”.

Attribution

All complete articles written by a member of PacificNG or Contributor should include a proper notation of their work. This includes article rewrites or continuations handled by additional members. In this situation, all of the article authors should be given credit. Compiled "wiki format" pages can use a "Compiled by" attribution. Do not nee

Examples: 
Compiled by <Author>
By <Author>
By <Author 1>, <Author 2>, and <Author 3>

Other attributions should be included in the citations at the end of the article.

Creative Commons

Whenever possible, articles written for the site should be issued a creative commons license. All photographs or documents attributed to the PacificNG Collection are to be covered by Creative Commons For public, non commercial use: http://creativecommons.org/licenses/by-nc/4.0/ Cite: “<DocName>” by <Creator> is licensed under CC BY-NC 4.0 See examples: https://wiki.creativecommons.org/wiki/Marking_your_work_with_a_CC_license#Example:_Image Authors retain copyright control on their own works or submissions.

Data Column

The data column is optional. If included it should provide a quick summary of data relating to the railroad. Examples of information to be included: Incorporation Dates, Corporate Ownership, Length of Road, Rail Weights, Tie Dimensions Railroads that had several owners listed under the Corporate Ownership heading should link to the related page. Railroads that operate with multiple names / corporate owners should include a list of these names and dates. These names will be used to in-link to related pages. A revised design format for data columns is forthcoming

Breadcrumb

Breadcrumb links are required for every page and need to be created manually.

For railroads including the state and railroad type, example:

California / Common Carriers / Bodie & Benton Railway & Land Company
[[Narrow Gauge Railroads of California|California]] / [[Narrow Gauge Railroads of California#Common Carriers|Common Carriers]] / [[Bodie & Benton Railway & Land Company]]

For reference pages start with Reference:

Reference / Car Builders
[[Reference]] / [[Car Builders]]

Reference Standards

The list below contains the standard sub-headings titles to be used on article pages for grouping reference materials. All sub-headings should be sorted alphabetically on article pages. Sub-Headings subject to change

Articles

Articles on specific topics related to the railroad. This can include extended histories of the railroad, discussion of specific areas, details or people. Extended articles should follow the same citation guidelines as described above. There is no length limit to extended histories/articles.

Drawings

Drawings of specific equipment, facilities, or hardware related to the railroad. Example: Curtis F's Baldwin frame drawings.

Equipment Rosters

Use Equipment Rosters for the heading on pages rather than "Roster". The final format of rosters has not been decided. At this time only small rosters are being posted to the site until this solution is in place.

Use headings: COMPANY Locomotive Roster, COMPANY Freight Equipment Roster, COMPANY Passenger Equipment Roster, COMPANY Non-Revenue Roster, COMPANY Marine Equipment Roster, COMPANY Automotive Roster

Government Reports

ICC Valuations, PUC Valuations, Reports, Surveys

Newspaper Clippings

Our newspaper database is pending and the final format of rosters has not been decided. At this time only small rosters are being posted to the site until this solution is in place.

Maps

Should include a Google Earth map on our site. Can also link to maps made by others if they are up to our quality standards (Dave Dye).

Photographs

Every railroad album in our image gallery. In lieu of linking to the Album, linking to the relevant keyword (i.e Porter, Baldwin, 4-4-0). Additional external links to galleries (SPNGHS, SVRY) should be linked under this heading. Images placed inline the article text can be excluded from image galleries on an article page. Photographs or graphics that are hosted offsite must either be linked, or uploaded to PacificNG (with citation link in description) to be used inline on a page for security purposes.

Manuscripts

Reserved for original documents related to the railroad. This can include: work orders, receipts, ledgers and other items copied from historic collections.

Painting Information / References

Paint notes (contemporary and historic), illustrations.

PacificNG Engineering Survey

Any PNGes worksheets should be listed under this heading.

Historic References

Links to books that mention the subject. In most cases these should be HISTORIC books. This includes periodicals, historic fliers and oral histories.

Contemporary References

“Additional Sources” Page. Additional sources that are noteworthy, but not used in the primary history article should be listed on a page stubbed from the primary article. PngES reports? Oral histories.

Links

Related off site links.

Video

Links to video (historic or contemporary) that pertains to the subject. In most cases these will be contemporary videos.

Organization and Collection Links

The list below contains the standard headings titles to be used at the bottom of article pages. These should be in H2 size to match "Reference Material Available Online" and be listed after sub-headings used in Reference Material Available Online.

Organizations

Links to and/or names of contemporary organizations / historical societies related to the railroad.

Collections

Links to and/or names of institutions with holdings related to the railroad and/or it's founders.