GRFSpecs:Todo

From GRFSpecs
Revision as of 15:37, 15 June 2011 by Planetmaker (talk | contribs) (→‎Main List: real sprites)
Jump to navigationJump to search

To-Do List

Currently the main task is to fix all conversion errors from the change of wikis. Have a look at the "oldest pages" list. Anything dating to 12 June has not been reviewed.

Many terms are used inconsistently. Although it is not a big priority to fix them right now, add an entry or edit existing ones at TermConsistency if you spot any inconsistencies regarding term names.

This page contains a list of 'jobs' that remain to be completed, please follow the example listing when adding/editing information in the table.

  • Item - internal link to a page.
  • Task - What needs to be done.
  • Status - Available (no one working on it), In Progress (someone working on it, include name in parentheses ()), Complete (item has been finished)
  • Date Added - DD/MM/YYYY format
  • Last Updated - DD/MM/YYYY format

Main List

Item Task Status Date Added Last Updated
Example Item Example Task Available 13/06/2011 13/06/2011
VarAction2Cities Rename to VarAction2 Towns Done 14/06/2011 15/06/2011
TownZones Explanation of town zones. Links to all appropiate places. Available 14/06/2011 14/06/2011
Storages Explanation of persistent and temporary storages. See TermConsistency. Done 14/06/2011 14/06/2011
VarAction2IndustryTiles Right now, VarAction2AirportTiles just links to VarAction2IndustryTiles. This is okay (we should not duplicate information), but that page has almost no explanation about being also for airport tiles. Available 14/06/2011 14/06/2011
VarAction2NewSignals This page does not follow the same format than the other VarAction2 pages, and it seems to include information about callbacks. Variables are not named. Available 14/06/2011 14/06/2011
VarAction2 Towns There are variables only mentioned in the table and not in description. Available 14/06/2011 14/06/2011
Page to be created Description of the 00-3f, 40-5f, 60-7f, 80-ff VarAction2Advanced variable ranges. Comment about why most 80-FF variables are not documented. Also mention the relation between VarAction2 and Action6/7/9/D variables. Done 14/06/2011 15/06/2011
SpriteLayouts Move the general explanation (without syntax) for spritelayouts, sprite&recolour flags and bounding boxes for Stations and Houses/Industries/Airports/Objects to a separate page. Also incorporate examples for typical configurations for stations with track and normal buildings (e.g. | this general advice). Available 14/06/2011 14/06/2011
RealSprites Add further explanations and recommendations about sprite compressions. Done 14/06/2011 15/06/2011

We should come up with a list of usable categories for the pages, thus that some overview / content pages can be auto-generated Suggestions:

  • VarAction2
  • Action0 (Action0Trains, Action0RoadVehicles, ...)
  • Actions (Action 0, Action 1, ...)
  • Default values (like vehicle IDs, tile IDs, cargo labels...)

Should page names change to be "better" and more wiki-like: VarAction2Houses -> VarAction2 Houses etc? According to http://meta.wikimedia.org/wiki/Pywikipediabot/movepages.py it seems that it would not be a massive amount of work.

Examples to be Written

Examples should be short, well commented and clearly show how to use the featured item. See VarAction2Objects#Examples

Examples Needed For Status Date Added Last Updated
Action0 Available 14/06/2011 14/06/2011
Action0Airports Available 14/06/2011 14/06/2011
Action0Canals Available 14/06/2011 14/06/2011
Action0Cargos Available 14/06/2011 14/06/2011
Action0Planes Available 14/06/2011 14/06/2011
Action0Railtypes Available 14/06/2011 14/06/2011
Action0RoadVehicles Available 14/06/2011 14/06/2011
Action0Ships Available 14/06/2011 14/06/2011
Action2 Available 14/06/2011 14/06/2011
Action2Vehicles Available 14/06/2011 14/06/2011
Action4 Available 14/06/2011 14/06/2011
ActionD Available 14/06/2011 14/06/2011
VarAction2Stations Available 14/06/2011 14/06/2011