Protospace Wiki

Protospace Wiki:Adding new tools

Revision as of 18:38, 20 January 2023 by Tanner.collin (talk | contribs) (→‎Adding a tool page)

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.

Adding a tool page

It's easiest to create the tool page in "source mode", then come back after and edit it in "visual mode".

Procedure:

  • Decide on a name for the wiki to refer to the tool by. Try to follow the format: [tool type], [distinguishing characteristics separated by commas] ([make/model]). 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:
    • 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)
  • 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.
  • Make sure "Create source" is selected at the top. You can come back later and edit in visual mode.
  • Paste this into the text box:
{{Equipment page
| toolname = 
| model = 
| serial = 
| owner = 
| loanstatus = 
| arrived = 
| location = 
| status = 
| permission = 
| certification = 
| photo = 
| caption = 
| id = 
}}

==Specs==
TBD

==Usage==
TBD

==Troubleshooting==
TBD

==Documentation==
TBD
  • Fill in the template. Leave photo, caption, and id blank for now. With the other fields, enter a question mark or leave it blank if you don't know that information. toolname 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.
  • Add the appropriate information on each line, after the equals sign.
  • (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., [[Category:Showcase tools]]), at the very bottom of the page's code.
  • 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.
  • Assign a wiki-ID number to the tool according to the instructions for that.
  • Upload a photo with the wiki-ID number as the filename, such as 512.jpg.
  • Edit the tool page you created to add the photo. Copy and paste the filename into the photo field of the equipment page template: | photo = 512.jpg.
  • Preview and save the page again, preferably with an edit summary saying you added a photo.

All done! Now that the tool page is created, feel free to edit in visual mode by pressing "Edit" instead of "Edit source".

(Optional) Adding your tool to the gallery

  • 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, copy and paste the following code: 
      File:FILENAME        |link=TOOLDESCRIPTION            |[[TOOLDESCRIPTION]]
    • 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 FILENAME after the name of the image you uploaded, such as File:512.jpg or File:Red hacksaw.jpg, and replace the words "TOOLDECRIPTION" with the page you wish to link. Example: replace link=TOOLDESCRIPTION with link=Hacksaw, 12", red ID:512 and [[TOOLDESCRIPTION]] with [[Hacksaw, 12", red ID:512]]. Be careful to not delete the pipes (|), and make sure there are no spaces between the second pipe and the beginning of the link code ([[). It should look like this: 
      File:512.jpg|link=Hacksaw, 12", red ID:512 |[[Hacksaw, 12", red ID:512]]
    • 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 link= 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".
Retrieved from "https://wiki.protospace.ca/index.php?title=Protospace_Wiki:Adding_new_tools&oldid=6325"