Protospace Wiki:Adding new tools: Difference between revisions

Jump to navigation Jump to search

Protospace Wiki:Adding new tools (view source)

Revision as of 03:02, 8 November 2022

4,945 bytes removed ,  8 November 2022
Remove lazy tool list option #1
No edit summary
(Remove lazy tool list option #1)
Line 3: Line 3:
==Preparing to add a tool==
==Preparing to add a tool==
* '''Gather information on the tool.''' Try to get as much of the following information as you can, but don't worry about missing information as long as its absence won't keep anyone from figuring out which physical tool at Protospace corresponds to which gallery entry or page on the wiki. You '''must''' provide enough information for that purpose, whether it's in the form of a photo showing distinctive markings, a serial number, or (reverse approach) a label on the tool linking to the wiki page. If you do not, your addition will be meaningless and will probably have to be deleted and recreated from scratch.
* '''Gather information on the tool.''' Try to get as much of the following information as you can, but don't worry about missing information as long as its absence won't keep anyone from figuring out which physical tool at Protospace corresponds to which gallery entry or page on the wiki. You '''must''' provide enough information for that purpose, whether it's in the form of a photo showing distinctive markings, a serial number, or (reverse approach) a label on the tool linking to the wiki page. If you do not, your addition will be meaningless and will probably have to be deleted and recreated from scratch.
* '''Decide what kind of entry you want to add:''' 1) just an entry in the [[tools we have|tools gallery]] or 2) a full page about the tool. The latter is generally preferable because it's more useful to people looking for info on the tool in the future, and because it allows the assignment of a wiki-ID number for the tool. Even if you feel like you only have enough information for a gallery entry, you may still (and are encouraged to) make a full page, because this makes it easier for others to fill in that info later.
* '''Take a photo of the tool.'''
* '''Take a photo of the tool.'''
** Try to take it in good lighting.
** Try to take it in good lighting.
Line 10: Line 9:
* '''Consider once more whether those who work on the wiki after you will be able to easily tell which physical item in Protospace is represented by what you're about to add.''' If the answer is no, consider what additional info you could include (or how else you could distinguish the tool, such as by adding a label to it) to help with this. Adding information that refers to a tool that others can't positively identify in the physical world is usually worse than not adding the tool to the wiki at all. If in doubt, ask on the forum (or an appropriate talk page on the wiki that may exist in the future).
* '''Consider once more whether those who work on the wiki after you will be able to easily tell which physical item in Protospace is represented by what you're about to add.''' If the answer is no, consider what additional info you could include (or how else you could distinguish the tool, such as by adding a label to it) to help with this. Adding information that refers to a tool that others can't positively identify in the physical world is usually worse than not adding the tool to the wiki at all. If in doubt, ask on the forum (or an appropriate talk page on the wiki that may exist in the future).


==Option 1: Adding a tool as just an entry in the tools gallery==
==Adding a tool page==
 
This option will result in an entry for the tool on the [[tools we have]] page. It will consist of a photo (which can be clicked to enlarge) and whatever description you type in. Don't worry—it can be upgraded to a tool page later.
 
* Advantages: quick and easy
* Disadvantages: not as informative; the tool may not be assigned a wiki-ID; info about the tool cannot be easily linked to from elsewhere on the wiki/forum or from a label on the tool
 
Procedure:
 
# Upload the photo of the tool. '''DO NOT use a number as the filename.''' (It can be moved to a number later if a wiki-ID is assigned to the tool.) Try to use a short and descriptive name of the tool, such as its make and model, its color, etc., but the exact name is unimportant for now, as long as you can copy and paste it. Once the upload is done, either copy the filename from the top of the page, or leave the tab open so you can do that when you reach step 3.
# Decide on a name for the wiki to refer to the tool by. At this point (before the page is created) it doesn't matter as much, but try to follow the format: <code>[tool type], [distinguishing characteristics separated by commas] ([make/model])</code> (with each part but the first being included only if it makes sense). If the tool was made by a member and therefore has no make/model, use the member's name in possessive form.
#: Examples:
#:* Laser cutter, large (Rabbit Laser RL-80-1290)
#:* Counter (Fluke 1910A Multi-Counter)
#:* Function generator (John's)
#:* Power supply, bench, 2-channel (TENMA 72-7245)
#:* Vise, wood (Travis's)
#:* Magnifier lamp, large, without lid
#:* Forge, propane (Jim's)
# Edit the appropriate section of the [[tools we have]] gallery to insert an entry. Insert it in the appropriate place in the section according to where the name you chose in step 2 fits in alphabetical order.
#* If editing in source mode, copy and paste the code below, or follow the format of the entries already there.
#*: <pre>File:FILENAME                          |TOOLDESCRIPTION</pre>
#* If editing in visual mode, double-click the gallery in the appropriate section (or click once to select it and then click the "Edit" button that appears), then click "+ Add new image" at the bottom-left of the popup window. In the search box, type in the filename of the image, including the filename extension. When the image appears, click it. It will join the others in the column on the left; drag it to the appropriate alphabetical position. Don't close the popup window yet.
# Fill in the info:
#* If editing in source mode, replace <code>FILENAME</code> with the name of the image you uploaded, such as <code>File:Red hacksaw.jpg</code>, and replace <code>TOOLDESCRIPTION</code> with the name you decided on in step 2, followed by any other info you think is important to include. Be careful to not delete the pipe (<code>|</code>) before <code>TOOLDESCRIPTION</code>, and make sure there are no spaces immediately after the pipe.
#* If editing in visual mode, click the link button (with the chain icon) at the top of the caption field below the image on the right side of the popup window. Start typing the title of the page you created, and click it when it appears in the suggestions. Now click the blue "Apply changes" button at the top-right of the popup window.
# If editing in source mode, click the "Show preview" button at the bottom of the editor to check that your addition appears correctly. (In visual mode, the editor itself serves as the preview.) If not, try to fix it so it does. If you can't, proceed anyway, and somebody else will probably fix it soon.
# Click the "Save changes" button (at the bottom in source mode or the top-right in visual mode) to publish your addition, preferably with an edit summary saying which tool you added.
 
==Option 2: Adding a tool page==


This option will result in a page about the tool, linked from the tools gallery. Clicking on the picture in the tools gallery will open the tool's page instead of enlarging the picture (though you can still enlarge the picture by clicking on it where it appears in the tool's own page).
This option will result in a page about the tool, linked from the tools gallery. Clicking on the picture in the tools gallery will open the tool's page instead of enlarging the picture (though you can still enlarge the picture by clicking on it where it appears in the tool's own page).
Line 104: Line 74:
# If editing in source mode, click the "Show preview" button at the bottom of the editor to check that your addition appears correctly. (In visual mode, the editor itself serves as the preview.) If not, try to fix it so it does. If you can't, proceed anyway, and somebody else will probably fix it soon.
# If editing in source mode, click the "Show preview" button at the bottom of the editor to check that your addition appears correctly. (In visual mode, the editor itself serves as the preview.) If not, try to fix it so it does. If you can't, proceed anyway, and somebody else will probably fix it soon.
# Click the "Save changes" (at the bottom in source mode or the top-right in visual mode) button to publish your addition, preferably with an edit summary saying which tool you added.
# Click the "Save changes" (at the bottom in source mode or the top-right in visual mode) button to publish your addition, preferably with an edit summary saying which tool you added.
==Upgrading a tool from just a gallery entry (option 1) to a page (option 2)==
:''Prerequisite: a gallery entry, created as described under 'Option 1' (above)''
This upgrade procedure will result in a page about the tool, linked from the tools gallery. Clicking on the picture in the tools gallery will open the tool's page instead of enlarging the picture (though you can still enlarge the picture by clicking on it where it appears in the tool's own page).
Procedure:
''[not written yet; you can probably figure it out if you need to]''


==Assigning a wiki-ID to a tool that doesn't have one==
==Assigning a wiki-ID to a tool that doesn't have one==
Retrieved from "https://wiki.protospace.ca/Special:MobileDiff/6162"

Navigation menu