From 918f97d3eb863bc17d0fc3d1910b629834ff7eb2 Mon Sep 17 00:00:00 2001 From: Brian Ferris Date: Wed, 9 May 2012 22:47:43 +0200 Subject: [PATCH] Issue #8: Improve Deployment Documentation Update documentation for sign mode. --- src/site/markdown/features/sign-mode.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/src/site/markdown/features/sign-mode.md b/src/site/markdown/features/sign-mode.md index f917d561f..929536288 100644 --- a/src/site/markdown/features/sign-mode.md +++ b/src/site/markdown/features/sign-mode.md @@ -5,4 +5,22 @@ quick and cheap information displays. -Photo by Atomic Taco. \ No newline at end of file +Photo by Atomic Taco. + +To use sign-mode, use the [standard web interface](web.html) to browse to your favorite stop. The URL for the page +should have form like: + +http://your.host-name.com/where/standard/stop.action?id=X_Y + +To enable sign mode, simply replace the `standard` part of the URL with `sign`: + +http://your.host-name.com/where/sign/stop.action?id=X_Y + +There are a number of parameters you can add to the URL to tweak the behavior of the sign: + +* `title=...` - By default, the sign uses the current stop name as a title. This option allows you to override the title. +* `showTitle=false` - Alternatively, you can hide the title completely. +* `route=X_Y` - Specify a route id to indicate that only this route should be show. Can be repeated. +* `minutesBefore=N` - Excludes vehicles that departed more than N minutes ago. +* `minutesAfter=N` - Exclude vehicles arriving more than N minutes from now. +* `refresh=N` - Automatically refresh the page every N seconds. \ No newline at end of file