Tekwiki Guidelines: Difference between revisions

(10 intermediate revisions by 2 users not shown)
Line 32: Line 32:
Recommendation: Turn off all processing except for OCR.  
Recommendation: Turn off all processing except for OCR.  
Always keep the raw scan in case it needs to be reprocessed for whatever reason.  
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.  
Maybe in twenty years, the automatic enhancement software will be reliable.
 
The eventual goal is for all PDFs on Tekwiki 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.  
It is fine to upload scans that other people made for free distribution.  
Line 50: Line 53:


==ROM Images==
==ROM Images==
Tekwiki hosts a collection of [[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:
ROM images should be uploaded in plain binary format. S-record files can be converted beforehand using GNU binutils:
Line 57: Line 60:
objcopy -I srec -O binary rom.hex rom.bin
objcopy -I srec -O binary rom.hex rom.bin
</tt>
</tt>
The file naming scheme we use is <tek part number>.bin. Example: 156-0660-01.bin


==Quotes==
==Quotes==
Line 97: Line 102:
'''Internal links are helpful. '''
'''Internal links are helpful. '''
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.
==Caveats and Quirks==
Beware of the "edit" links next to section headings.<br>
[[File:Template section heading edit link.png]]<br>
These edit links sometimes take you to a page where you are editing the template, not the Tekwiki article.
If you end up in an edit window titled something like "Editing Template:MissingSpecs (section)", hit the back button or cancel.
The most reliable and least confusing thing is to use the edit link at the top of the page, not the edit links next to the section headings.


==Categories==
==Categories==
Line 150: Line 162:
In-camera flashes usually result in high glare, hard shadows, and poor color rendition.  
In-camera flashes usually result in high glare, hard shadows, and poor color rendition.  


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.
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.
 
When photographing an instrument, it's good to also get internal photos.
Using a high f stop and indirect flash (e.g. via a white ceiling) helps put a large part of the image in focus.


When photographing an instrument, it's good to also get internal photos. Using a high f stop and indirect flash (e.g. via a white ceiling) helps put a large part of the image in focus.
File names should be relate 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 "tek_647a_hv_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.


File names should be relate to the subject of the photo. Cameras generate semi-arbitrary filenames. Those should be replaced with more meaningful names before the files are uploaded.
Mostly, Tekwiki refers to images inside of gallery blocks.
When in doubt, look at how the markup is done on other pages.


===Commented examples===
===Commented examples===
Line 183: Line 206:
</gallery>
</gallery>


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


[[Category:TekWiki]]
[[Category:TekWiki]]