GRWiki Guidelines: Difference between revisions

From GRWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 7: Line 7:
* Collaborate freely - '''Feel free to improve text added by other people.''' If something is confusing, make it clear.  If you're unsure, raise the question on the Talk/Discussion page.
* Collaborate freely - '''Feel free to improve text added by other people.''' If something is confusing, make it clear.  If you're unsure, raise the question on the Talk/Discussion page.
* We encourage helpful comments in the change summary – especially when it's not clear why a change was made. :-)
* We encourage helpful comments in the change summary – especially when it's not clear why a change was made. :-)


__TOC__
__TOC__
Line 14: Line 13:
'''Text should be in the style of an encyclopedia. '''
'''Text should be in the style of an encyclopedia. '''
Avoid unattributed text in the first person.
Avoid unattributed text in the first person.
<!--
We have some [[article templates]] that generate headlines, infoboxes and the like.  Using these is strongly encouraged as they populate respective [[Special:CargoTables|database tables]] and make it easier to see what information is missing.
-->


In general, don't worry about style or formatting issues too much.  We really appreciate good technical input in any form, and will help with formatting if needed.
In general, don't worry about style or formatting issues too much.  We really appreciate good technical input in any form, and will help with formatting if needed.
Line 24: Line 19:
In general we are aligning with [[wikipedia:Wikipedia:Naming_conventions_(capitalization)|relevant conventions in Wikipedia]].   
In general we are aligning with [[wikipedia:Wikipedia:Naming_conventions_(capitalization)|relevant conventions in Wikipedia]].   
Inter alia, we don't capitalize the second or subsequent words in an article title, unless the title is a [[wikipedia:proper name|proper name]].   
Inter alia, we don't capitalize the second or subsequent words in an article title, unless the title is a [[wikipedia:proper name|proper name]].   
<!--
 
There are several places where text entered into an article template is both entered into a database, and displayed in a headline - for example, the "summary=" or "description=" arguments to various article templates.
The text in these should not be capitalized - it will be automatically capitalized in the headline display.
-->
Again, don't worry about style too much – we need your technical input first and foremost, the admins and regulars will help with formatting and style.
Again, don't worry about style too much – we need your technical input first and foremost, the admins and regulars will help with formatting and style.
<!--
===Tables===
The Mediawiki software is limited in its ability to size pages and tables especially to fit different browsers.
A useful way to ensure that tables you create look reasonable for most viewers is to first resize your browser window so that it just barely shows the following 7 column wide list, widely used on the [[Main Page|main page]], on a single line without reflowing:
<div style="column-count:7;-moz-column-count:7;-webkit-column-count:7">
* 067-1234-01
* 067-1234-02
* 067-1234-03
* 067-1234-04
* 067-1234-05
* 067-1234-06
* 067-1234-07
</div>
This will tend to give you a window that is slightly narrower than desired by popular web sites. If your table looks good at this window size, it will work for most people.
-->


===Units===
===Units===
<!--[[File:Unit buttons.png|right|thumb|450px]]-->
We aren't rigid about imperial units versus metric, e.g., kg versus lb. Use one, or the other, or both.
We aren't rigid about imperial units versus metric, e.g., kg versus lb. Use one, or the other, or both.
On GRwiki, we use a space between the number and the unit. It's best to use a non-breaking space.
On GRwiki, we use a space between the number and the unit. It's best to use a non-breaking space.
<!--
:'''Pro Tip:''' The predefined unit buttons shown under the text editor make it easy to insert units beginning with a non-breaking space character, and many of the special characters like "Ω".
-->


===Categories===
===Categories===
We have defined a number of categories.
We have defined a number of categories.
Pages are added to a category by putting a <code><nowiki>[[Category:...]]</nowiki></code> tag in the page, typically at the bottom.
Pages are added to a category by putting a <code><nowiki>[[Category:...]]</nowiki></code> tag in the page, typically at the bottom.
<!--
See, for example, the bottom of the [[82|Type 82]] page.
This allows us to have an auto-generated page that lists all items in a category.
If it seems appropriate to add a certain category tag to a page, do so.
Also, if it seems appropriate to make a new category, do so.
Categories are usually categorized themselves, thereby creating a hierarchy of categories, or taxonomy.
Here's an example category hierarchy:
: TekWiki → Technology → Test equipment → Oscilloscopes → Sampling scopes‎ → Digital Sampling scopes‎ → 11800 series mainframes‎
:'''Pro Tip:''' The '''[https://w140.com/tekwiki/wiki/Special:CategoryTree?target=Category%3ATekWiki&mode=categories&namespaces=&title=Special%3ACategoryTree Category Tree]''' function allows you to navigate the category hierarchy with ease.
The general convention is not to add a both a more specialized category and its parent category – e.g. a page in category ''Dual-beam CRTs'' should not have category ''Cathode ray tubes'' as well because that is the parent category of ''Dual-beam CRTs'' (logic: every dual-beam CRT is a cathode ray tube anyway).
It is possible to assign multiple categories.  For example, the category "TM500 multimeter plugins" is categorized as both "Digital multimeters" and "TM500 series plugins".
-->


===Talk/Discussion Pages===
===Talk/Discussion Pages===
Line 87: Line 40:


It's a good idea to keep an eye on the "[[Special:Recentchanges|Recent changes]]" page so you can see the changes others are making to the wiki.
It's a good idea to keep an eye on the "[[Special:Recentchanges|Recent changes]]" page so you can see the changes others are making to the wiki.
<!--
===Repair Reports – "/Repairs" Pages===
Reports of individual repairs should go on a "/Repairs" sub-page under the main article for that instrument, e.g. [[585/Repairs]]. 
A description of symptoms, causes identified and solutions implemented is most welcome, whether in bullet-list or narrative style.
Photos of the specific problem or solution will help others in their work!
The link to the repair page will be displayed in a tab on top of each article, next to the "Discussion" tab.
Information about general known repair issues such as components that are prone to failure can go into a section (e.g. "Common Problems") in the main article.
It is quite OK to have both a Common Problems section and a Repairs article [[7CT1N|for the same instrument]].
Please categorize individual repair pages using <code><nowiki>[[Category:Instrument repair reports]]</nowiki></code>.
-->


===Quotes===
===Quotes===
Line 145: Line 82:
It is fine to upload scans that other people made for free distribution.  
It is fine to upload scans that other people made for free distribution.  
Don't upload scans from companies like Artek, where the scan was done to make money.
Don't upload scans from companies like Artek, where the scan was done to make money.
<!--
For Tektronix manuals, our convention is to name files according to the Tek manual part number, <document_part_number>.pdf – For example, 070-8123-45.pdf.
This allows us to create links to manuals we don't have yet, and the link starts working when somebody uploads the file, named in the recommended way.
The document part number is usually found on the title  page and/or the page footer of Tek manuals.
When uploading a PDF document with a 070-1234-00 style document number, please add it to the [[manuals]] list whether you also reference it elsewhere or not.
-->


Rather than linking to a document on a remote site, prefer to upload of copy of the document to GRWiki.
Rather than linking to a document on a remote site, prefer to upload of copy of the document to GRWiki.
Line 197: Line 125:


Taking photos outside on an overcast but reasonably bright day can work too, but since you can't easily control ambient light intensity, this is tricky when parts of the instrument that emit light need to be in the photo. It's hard to get the right balance of ambient light and emitted light.
Taking photos outside on an overcast but reasonably bright day can work too, but since you can't easily control ambient light intensity, this is tricky when parts of the instrument that emit light need to be in the photo. It's hard to get the right balance of ambient light and emitted light.
<!--
Tips for '''photographing CRT traces''':
* put the camera on a tripod
* use low ISO and a high f stop, resulting in a longer exposure time
* turn ''down'' the camera's exposure compensation control (i.e. towards a darker image) – auto-exposure wants to balance lighting across the image, often causing the trace to become over-exposed
* lower trace intensity to avoid blooming and visible artefacts - the camera will make up for the lower intensity in longer exposure time
* lower graticule lighting intensity accordingly
-->
<!--
===Commented examples===
<gallery>
Tek_524_trace.jpg        | Hard shadows are distracting
Tek_524ad_front.jpg      | Same subject, but without hard shadows
6r1a_front.JPG            | Good photo, taken outside on a cloudy day
Tek_rm547.jpg            | Hard shadows, but still a useful photo. Trapezoid distortion could be avoided easily.
Tek 511a 4.JPG            | Low resolution image
Tek_1L60_from_fiche.jpg  | Low quality image taken from documentation, much better than nothing
Timkoeth_519_TWK_1379.jpg | Beautiful CRT trace photo of a [[519]].
Tek_945_front7c.jpg      | Good straight-on scope photo using two flashes: one bouncing off the ceiling, one passing through a white umbrella.
Tek_7a42_fr4.jpg          | Good photo of traces and readout on 7000-series scope
Tek_11a33_rearleft.jpg    | Good photo of the inside of an [[11A33]]. Plenty of light, but not too much glare. Colors and textures are realistic.  Good depth of field (board as well as higher components are in focus).
Tek-7623A.jpg            | Good CRT traces and a good picture of the front panel in one photo. Rare.
Tek_11a33_inputrelay.jpg  | Macro closeups can be interesting, particularly when they illustrate something important.
Tek_1l5_front.JPG        | This image suffers from nonuniform illumination.
Type_m_front.jpg          | Hard shadows from light coming from below. It seems unnatural.
Tek_1a7_front.jpg        | Good color rendition. Red looks red.
Tek_type_s.jpg            | Low resolution and bad color balance. The plug-in looks green.
Tek_3a74_front.jpg        | Bad color balance. The plug-in looks pink.
Tek_type_mc_left.jpg      | Photo using a flashlight as a light source. Nonuniform illumination and hard shadows, but decent color rendition, decent focus, and not too noisy. Much better than nothing.
5ct1n-crop.jpg            | Perspective distortion (note "diverging" binding posts) caused by wide-angle, close-up shot.
Tek_7b85_front.jpg        | Front panel shot at a longer focal length to avoid excessive perspective distortion; precise focus on front panel lettering.
</gallery>
It is difficult to get a good photo of an oscilloscope showing its trace.
<gallery>
Tek 547 trace two sine.jpg|It is common for photos of scope traces to show artifacts that are normally not seen.
</gallery>
-->
<!--
==ROM Images==
Tekwiki hosts a collection of [[ROM images]].
ROM images should be uploaded in plain binary format. S-record files can be converted beforehand using GNU binutils:
<tt>
objcopy -I srec -O binary rom.hex rom.bin
</tt>
The file naming scheme we use is <tek part number>.bin. Example: 156-0660-01.bin
==See Also==
* [[Tasks]]
-->


[[Category:GRWiki]]
[[Category:GRWiki]]
<!--
<headertabs />
-->

Revision as of 02:30, 13 December 2023

This page provides guidelines on GRWiki content. These are things to consider, not rigid rules.

  • Something is usually better than nothing.
  • Perfectionism is harmful.
  • It's ok to click "Save changes" when things aren't perfect.
  • We can improve things later.
  • Collaborate freely - Feel free to improve text added by other people. If something is confusing, make it clear. If you're unsure, raise the question on the Talk/Discussion page.
  • We encourage helpful comments in the change summary – especially when it's not clear why a change was made. :-)

Page Text

Text should be in the style of an encyclopedia. Avoid unattributed text in the first person.

In general, don't worry about style or formatting issues too much. We really appreciate good technical input in any form, and will help with formatting if needed.

Capitalization

In general we are aligning with relevant conventions in Wikipedia. Inter alia, we don't capitalize the second or subsequent words in an article title, unless the title is a proper name.

Again, don't worry about style too much – we need your technical input first and foremost, the admins and regulars will help with formatting and style.

Units

We aren't rigid about imperial units versus metric, e.g., kg versus lb. Use one, or the other, or both. On GRwiki, we use a space between the number and the unit. It's best to use a non-breaking space.

Categories

We have defined a number of categories. Pages are added to a category by putting a [[Category:...]] tag in the page, typically at the bottom.

Talk/Discussion Pages

If you have any doubt about a change that you want to make, or a change that somebody else made, feel free to edit the associated Talk/Discussion page (the "Discussion" link at the upper left of each page). GRwiki administrators monitor those pages and will respond to questions. For example, if you want to start a new category but aren't sure, feel free to edit the Talk/Discussion page.

Please sign your contributions on discussion pages at the end of your text - you can simply type four tildes (~~~~) to do so. Using colons (: your reply, :: reply to your reply) helps making the discussions more readable.

It's a good idea to keep an eye on the "Recent changes" page so you can see the changes others are making to the wiki.

Quotes

If you quote a person or a document, make that clear by saying who/what is being quoted, and using <blockquote>...</blockquote> tags.

It's fine to have text in the first person inside of an attributed quote.

Attribution

Sometimes another website has the perfect photo, or perfect document, or perfect table of data that's not available elsewhere. In those cases, it is fine to link to the external resource from a GRWiki article.

But we want GRWiki to last for a long time, so it is good to make a local copy if possible, in case the external website (or just that resource) disappears.

One way to do this is to make a copy of the resource, but to comment out the link to the local copy, and have the active link go to the external site. If the external site disappears, we can uncomment the local link and comment the external link.

Links

Internal links are helpful. When another instrument is mentioned in a page, make that a link in case readers want to explore that connection.

Document Scans

Favor any scan over no scan. The presence of free scans of manuals and other documentation is hugely important. In many cases the availability of a free scan makes the difference between an instrument being put in the trash versus being restored.

Favor high quality over small file size. What seems like a big file today will not seem so big in ten years.

Favor one-up (one document page per PDF page).

When scanning a document, best quality is obtained by removing the binding and scanning the pages flat.

Beware of software that claims to provide automatic image enhancement for scans. Automatic enhancement often corrupts the scan in ways that are hard to notice until later.
Recommendation: Turn off all processing except for OCR. Always keep the raw scan in case it needs to be reprocessed for whatever reason. Maybe in twenty years, the automatic enhancement software will be reliable.

The eventual goal is for all PDFs on GRWiki to be text-searchable. If a PDF isn't already text-searchable, add the "Needs OCR" category tag to the file page.

It is fine to upload scans that other people made for free distribution. Don't upload scans from companies like Artek, where the scan was done to make money.

Rather than linking to a document on a remote site, prefer to upload of copy of the document to GRWiki. Too often, the remote site disappears and we end up with broken links and no way to access the document.

Strongly prefer PDF files with password protection completely turned off. QPDF is useful for removing encryption and thereby also clearing the various print/copy permission flags. A useful online alternative is https://pdf.io/unlock/

Photos

Any photo is better than no photo. Prefer high-resolution, in-focus photos. When photographing an instrument, it's good to also get internal photos.

Don't use photos from other websites if you think it will upset the owner of the photo.

Photo files in GRWiki

File names should be related to the subject of the photo.

Cameras generate semi-arbitrary filenames. Those should be replaced with more meaningful names before the files are uploaded. The filename extension should be lowercase.

For example, rename "IMG_143721.JPG" to "gr_1657_transformer.jpg".

When uploading a file, the name may get changed slightly by the wiki system. The text after the "File:" on the upload page (not the URL bar in the browser) is the name you should use when referring to the files.

Mostly, GRWiki refers to images inside of gallery blocks. When in doubt, look at how the markup is done on other pages.

Taking your own photos

Prefer photos with low noise (without artificial denoising). High noise often comes from having inadequate light and therefore needing high ISO.

Avoid geometric distortion (like taking a front panel shot from above, or a close-up taken with a wide-angle lens), and trim excessive unrelated background. Front panels look better shot from a few meters away using a telephoto lens/focal length.

Prefer diffused lighting (no hard shadows), natural color balance, and good color rendition. Good color rendition often comes from having minimal glare, which often comes from diffused lighting.

Using the in-camera flash head-on usually results in high glare, hard shadows, and poor color rendition, and should be avoided.

Indirect flash (e.g. via a white ceiling, to your rear) provides uniform, soft lighting. See e.g. this tutorial video (TL;DR: here's the crucial bit). In a pinch, use a home-made retroreflector on the in-camera flash, e.g. like this. Manually setting a high flash exposure (+2 or +3 is not unusual on rear-bounce) and using a high f stop helps put a large part of the image in focus.

Taking photos outside on an overcast but reasonably bright day can work too, but since you can't easily control ambient light intensity, this is tricky when parts of the instrument that emit light need to be in the photo. It's hard to get the right balance of ambient light and emitted light.

Retrieved from "https://www.grwiki.org/grwiki/index.php?title=GRWiki_Guidelines&oldid=7"