Difference between revisions of "Forks:Wiki Standards"

From LinuxWorks Minetest Server Wiki
Jump to navigation Jump to search
(Coordinates: if I misidentified a problem, it's what the priority of *that* sentence was)
(these are mostly guidelines and not requirements)
Line 1: Line 1:
 +
'''Unless specified otherwise''', these are guidelines and not requirements, although some of them are pretty important for basic quality.
 +
 
== Language ==
 
== Language ==
 
This wiki primarily uses English. It is yet to be decided if this means Australian, British, American or some mix of them. As a general rule, please do not spam the wiki by correcting spelling such as ''-ize''/''-ise'', ''-or''/''-our'', ''-er''/''-re'', etc.
 
This wiki primarily uses English. It is yet to be decided if this means Australian, British, American or some mix of them. As a general rule, please do not spam the wiki by correcting spelling such as ''-ize''/''-ise'', ''-or''/''-our'', ''-er''/''-re'', etc.
Line 40: Line 42:
 
'''For safety, do not give coordinates of tracks for stations (i.e. do not use coordinates on trains). This may result in player deaths.''' Remember, the coordinates are often used for teleportation. Don't give coordinates on overpasses as teleporting to these usually drops you through them and onto the track. If you teleport to a station and it places you somewhere inappropriate, please fix the coordinates.
 
'''For safety, do not give coordinates of tracks for stations (i.e. do not use coordinates on trains). This may result in player deaths.''' Remember, the coordinates are often used for teleportation. Don't give coordinates on overpasses as teleporting to these usually drops you through them and onto the track. If you teleport to a station and it places you somewhere inappropriate, please fix the coordinates.
  
It's better to take your time to document railway stations properly, rather than rushing to get coordinates for everything. For railway stations, try to give coordinates that are aligned to increments of 5 in the x and y directions. It is acceptable to give coordinates anywhere inside the station, though it is preferred to give coordinates on the platform. Giving the coordinates to a station entrance is also equally valid.
+
Take your time to document railway stations properly, rather than rushing to get coordinates for everything. For railway stations, try to give coordinates that are aligned to increments of 5 in the x and y directions. It is acceptable to give coordinates anywhere inside the station, though it is preferred to give coordinates on the platform. Giving the coordinates to a station entrance is also equally valid.
  
 
Always round your coordinates up in the y direction, even for stations below 0. Do not give coordinates with .5 increments in them.
 
Always round your coordinates up in the y direction, even for stations below 0. Do not give coordinates with .5 increments in them.

Revision as of 21:12, 9 October 2019

Unless specified otherwise, these are guidelines and not requirements, although some of them are pretty important for basic quality.

Language

This wiki primarily uses English. It is yet to be decided if this means Australian, British, American or some mix of them. As a general rule, please do not spam the wiki by correcting spelling such as -ize/-ise, -or/-our, -er/-re, etc.

Terms to :

Non-preferred term Preferred term Notes
Railroad Railway Applies to the state railways. Private rail can use the American term if they want.
  • Railway

Vector drawings

High quality drawings made in Inkscape are welcome. These include maps. Please upload them in both .SVG and .PNG formats.

The SVG is used for other users wanting to edit the image with Inkscape (other vector drawing programs are available). Currently it is acceptable to upload Inkscape .SVGs but if needed for interchange we will move to accepting only standard SVGs.

The PNG is used in all other places on the wiki, since MediaWiki uses a very poor ImageMagick renderer to create previews of the SVG files. Render your picture directly from Inkscape to ensure it is accurately rendered on the wiki.

Taking screenshots

To reiterate what you should already know from the server rules: Do not post screenshots that contain chat. F2 will hide chat.

Try to take screenshots at as high a resolution as you reasonably can, up to 1920x1080 for most screenshots. We know that many players do not have hardware that supports such high resolutions: that is fine, just take them in as high a resolution as you can.

Your graphics drivers may have support for virtual super resolution, allowing you to take screenshots in 4K without actually having a 4K display. This vastly reduces jagged edges in the image without anti-aliasing, and reduces Moiré patterns in heavily repeated textures. Uploading in 4K is overkill for most screenshots: if you take a screenshot at that resolution please scale it down and save it as JPEG so it does not take too much room. Remember the wiki has an 8MB file size limit.

Remember to turn all of your GUI elements off in screenshots. The bindings are:

  • F1 to hide HUD
  • F2 to hide chat
  • Optional: F3 to hide Fog. Looks better in some instances.
  • F5 to hide debug menu with coordinates. You can record the coordinates elsewhere if they are relevant.

Recommended graphics settings:

  • No texture packs. We want to present a standard view of the world
  • 4x or 8x anti-aliasing really helps smooth out the jaggies. So does 4K
  • Mipmapping, unless the screenshot
  • No post-processing effects. They do not add anything to the screenshot.

Coordinates

For safety, do not give coordinates of tracks for stations (i.e. do not use coordinates on trains). This may result in player deaths. Remember, the coordinates are often used for teleportation. Don't give coordinates on overpasses as teleporting to these usually drops you through them and onto the track. If you teleport to a station and it places you somewhere inappropriate, please fix the coordinates.

Take your time to document railway stations properly, rather than rushing to get coordinates for everything. For railway stations, try to give coordinates that are aligned to increments of 5 in the x and y directions. It is acceptable to give coordinates anywhere inside the station, though it is preferred to give coordinates on the platform. Giving the coordinates to a station entrance is also equally valid.

Always round your coordinates up in the y direction, even for stations below 0. Do not give coordinates with .5 increments in them.

Always use the {{Co|x|y|z}} template for coordinates. In the future, this will mean a bot can scrape the wiki for places where it is used and draw markers on a map, or other useful tasks.

Railway Stations

  • The following station naming scheme is proposed as follows:
  • Name[, Place][, (System)] [station|Station]
  • Place{-| }Name [station|Station]

Examples (from Wikipedia) include:

  • Use Template:s-line and Template:s-rail to show railway services from a station. It is preferred to put the west or northern terminus on the left and the east or south terminus on the right for a particular line.

Routemaps

This wiki contains route maps of both and. You should give all geographic features like tunnels, bridges and viaducts on the line pages, but you only need to give stations on the services pages. You can include the geographic features if you want though.

Use the following colours for route maps:

Use station icons in the following way, which may differ slightly from wikipedia:

  • HST (Haltestelle, German for stop) for stops with nothing notable near them.
  • BHF (Bahnhof, German for station) for notable stops.
  • INT (Interchange) for stops where you can switch between lines and systems. If there are many shared stops in a row, mark the stop where the common section starts and the stop where it ends, but not the ones in between. See: Spawn Subway Line 3 where Laza's City is not marked interchange.