If you get the "Sorry, the file cannot be displayed. There seems to be a technical issue ..." error when trying to view an image, a workaround is to click on the cog icon in the upper right side of the media viewer, and then select "Disable Media Viewer". We are aware of the problem and are looking for a solution.

Tekwiki Guidelines

From TekWiki
Jump to: navigation, search

This page provides guidelines on Tekwiki 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.

Text

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

We have some article templates that generate headlines, infoboxes and the like. Using these makes it easy to have consistently styled articles, but they are optional to use.

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.

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.

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.

It is helpful if files are named <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 Tekwiki. 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.

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:

objcopy -I srec -O binary rom.hex rom.bin

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. For example, see the quote toward the top of the 524 page.

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, on a single line without reflowing:

  • 067-1234-01
  • 067-1234-02
  • 067-1234-03
  • 067-1234-04
  • 067-1234-05
  • 067-1234-06
  • 067-1234-07

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

On Tekwiki, we use a space between the number and the unit. It's best to use a non-breaking space. 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 "Ω".

We aren't rigid about imperial units versus metric, e.g., kg versus lb. Use one, or the other, or both.

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 Tekwiki article. But we want Tekwiki 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.

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. See, for example, the bottom of the 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. For example, the category "TM500 multimeter plugins" is categorized as both "Digital multimeters" and "TM500 series plugins".

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). Tekwiki 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.

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 for the same instrument.

Please categorize individual repair pages using [[Category:Instrument repair reports]].

Collaboration

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.

Photos

Any photo is better than no photo. Prefer high-resolution, in-focus photos.

Don't use photos from other websites if you think it will upset the owner of the photo. 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. Prefer photos with low noise (without artificial denoising). Low noise often comes from having adequate light.

Prefer photos without the in-camera flash. 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.

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.

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

Commented examples

It is difficult to get a good photo of an oscilloscope showing its trace.