Tekwiki Guidelines: Difference between revisions

No edit summary
 
(16 intermediate revisions by 3 users not shown)
Line 6: Line 6:
* We can improve things later.
* 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.
* 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. :-)




__TOC__
=Page Text=
 
==Page Text==
'''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.
Line 17: Line 16:


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.
===Capitalization===
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]]. 
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 inputs first and foremost, the admins and regulars will help with formatting and style.


===Tables===
===Tables===
Line 66: Line 74:
'''Please sign your contributions on discussion pages''' at the end of your text - you can simply type four tildes (<code><nowiki>~~~~</nowiki></code>) to do so.
'''Please sign your contributions on discussion pages''' at the end of your text - you can simply type four tildes (<code><nowiki>~~~~</nowiki></code>) to do so.
Using colons (<code><nowiki>: your reply</nowiki></code>, <code><nowiki>:: reply to your reply</nowiki></code>) helps making the discussions more readable.
Using colons (<code><nowiki>: your reply</nowiki></code>, <code><nowiki>:: reply to your reply</nowiki></code>) helps making the discussions more readable.
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===
===Repair Reports – "/Repairs" Pages===
Line 98: Line 108:
When another instrument is mentioned in a page, make that a link in case readers want to explore that connection.
When another instrument is mentioned in a page, make that a link in case readers want to explore that connection.


==Document Scans==
To link to pages in the (English) Wikipedia, you can use the form <code><nowiki>[[wikipedia:Article name|displayed text]]</nowiki></code>, likewise to link to pages in our sister project, use [[grwiki:Main Page|GRWiki]], <code><nowiki>[[grwiki:Article name|displayed text]]</nowiki></code>.
 
=Document Scans=
'''Favor any scan over no scan. '''
'''Favor any scan over no scan. '''
The presence of free scans of manuals and other documentation is hugely important.
The presence of free scans of manuals and other documentation is hugely important.
Line 135: Line 147:
A useful online alternative is https://pdf.io/unlock/
A useful online alternative is https://pdf.io/unlock/


==Photos==
=Photos=
'''Any photo is better than no photo.'''
'''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.  
Prefer high-resolution, in-focus photos.  When photographing an instrument, it's good to also get internal photos.  
Line 147: Line 159:
The filename extension should be lowercase.  
The filename extension should be lowercase.  


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


When uploading a file, the name may get changed slightly by the wiki system.
When uploading a file, the name may get changed slightly by the wiki system.
Line 157: Line 169:
Prefer photos with low noise (without artificial denoising). High noise often comes from having inadequate light and therefore needing high ISO.  
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.
'''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.  Cropping very tight can look distractingly unnatural. Often it is better to leave a little bit of natural "breathing room" around the object being photographed. Shallow depth of field can be used to put the background out of focus so it is less distracting but still natural looking. 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.   
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.  
Good color rendition often comes from having minimal glare, which often comes from diffused lighting.
Avoid the use of processing that artificially boosts contrast or artificially boosts colors.


Using the in-camera flash head-on usually results in high glare, hard shadows, and poor color rendition, and should be avoided.
Using the in-camera flash head-on usually results in high glare, hard shadows, and poor color rendition, and should be avoided.
Line 174: Line 187:
* put the camera on a tripod
* put the camera on a tripod
* use low ISO and a high f stop, resulting in a longer exposure time
* 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)
* 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 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
* lower graticule lighting intensity accordingly
Line 180: Line 193:
===Commented examples===
===Commented examples===
<gallery>
<gallery>
Tek_524_trace.jpg|Hard shadows are distracting
Tek_524_trace.jpg         | Hard shadows are distracting
Tek_524ad_front.jpg|Same subject, but without hard shadows
Tek_524ad_front.jpg       | Same subject, but without hard shadows
6r1a_front.JPG|Good photo, taken outside on a cloudy day
6r1a_front.JPG           | Good photo, taken outside on a cloudy day
Tek_rm547.jpg|Hard shadows, but still a useful photo
Tek_rm547.jpg             | Hard shadows, but still a useful photo. Trapezoid distortion could be avoided easily.
Tek 511a 4.JPG|Low resolution image
Tek 511a 4.JPG           | Low resolution image
Tek_1L60_from_fiche.jpg|Low quality image taken from documentation, much better than nothing
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]].
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_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_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.
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-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_11a33_inputrelay.jpg | Macro closeups can be interesting, particularly when they illustrate something important.
Tek_1l5_front.JPG|This image suffers from nonuniform illumination.
Tek_1l5_front.JPG         | This image suffers from nonuniform illumination.
Type_m_front.jpg|Hard shadows from light coming from below. It seems unnatural.
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_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_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_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.
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>
</gallery>


Line 205: Line 220:
</gallery>
</gallery>


==ROM Images==
=ROM Images=
Tekwiki hosts a collection of [[ROM images]].  
Tekwiki hosts a collection of [[ROM images]].  


Line 216: Line 231:
The file naming scheme we use is <tek part number>.bin. Example: 156-0660-01.bin
The file naming scheme we use is <tek part number>.bin. Example: 156-0660-01.bin


==See Also==
=See Also=
* [[Tasks]]
* [[Tasks]]


[[Category:TekWiki]]
[[Category:TekWiki]]
<headertabs />