|
|
| Line 1: |
Line 1: |
| If a tool has been donated, semi-permanently loaned, or brought into the space for a specific short-term, it is encouraged to add the tool to the "[[tools we have]]" gallery page. This will help avoid damage due to other members being uninformed about the tool's operation, maintenance, ownership, etc. Follow this procedure to achieve that. | | If a tool has been donated, semi-permanently loaned, or brought into the space for a specific short-term, it is encouraged to add the tool to the "[[tools we have]]" gallery page. This will help avoid damage due to other members being uninformed about the tool's operation, maintenance, ownership, etc. Follow this procedure to achieve that. |
|
| |
| ==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.
| |
| * '''Take a photo of the tool.'''
| |
| ** Try to take it in good lighting.
| |
| ** If you can, make the background as uncluttered as possible. (Suggestions: Put the tool against a blank wall or on a clean table. Put a piece of cardboard or plywood behind the tool. Edit the photo to blur the background/surroundings.)
| |
| ** Crop it if necessary to avoid excessive space around the tool at the edges of the photo.
| |
| * '''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).
| |
|
| |
|
| ==Adding a tool page== | | ==Adding a tool page== |
| Line 13: |
Line 5: |
| Procedure: | | Procedure: |
|
| |
|
| # Decide on a name for the wiki to refer to the tool by. 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. (Don't worry too much about getting it exactly right—anybody can fix it later by moving the page and updating any redirects.) '''Don't add an ID number at the end yet.'''
| | * Decide on a name for the wiki to refer to the tool by. Try to follow the format: <code>[tool type], [distinguishing characteristics separated by commas] ([make/model])</code>. If the tool was made by a member and therefore has no make/model, use the member's name in possessive form. '''Don't add an ID number at the end yet.''' |
| #: Examples:
| | *: Examples: |
| #:* Laser cutter, large (Rabbit Laser RL-80-1290)
| | *:* Laser cutter, large (Rabbit Laser RL-80-1290) |
| #:* Counter (Fluke 1910A Multi-Counter)
| | *:* Counter (Fluke 1910A Multi-Counter) |
| #:* Function generator (John's)
| | *:* Function generator (John's) |
| #:* Power supply, bench, 2-channel (TENMA 72-7245)
| | *:* Power supply, bench, 2-channel (TENMA 72-7245) |
| #:* Vise, wood (Travis's)
| | *:* Vise, wood (Travis's) |
| #:* Magnifier lamp, large, without lid
| | *:* Magnifier lamp, large, without lid |
| #:* Forge, propane (Jim's)
| | *:* Forge, propane (Jim's) |
| # Enter that name in the search box. Press Enter. You should arrive on a search results page where there's a line below the search box and options that says "Create the page "[what you entered]" on this wiki!". Click the redlink in the middle of that line. Now you will arrive at an editor with what you entered set as the page's title.
| | * Enter that exact name in the search box. Press Enter. In the middle of the search results, you should see: "Create the page ___________ on this wiki!". Click the red link. |
| # Add the template to the page:
| | * Make sure '''"Create source"''' is selected at the top. |
| #* If editing in source mode, copy and paste the following code into the editor:
| | * Paste this into the text box: |
| #*:<!-- credit for the method of putting multi-line <pre> code inside a list: https://stackoverflow.com/a/8390173 --><pre> | | |
| #*::{{Equipment page
| | <pre> |
| #*::| toolname =
| | {{Equipment page |
| #*::| model =
| | | toolname = |
| #*::| serial =
| | | model = |
| #*::| owner =
| | | serial = |
| #*::| loanstatus =
| | | owner = |
| #*::| arrived =
| | | loanstatus = |
| #*::| location =
| | | arrived = |
| #*::| status =
| | | location = |
| #*::| permission =
| | | status = |
| #*::| certification =
| | | permission = |
| #*::| photo =
| | | certification = |
| #*::| caption =
| | | photo = |
| #*::| id =
| | | caption = |
| #*::}}</pre>
| | | id = |
| #* If editing in visual mode, choose "Template" from the "Insert" menu at the top of the editor. A popup window will appear. Start typing "equipment page" in the field and click it once it's suggested.
| | }} |
| # Fill in the template. '''Leave <code>photo</code>, <code>caption</code>, and <code>id</code> blank for now.''' With the other fields, enter a question mark or leave it blank if you don't know that information. <code>toolname</code> is not supposed to be in the same format as the page title (what you decided on in step 1); instead, it should be more of a natural-sounding but still detailed name, such as "Tormach PCNC 1100 CNC mill" or "red 12" hacksaw". For help with the other fields, see the descriptions at [[Template:Equipment page]].
| | |
| #* If editing in source mode, add the appropriate information on each line, after the equals sign. (If you copied and pasted from above, there should already be a space after each equals sign. Spaces are optional on both sides, but they improve code readability.
| | ==Specs== |
| #* If editing in visual mode: The template isn't set up for convenient visual editing yet, so you'll have to manually enter the full name of each field you want to use in the "Field name" search box and click it as an unknown field below that, then fill it in above. When you're done, click the blue "Insert" button at the top right of the popup window.
| | TBD |
| # Add any other information you want to below the template. It's commonly useful to include sections for specifications, usage instructions, repair tips, etc. (Reminder: the code for a section heading is <code>==Section title==</code>, with more equals signs for further levels.) If you don't have this information now, it can of course be added later.
| | |
| # Add all appropriate tool categories. If you forget any of these, don't worry, because you can come back and fix it later, or someone else can. The current tool categories can be found listed in the "Subcategories" section of [[:Category:Tools]]—blue triangles there are clickable to expand subcategories. You can also add categories that don't exist, and they'll appear at [[Special:WantedCategories]] so we know they're wanted.
| | ==Usage== |
| #* In source editing, this is done by simply adding links to the categories (e.g., <code><nowiki>[[Category:Showcase tools]]</nowiki></code>), usually at the very bottom of the page's code. They won't appear as links once you save the page. When previewing, they'll appear at the very bottom, below the editor even if you have the preview set to appear above the editor. | | TBD |
| #* In visual editing, there is a category tool accessible from the hamburger menu at the top right, just to the left of the editing mode menu.
| | |
| # Preview and save the page:
| | ==Troubleshooting== |
| #* If editing in source mode:
| | TBD |
| #*# Click the "Show preview" button at the bottom of the editor to check that the page appears correctly. You should see an infobox on the right side of the preview, with the info you entered. If not, try to fix it so you do. If you don't, proceed anyway, and somebody else will probably fix it soon.
| | |
| #*# Click the blue "Save page" button at the bottom of the editor to publish your addition.
| | ==Documentation== |
| #* If editing in visual mode:
| | TBD |
| #*# The editor itself serves as the preview. Look at what appears after closing any popup windows. You should see an infobox on the right side of the preview, with the info you entered. If not, try to fix it so you do. If you don't, proceed anyway, and somebody else will probably fix it soon.
| | </pre> |
| #*# Click the blue "Save page" button at the top-right of the editor to publish your addition.
| | |
| # Assign a wiki-ID number to the tool according to [[0#I want to assign a wiki-ID number to a tool or other item|the instructions for that]].
| | * Fill in the template. '''Leave <code>photo</code>, <code>caption</code>, and <code>id</code> blank for now.''' With the other fields, enter a question mark or leave it blank if you don't know that information. <code>toolname</code> is not supposed to be in the same format as the page title (what you decided on in step 1); instead, it should be more of a natural-sounding but still detailed name, such as "Tormach PCNC 1100 CNC mill" or "red 12" hacksaw". For help with the other fields, see the descriptions at [[Template:Equipment page]]. |
| # [[Special:Upload|Upload a photo]] with the wiki-ID number as the filename, such as <code>512.jpg</code>.
| | * Add the appropriate information on each line, after the equals sign. |
| # Edit the tool page you created to add the photo. Copy and paste the filename into the <code>photo</code> field of the equipment page template: <code><nowiki>| photo = 512.jpg</nowiki></code>.
| | * Add any other information you want to below the template. (Reminder: the code for a section heading is <code>==Section title==</code>, with more equals signs for further levels.) If you don't have this information now, it can of course be added later. |
| # Preview and save the page again, preferably with an edit summary saying you added a photo.
| | * (Optional) Add all appropriate tool categories. The current tool categories can be found listed in the "Subcategories" section of [[:Category:Tools]]. Add links to the categories (e.g., <code><nowiki>[[Category:Showcase tools]]</nowiki></code>), at the very bottom of the page's code. They won't appear as links once you save the page. |
| # Go to the [[tools we have]] gallery, find the appropriate section, and click the edit button on that section so you can insert an entry. Find the appropriate place in the section according to where the name you chose in step 1 fits in alphabetical order.
| | * Click the "Show preview" button at the bottom of the editor to check that the page appears correctly. You should see an infobox on the right side of the preview, with the info you entered. If not, try to fix it so you do. If you don't, proceed anyway, and somebody else will probably fix it soon. |
| #* If editing in source mode, copy and paste the following code:
| | * Click the blue "Save page" button at the bottom of the editor to publish your addition. |
| #*: <pre>File: FILENAME |link= TOOLDESCRIPTION |[[ TOOLDESCRIPTION]]</pre> | | * Assign a wiki-ID number to the tool according to [[0#I want to assign a wiki-ID number to a tool or other item|the instructions for that]]. |
| #* 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.
| | * [[Special:Upload|Upload a photo]] with the wiki-ID number as the filename, such as <code>512.jpg</code>. |
| # Fill in the info:
| | * Edit the tool page you created to add the photo. Copy and paste the filename into the <code>photo</code> field of the equipment page template: <code><nowiki>| photo = 512.jpg</nowiki></code>. |
| #* If editing in source mode, edit the line with <code>FILENAME</code> after the name of the image you uploaded, such as <code>File:512.jpg</code> or <code>File:Red hacksaw.jpg</code>, and replace the words "TOOLDECRIPTION" with the page you wish to link. Example: replace <code>link=TOOLDESCRIPTION</code> with <code>link=Hacksaw, 12", red ID:512</code> and <code><nowiki>[[TOOLDESCRIPTION]]</nowiki></code> with <code><nowiki>[[Hacksaw, 12", red ID:512]]</nowiki></code>. Be careful to not delete the pipes (<code>|</code>), and make sure there are no spaces between the second pipe and the beginning of the link code (<code><nowiki>[[</nowiki></code>). It should look like this: <pre>File:512.jpg|link=Hacksaw, 12", red ID:512 |[[Hacksaw, 12", red ID:512]]</pre>
| | * Preview and save the page again, preferably with an edit summary saying you added a photo. |
| #* 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. Editing visually, you can't set the <code>link=</code> parameter; somebody else might do that, or you can add it yourself by editing again in source mode.
| | * Go to the [[tools we have]] gallery, find the appropriate section, and click the edit button on that section so you can insert an entry. Find the appropriate place in the section according to where the name you chose in step 1 fits in alphabetical order. |
| # 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, copy and paste the following code: |
| # Click the "Save changes".
| | **: <pre>File:FILENAME |link=TOOLDESCRIPTION |[[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, edit the line with <code>FILENAME</code> after the name of the image you uploaded, such as <code>File:512.jpg</code> or <code>File:Red hacksaw. jpg</code>, and replace the words "TOOLDECRIPTION" with the page you wish to link. Example: replace <code> link=TOOLDESCRIPTION</code> with <code>link=Hacksaw, 12", red ID:512</code> and <code>< nowiki> [[TOOLDESCRIPTION]]< /nowiki></ code> with <code> <nowiki>[[ Hacksaw, 12", red ID:512]] </nowiki></code>. Be careful to not delete the pipes (<code>|</code>), and make sure there are no spaces between the second pipe and the beginning of the link code (<code><nowiki>[[</nowiki></code>). It should look like this: <pre>File: 512.jpg|link= Hacksaw, 12", red ID:512 |[[ Hacksaw, 12", red ID:512]]</pre> |
| | ** 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. Editing visually, you can't set the <code>link=</code> parameter; somebody else might do that, or you can add it yourself by editing again in source mode. |
| | * 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". |
|
| |
|
| ==Assigning a wiki-ID to a tool that doesn't have one== | | ==Assigning a wiki-ID to a tool that doesn't have one== |