This Example Comm-Link article is to designed to help with adding new Comm-Link pages to the wiki for the Comm-Link archive project. This guide is created with source editor in mind. Follow the instructions below.
Usage Instructions
Create a new article, switch to the Source tab in the article editor, and then copy and paste the following. Update each line, as appropriate.
{{Infobox commlink
|title =
|image = Comm-Link-XXXXX.jpg (Must be uploaded separately. Have been using "Comm-Link-" + short indicator of comm-link name + file type.)
|url = https://robertsspaceindustries.com/comm-link/xxxx
|type = (One of Spectrum Dispatch|Citizens|Communications|Engineering)
|series = (ex - Time Capsule)
|publicationdate = YYYY-MM-DD
}}
- Copy and paste the Comm-Link's text to the editor.
- The text should be formatted by the editor automatically, check the preview and reformat if needed.
- Please do add wiki links to important terms & people in there first appearance on that page, and in any prominent lists.
Rules
Naming Conventions
- Prepend
Comm-Link:to place in the specially set up Comm-Link: namespace. - Convert any
:in the rest of the name to- - Remove other special characters
][{}
Dates
- Standard Date format for this wiki is YYYY-MM-DD (HH:MM:SS)
- Keep any dates in quoted Comm-Link text in whatever format used in that context. Don't change.
- In-Lore dates are the same as real life date + 930 years unless otherwise noted.
- Comm-Link Publication dates for the infobox are real life dates, which can be found at the top of the original Comm-Link on the RSI Site.
Featured image
We need a featured image for our Comm-Link Infobox. We should be using the main image at the top of each comm-link.
Take the image from the first ever comm-link. It has the url of:
https://robertsspaceindustries.com/media/puvp3i50x7n2qr/post_section_header/NewsScreen.jpg
That can be uploaded with a name as noted above: "'Comm-Link-' + short indicator of comm-link name + file type"
Some series share the same image and we don't need to re-upload each time.
Note: Did previously have instructions on changing the image to post. But the post section header seems to be working quite well.
Embedded images
Embedded images are best done as thumbnails, which end up a bit smaller than on the RSI website, but that makes them more mobile friendly anyway.
Upload as above. Note file name.
Code for embed is one of the below (with optional caption at the end):
[[File:Strife-Mass-Driver-V2.jpg|thumb|right|Strife Mass Driver]] [[File:Strife-Mass-Driver-V2.jpg|thumb|center|Strife Mass Driver]] [[File:Strife-Mass-Driver-V2.jpg|thumb|left|Strife Mass Driver]] [[File:Strife-Mass-Driver-V2.jpg|thumb|none|Strife Mass Driver]] (Center no flow.)
Avoid using center and none unless it does not affect the layout of the page. Sometimes using center and none will cause the text to drop below the infobox. If you are using center or none, please double check the layout with different browser window sizes.
Editorial notes
Need to use the Template:Note, and have this key information:
- The bolded preamble to make it clear it's not in the original comm-link Wiki Staff Editorial Note:
- Assertion or note to be made.
- An RSI or other link to support the assertion made.
Example (from Comm-Link: Galactic Guide - Davien):
{{Note|'''Wiki Staff Editorial Note:''' As of 2016-10-11 there is no known jump point between Davien and Croshaw in the {{Link RSI|url=starmap?location=DAVIEN|text=Ark Starmap}}}}
Errata
CIG occasionally updates the contents of a previous Comm-Link with a newer Comm-Link. It's good practice for us to show those updates inline on the original Comm-Link.
For this we again need to use the Template:Note, and have this key information:
- The bolded preamble to make it clear it's not in the original comm-link, like: Errata:
- Correction to be made.
- An RSI or other link to support the correction made.
Example (from Comm-Link:Writer's Guide - Part Two):
{{Note|'''Errata:''' Rank list was updated after this [[Comm-Link]], see [[UEE Navy]]}}
Archived
The following maybe useful for manipulating images on the the RSI Website:
What we need to do is take the "post_section_header" and change it to "post" and pull the result from the RSI website:
https://robertsspaceindustries.com/media/puvp3i50x7n2qr/post/NewsScreen.jpg
That can be uploaded with a name as noted above: "'Comm-Link-' + short indicator of comm-link name + file type"
Incidentally, if you substitute "source" instead of post from the RSI url above, you'll get the highest resolution uncropped image available for whatever RSI image you are working with. Now you know how people get those high-res images out of the Category:Monthly Reports