You are here: Wiki > start > editors > manualtemplate

Table of Contents

User Manual Template
General Notes
Namespace Convention
Template Proposal- ‘Long Page’
Simulation Name
Official Files
Introduction
Start-Up Options
Scenarios
Eras
Other Options
Features
Feature 1
Feature 2
Panel Notes
Panel 1
Panel 2
Timetable Notes
Timetable 1
Timetable 1
Level Crossings
Multiplayer & Chaining
Hot Keys
Acknowledgments
Reference Section
Signal Number Plan
Signal Box Prefix Codes
Platform, Loop & Siding Lengths
Timetabling Details
Splash Screens
Additional Information
External Resources
ARS / Route Data
Version History
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Template Proposal- ‘Contents Style’
Simulation Name
Official Files
Contents
‘Contents Style’ Sub-page template
Simulation Name
Page Title

User Manual Template

The following is a template for user manuals; a forum thread has been opened for comments. Please do not make edits to this page.

Two templates are provided: One for the ‘Long Style’, where all of the main information is on one page, and ‘Contents Style’, where all pages are accessed from a contents page. The former is suitable for smaller simulations, the latter for large simulations.

A sample manual formatted to this template is available here: Sandhills

General Notes

Please try to avoid imitating the formal and technical style of a set of Signal Box Special Instructions. The user manual should be accessible to users who only understand the basic principles of signalling. Similarly, only features that are simulated should be referenced in the main manual. If you want to include more detailed real-life notes, put them in the reference section.

When using acronyms, or technical terms, include a link to the relevant glossary or other explanation page when they’re first used.

The simulation manual should only contain information relating to the simulation and supported timetables (for the avoidance of doubt, supported timetables are installed via the Loader).

Namespace Convention

All simulation manuals go in the ‘Simulations’ name space. The page name of the main page/contents page is the simulation name. Where sub-pages are used, the following convention should be used: “simulations:aston:reference”.

Template Proposal- ‘Long Page’

Simulation Name

Dedication

To be used only where the simulation is dedicated to a person’s memory, or similar- general acknowledgements and credits have their own section

Official Files

Title Version Released
Simulation (Payware) 1.0 24/01/2018
15/10/2009 WTT (Midnight and 0445 Start included) 1.0 24/01/2018
08/04/2015 WTT (Midnight, 0400 & 1400 starts included) 1.0 24/01/2018

Current versions only shown; old versions listed in Version History

Additional user-written timetables are available to download here Link to simulation's TT download page .

Introduction

An overview of the location and its traffic. A brief history of the box, traffic types, and other general information can be provided. Keep to two or three paragraphs; extended background information should go in the reference section.

Start-Up Options

Scenarios

Scenario 1

Scenario 2

A brief description of start-up scenarios

Eras

Era 1

Era 2

A description of the eras available, if appropriate.

Other Options

Option 1:

Option 2:

Description of other options available, sim-by-sim basis.

Features

Feature 1

Feature 2

Details of any simulation-wide features (e.g. ARS, ACI, Electrification, Absolute Block, Western Region interfaces etc.) should be given here. Overviews can be given here, with location-specific notes for a given feature appearing in the panel notes below. Long lists of ARS/Route data in reference section. Level crossings are listed in their own section further down.

Panel Notes

Notes relating to each panel. This includes Ground Frames, Phone Calls, unusual operating features, general regulation notes, and any other operating comments. Notes about timetable locations can be included, if relevant to simulation operation (for instance, detailing which lines a particular location refers to). If only one panel is provided, this section is combined with previous section, and named 'Operating Notes'. Can also be named ‘Box Notes’ or ‘Workstation Notes’ if appropriate.

Panel 1

Panel 2

Timetable Notes

Timetable 1

Timetable 1

Notes relating to the supplied timetables. May be given own sub-pages if extensive information is provided.

Level Crossings

Name Type Panel Located Between Number
Crossing Name CCTV/AHB etc. Panel Name

List crossings, ordered alphabetically by Name (so a user can easily find a crossing from a phone call). ‘Panel’ should match the style used in ‘Panel Notes’. ‘Located between’ column can be added if panels are large. ‘Number’ column can be added if crossings have a unique number in the simulation. Specific operating notes related to a particular crossing go in the appropriate Panel Notes section.

Multiplayer & Chaining

Comment on playability in single/multiplayer

The simulation chains at the following locations:

Simulation Location

List released simulations that this simulation can chain to, alphabetically by simulation name. Acknowledge any chains that are not possible where the adjacent simulation exists due to era/version differences.

If desired, add the following:

Provision exists for the simulation to chain at other fringes, should the corresponding simulation be developed in the future.

Hot Keys

In addition to the standard shortcut keys , the following are available:

Key Panel Area

List any simulation-specific hot keys, and provide a link to the main hot keys page, which defines global hotkeys.

Acknowledgments

Simulation by:

15/10/2009 WTT by:

08/04/2015 WTT by:

Any further credits as desired.

Reference Section

Signal Number Plan

Signal Box Prefix Codes

Code Box

Order alphabetically by code

Platform, Loop & Siding Lengths

Platform Lengths

If a platform has different lengths in different directions, use an extra row. Create a separate table, which may be in a bespoke format, for exceptionally complex stations (e.g. New St)
Location Platform Length (m)

Loop Lengths

Location Loop Name Length (m)

Order alphabetically by location

Siding Lengths

Location Loop Name Length (m)

If desired

Timetabling Details

If required. Notes for timetable writers; may be given own page

Special Decisions

If provided, details of special decisions are given here.

TIPLOC Codes

TIPLOC Codes

Splash Screens

Details of splash screens

Additional Information

Any extra 'real life' information, which is not relevant to simulation operation- for example, details of real-life operating features which are not simulated.

External Resources

If desired. Links to videos, photo albums etc.

ARS/Route Data

Route Notes

If applicable/desired. Long lists of ARS/Route data goes here, in own sub-page. Specific operating notes in earlier sections.

Version History

Version History

Version History and changelog; give own sub-page.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Template Proposal- ‘Contents Style’

Simulation Name

Dedication

To be used only where the simulation is dedicated a person’s memory, or similar- general acknowledgements and credits have their own section

Official Files

Title Version Released
Simulation (Payware) 1.0 24/01/2018
15/10/2009 WTT (Midnight and 0445 Start included) 1.0 24/01/2018
08/04/2015 WTT (Midnight, 0400 & 1400 starts included) 1.0 24/01/2018

Additional user-written timetables are available to download here Link to simulation's TT download page .

Contents

- Introduction

- Start Up Options

- Features

- Panel Notes

-Panel 1

-Panel 2

-Etc.

-Timetable Notes

-Level Crossings

-Multiplay & Chaining

-Hot Keys

-Acknowledgments

-Platform, Loop & Siding Lengths

-Reference Section

Each item is a link to a sub page, with the exception of ‘Panel Notes’.

‘Contents Style’ Sub-page template

Simulation Name

Page Title

Subsequent sections are given L4 headings, structured in the same way as the ‘Long page’ template given above.

Do not put Previous/Next links at the bottom of sub-pages. A link to back to the contents should be included.

Within the reference section, further sub-pages may be used for large items (e.g. ARS/ Route data should always have its own sub-page).


Last edited by Edgemaster on 05/04/2019 at 18:52