|
This wiki is closed in favour of the new wiki. Information shown is likely to be very out of date. |
Difference between revisions of "Code generator guide"
From Discovery Wiki
Jump to navigationJump to searchm (Added a link to the code generator in the introduction.) |
m (Added a large link, rewrote the last point of each checklist a bit.) |
||
| Line 1: | Line 1: | ||
| − | [[User:cshake|cshake's]] | + | <center>'''[[dgc:/wikigen/index.php|Link to the code generator]]'''</center> |
| + | [[User:cshake|cshake's]] [[dgc:/wikigen/index.php|Wiki code generator]] is one of the most helpful tools that Wiki editors have for keeping ship, commodity and equipment pages up to date, but it is unfortunately not quite automatic as the output code requires a bit of manual editing, proofreading and verification before it can be added to the Wiki. To help you through this process, there are a few checklists and usage instructions below for each of the most common types below, but the most important guideline of all is to hit the preview button and compare the page you are editing with another page of the same type: If they look about the same, you should be good to go to hit the "Save page" button. | ||
| + | |||
| + | Another important tip is the "Show changes" button, which can help you if you're unsure about what you are changing or removing on a page after importing generated code from the code generator. | ||
=Code generator checklists= | =Code generator checklists= | ||
==ID pages== | ==ID pages== | ||
| Line 7: | Line 10: | ||
#Click “Show preview”. Does the page look like it should? Compare it with [[:Category:ID|another ID page]]. | #Click “Show preview”. Does the page look like it should? Compare it with [[:Category:ID|another ID page]]. | ||
##There should for example be no dashes after each bullet point on lists on the ID page. | ##There should for example be no dashes after each bullet point on lists on the ID page. | ||
| − | #If everything’s looking good by now, click | + | #If everything’s looking good by now, add a short summary stating that you have updated the page, and click "Save page". |
==Ship pages== | ==Ship pages== | ||
| + | [[image:RemovedReview.png|right|thumb|200px|A preview of what it looks like when you're about to remove a review. The highlighted red code should be copied into the new page to avoid losing the review.]] | ||
#Find the ship page that you wish to update on the Wiki. | #Find the ship page that you wish to update on the Wiki. | ||
#Find the entry for that page in the code generator, and copy the generated Wiki code into the editor. Make sure that you replace all code that is there from before. | #Find the entry for that page in the code generator, and copy the generated Wiki code into the editor. Make sure that you replace all code that is there from before. | ||
| Line 15: | Line 19: | ||
#Click “Show preview”. Does the page look like it should? Compare it with [[:Category:Ships|another ship page]]. | #Click “Show preview”. Does the page look like it should? Compare it with [[:Category:Ships|another ship page]]. | ||
##Does the ship image show up like it should? If not, check what the image name was in the previous revision of the page <nowiki>("| image = filename</nowiki>" inside the [[Template:Ship Infobox|<nowiki>{{Ship Infobox}}</nowiki> template]], again on the left hand side of the view you get after clicking “Show changes”) and copy it over. | ##Does the ship image show up like it should? If not, check what the image name was in the previous revision of the page <nowiki>("| image = filename</nowiki>" inside the [[Template:Ship Infobox|<nowiki>{{Ship Infobox}}</nowiki> template]], again on the left hand side of the view you get after clicking “Show changes”) and copy it over. | ||
| − | #If everything’s looking good by now, click | + | #If everything’s looking good by now, add a short summary stating that you have updated the page, and click "Save page". |
#Done! | #Done! | ||
==Commodity pages== | ==Commodity pages== | ||
| Line 22: | Line 26: | ||
#Add <nowiki>[[wikilinks]]</nowiki> where appropriate, such as for factions and base names. | #Add <nowiki>[[wikilinks]]</nowiki> where appropriate, such as for factions and base names. | ||
#Click “Show preview”. Does the page look like it should? Compare it with [[:Category:Commodities|another commodity page]]. | #Click “Show preview”. Does the page look like it should? Compare it with [[:Category:Commodities|another commodity page]]. | ||
| − | #If everything’s looking good by now, click | + | #If everything’s looking good by now, add a short summary stating that you have updated the page, and click "Save page". |
#Done! | #Done! | ||
==Equipment pages== | ==Equipment pages== | ||
| Line 30: | Line 34: | ||
#Click “Show preview”. Does the page look like it should? Compare it with [[:Category:Guns|another equipment page]]. | #Click “Show preview”. Does the page look like it should? Compare it with [[:Category:Guns|another equipment page]]. | ||
##Does the equipment image show up like it should? If not, check what the image name was in the previous revision of the page <nowiki>("| image = filename</nowiki>" inside the [[Template:Weapon|<nowiki>{{Weapon/gun}}</nowiki> template]], again on the left hand side of the view you get after clicking “Show changes”) and copy it over. | ##Does the equipment image show up like it should? If not, check what the image name was in the previous revision of the page <nowiki>("| image = filename</nowiki>" inside the [[Template:Weapon|<nowiki>{{Weapon/gun}}</nowiki> template]], again on the left hand side of the view you get after clicking “Show changes”) and copy it over. | ||
| − | #If everything’s looking good by now, click | + | #If everything’s looking good by now, add a short summary stating that you have updated the page, and click "Save page". |
#Done! | #Done! | ||
Revision as of 14:30, 19 February 2015
cshake's Wiki code generator is one of the most helpful tools that Wiki editors have for keeping ship, commodity and equipment pages up to date, but it is unfortunately not quite automatic as the output code requires a bit of manual editing, proofreading and verification before it can be added to the Wiki. To help you through this process, there are a few checklists and usage instructions below for each of the most common types below, but the most important guideline of all is to hit the preview button and compare the page you are editing with another page of the same type: If they look about the same, you should be good to go to hit the "Save page" button.
Another important tip is the "Show changes" button, which can help you if you're unsure about what you are changing or removing on a page after importing generated code from the code generator.
Code generator checklists
ID pages
- Find the ID page that you wish to update on the Wiki.
- Find the entry for that page in the code generator, and copy the generated Wiki code into the editor. Make sure that you replace all code that is there from before.
- Add [[wikilinks]] where appropriate, such as for factions and ship names.
- Click “Show preview”. Does the page look like it should? Compare it with another ID page.
- There should for example be no dashes after each bullet point on lists on the ID page.
- If everything’s looking good by now, add a short summary stating that you have updated the page, and click "Save page".
Ship pages
- Find the ship page that you wish to update on the Wiki.
- Find the entry for that page in the code generator, and copy the generated Wiki code into the editor. Make sure that you replace all code that is there from before.
- Click the “show changes” button, and look for any red text with a minus sign in front of it on the left hand side to see if you’ve removed any reviews. If so, copy these over to the editor window under the ==Handling== title.
- Add [[wikilinks]] where appropriate, such as for factions and base names.
- Click “Show preview”. Does the page look like it should? Compare it with another ship page.
- Does the ship image show up like it should? If not, check what the image name was in the previous revision of the page ("| image = filename" inside the {{Ship Infobox}} template, again on the left hand side of the view you get after clicking “Show changes”) and copy it over.
- If everything’s looking good by now, add a short summary stating that you have updated the page, and click "Save page".
- Done!
Commodity pages
- Find the commodity page that you wish to update on the Wiki.
- Find the entry for that page in the code generator, and copy the generated Wiki code into the editor. Make sure that you replace all code that is there from before.
- Add [[wikilinks]] where appropriate, such as for factions and base names.
- Click “Show preview”. Does the page look like it should? Compare it with another commodity page.
- If everything’s looking good by now, add a short summary stating that you have updated the page, and click "Save page".
- Done!
Equipment pages
- Find the equipment page that you wish to update on the Wiki.
- Find the entry for that page in the code generator, and copy the generated Wiki code into the editor. Make sure that you replace all code that is there from before.
- Add [[wikilinks]] where appropriate, such as for factions and ship names.
- Click “Show preview”. Does the page look like it should? Compare it with another equipment page.
- Does the equipment image show up like it should? If not, check what the image name was in the previous revision of the page ("| image = filename" inside the {{Weapon/gun}} template, again on the left hand side of the view you get after clicking “Show changes”) and copy it over.
- If everything’s looking good by now, add a short summary stating that you have updated the page, and click "Save page".
- Done!
