Jump to content

RetroTechCollection:Citing sources: Difference between revisions

From RetroTechCollection
Every checkable figure needs a citation (drop 'strongly recommended' tier and standard-voltage exemption); copyrighted material cited with source, author or publisher and copyright holder; curated wikis such as Console5 as secondary sources; remove red RTC:CITE shortcut box
Cite File:Macintosh Plus.pdf (same Service Source; duplicate PDF being deleted)
 
Line 31: Line 31:
<pre>
<pre>
Apple's voltage check uses test cable 077-0135 on the external floppy port.<ref name="ssplus">Apple Computer,
Apple's voltage check uses test cable 077-0135 on the external floppy port.<ref name="ssplus">Apple Computer,
''Macintosh Plus'' Service Source, Adjustments, Voltage. Hosted as [[:File:Macintosh plus.pdf]].</ref>
''Macintosh Plus'' Service Source, Adjustments, Voltage. Hosted as [[:File:Macintosh Plus.pdf]].</ref>
</pre>
</pre>



Latest revision as of 19:06, 1 October 2026

Citations let readers check the technical information on RetroTechCollection and credit the people who produced it. Every checkable figure needs one.

When to cite

[edit source]

A citation is required for:

  • technical figures: voltages, timings, component values, part numbers, capacities
  • safety information: hazard figures, discharge and chemical-handling procedures
  • repair procedures taken from a source: diagnostic steps, calibration methods, troubleshooting flowcharts
  • historical information: release dates, production numbers, prices, design changes
  • performance data: benchmark results, compatibility, operating parameters
  • direct quotes, and any copyrighted material reproduced on the page, citing the source, the author or publisher, and the copyright holder (see RetroTechCollection:Copyrights)
  • claims that might be disputed

Your own bench measurements, photographs and repair findings need no outside source, but must be labelled as your own; see Measurements and original research.

How citations are written on this wiki

[edit source]

Put each citation in a <ref>...</ref> tag straight after the claim it supports, and add a references list at the foot of the page:

== References ==
<references />

{{Reflist}} also works in place of <references />.

Manuals hosted on the wiki

[edit source]

Most repair pages cite service manuals and technical references that are already uploaded here. Write the citation as plain text: publisher, title in italics, the chapter, table or page used, and a link to the hosted file. Link the file with a leading colon ([[:File:...]]) so that the link does not embed the PDF.

Apple's voltage check uses test cable 077-0135 on the external floppy port.<ref name="ssplus">Apple Computer,
''Macintosh Plus'' Service Source, Adjustments, Voltage. Hosted as [[:File:Macintosh Plus.pdf]].</ref>

Check Category:Service Manuals and Special:ListFiles before uploading a manual; the wiki may already have it. See Help:Uploading service manuals.

Named references

[edit source]

Give a reference a name when you cite the same source more than once. Define it in full once, then reuse it with a self-closing tag:

The +5 V supply is specified at ±3 %.<ref name="iie-ref">''Apple II Reference Manual – For //e Only'',
Apple Computer, Inc., 1982, Table 7-2. Hosted as [[:File:Apple IIe Reference Manual 1982.pdf]].</ref>

Later on the page:
<ref name="iie-ref" />

Defining the same name twice with different text shows a red error message in the references list.

Citation templates

[edit source]

The wiki has simple citation templates that print a formatted line of text. Wrap them in <ref> tags yourself. They accept only the parameters listed below and silently ignore any others, so a page number given as pages= to {{Cite manual}} is lost. Put the page or section after the template, inside the same ref.

Template Use for Parameters
{{Cite manual}} service manuals, technical references, datasheets title, author, publisher, date, version, url, access-date
{{Cite book}} published books title, author, publisher, date, isbn, page, url, access-date
{{Cite web}} web pages and forum threads title, author, publisher, date, url, access-date
{{Cite journal}} journal and conference papers title, author, journal, volume, issue, pages, date, doi, url, access-date
{{Cite magazine}} magazine articles title, author, magazine, issue, volume, date, pages, url, access-date

A web source:

<ref>{{Cite web
 |title=Macintosh Colo(u)r Classic
 |publisher=Recap-a-Mac
 |url=https://recapamac.com.au/macintosh-colour-classic/
 |access-date=2025-01-25
}}</ref>

A book, with the page number:

<ref>{{Cite book
 |title=Revolution in the Valley
 |author=Andy Hertzfeld
 |publisher=O'Reilly Media
 |date=2005
 |isbn=0596007191
 |page=156
}}</ref>

A manual cited by section:

<ref>{{Cite manual
 |title=Macintosh SE/30 Service Source
 |publisher=Apple Computer, Inc.
 |date=1990
}} Specifications chapter.</ref>

There are no templates for forum posts, datasheets or safety notices. Use {{Cite web}} for a forum thread and {{Cite manual}} for a datasheet.

Measurements and original research

[edit source]

There is no template for measurements. Give your own bench measurements in plain text, with the conditions: the machine and board revision, the test point, the load and the meter used. Original research native to the wiki, such as Sad Mac code decoding, bench measurements and 3D-printed replacement parts, needs no external citation, but say that it is original.

Source quality

[edit source]

Preferred sources

[edit source]

In order of preference:

  1. Official service manuals: the manufacturer's repair documentation
  2. Technical datasheets from the component manufacturer
  3. Engineering documentation: schematics, design notes, technical bulletins
  4. Published technical books by recognised authors
  5. Established technical websites with documented expertise and review

Acceptable sources

[edit source]

These may be used with appropriate context:

  • community forums, where several experienced users confirm the information
  • technical blogs by recognised experts
  • videos, when the same information is also documented in writing
  • personal experience, clearly marked as such and preferably with supporting documentation

Sources to avoid

[edit source]

These are generally not suitable:

  • social media posts, unless from an official manufacturer account
  • Wikipedia and other open wikis: cite their sources instead. A page on a curated technical wiki, such as a capacitor list on the Console5 wiki, may be cited as a secondary source; see RetroTechCollection:Reliable technical sources.
  • commercial listings: eBay, Amazon or other sales descriptions
  • unverified claims with no supporting documentation
  • speculation and rumour

See RetroTechCollection:Reliable technical sources for more detail.

Technical accuracy

[edit source]

When citing technical information:

  • Cross-check specifications against more than one source where you can.
  • Where sources disagree, say so and cite both.
  • Replace superseded data with the current figure.
  • Give the conditions: operating parameters, tolerances and limits.

Make sure the source actually says what you cite it for.

Special cases

[edit source]
[edit source]

Where the copyright holder is unknown, cite the document as fully as you can and state what is not known:

<ref>''Service Guide'', publisher unknown, c. 1985, p. 12.</ref>

Foreign-language sources

[edit source]

Give the original title followed by an English translation in brackets, and name the language:

<ref>Fujitsu, ''コンピュータ修理マニュアル'' (Computer Repair Manual), 1984, in Japanese, p. 30.</ref>

Multiple revisions

[edit source]

Name the revision you used, since figures often change between revisions. {{Cite manual}} takes a version parameter for this.

[edit source]

When including web links:

  • Prefer permanent or archived URLs.
  • Check that the link works before saving.
  • For unstable sources, add an archive.org link as well.
  • Say if the source needs registration or payment.

Common citation errors

[edit source]

Incomplete information

[edit source]
  • Missing dates: include the publication date or the date you accessed the page.
  • Vague titles: use the full title of the document.
  • No page numbers: give the page, table or section for any long document.
  • Broken links: check every URL before saving.

Over-citation

[edit source]

These do not need a citation:

  • common knowledge, such as what a capacitor does
  • simple procedures, such as basic cleaning steps

Under-citation

[edit source]

Always cite:

  • unusual or surprising specifications
  • safety procedures
  • claims that might be disputed

See also

[edit source]