2,359
edits
GRWiki Guidelines: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary Tag: Manual revert |
No edit summary |
||
| Line 8: | Line 8: | ||
* 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. :-) | ||
=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 24: | Line 23: | ||
===Units=== | ===Units=== | ||
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. | Do please use modern SI units and prefixes for specifications, e.g. "100 MHz" not "100 Mc", "10 pF" not "10 μμF", "20 μS" not "20 μmhos". Seconds are lowercase "s", Siemens (conductivity) uppercase "S". | ||
On GRwiki, we use a space between the number and the unit. It's best to use a non-breaking space (Alt-0160). There are handy buttons under the editor box that insert the unit with a nonbreaking space in one click. | |||
===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. | ||
Categories are usually categorized themselves, thereby creating a hierarchy of categories, or taxonomy. | |||
Here's an example category hierarchy: | |||
: GRWiki → Technology → Test equipment → Impedance measurement | |||
:'''Pro Tip:''' The '''[https://grwiki.org/grwiki/wiki/Special:CategoryTree?target=Category%3AGRWiki&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. | |||
It is common to assign multiple categories. | |||
===Talk/Discussion Pages=== | ===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 | 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 | ||
to edit the associated Talk/Discussion page (the "Discussion" link at the upper left of each page). | (the "Discussion" link at the upper left of each page). GRwiki administrators monitor those pages and will respond to questions. | ||
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. | For example, if you want to start a new category but aren't sure, feel free to edit the Talk/Discussion page. | ||
| Line 59: | Line 67: | ||
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= | |||
'''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 86: | Line 94: | ||
Too often, the remote site disappears and we end up with broken links and no way to access the document. | Too often, the remote site disappears and we end up with broken links and no way to access the document. | ||
=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 118: | Line 126: | ||
See e.g. [https://www.youtube.com/watch?v=1mF9UHK8LwU this tutorial video] (TL;DR: [https://youtu.be/1mF9UHK8LwU?t=743 here's the crucial bit]). | See e.g. [https://www.youtube.com/watch?v=1mF9UHK8LwU this tutorial video] (TL;DR: [https://youtu.be/1mF9UHK8LwU?t=743 here's the crucial bit]). | ||
In a pinch, use a home-made retroreflector on the in-camera flash, e.g. [https://thecraftingnook.com/diy-flash-bouncer-dslr-flash-reflector/ like this]. | In a pinch, use a home-made retroreflector on the in-camera flash, e.g. [https://thecraftingnook.com/diy-flash-bouncer-dslr-flash-reflector/ 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. | 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. | 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. | |||
[[Category:GRWiki]] | [[Category:GRWiki]] | ||
__NOTOC__ | |||
<headertabs /> | |||