Improved www.ttss.krakow.pl
5c6b3b4a97440adecc120ce05262cecca2576e36..7cbf517e62f86a06fea73e87b1346323c82febea
2017-03-17 Jacek Kowalski
Add usage information to the README
7cbf51 diff | tree
2017-03-17 Jacek Kowalski
Add installation documentation
59549b diff | tree
1 files modified
1 files added
80 ■■■■■ changed files
INSTALL.md 17 ●●●●● patch | view | raw | blame | history
README.md 63 ●●●●● patch | view | raw | blame | history
INSTALL.md
New file
@@ -0,0 +1,17 @@
# Installation
## Requirements
Webserver with PHP 5.4+ (PHP 7+ recommended) and modules:
- iconv,
- PDO,
- PDO SQLite.
## Procedure
Just clone the repository into the top-level website directory:
```sh
cd /var/www
git clone https://git.jacekk.net/r/projects/mpk-ttss
```
README.md
@@ -5,11 +5,72 @@
Check https://mpk.jacekk.net/ for a live version.
Contact and suggestions: mpk_AT_jacekk.info
## Differences
* Displays traffic alerts.
* Presents tram delays.
* Lists lines passing through selected stop.
* Improved autocompletion.
## Usage
### Changing language
You can change the interface language using the dropdown near "TTSS Kraków" header.
Currently only Polish (PL) and English (EN) translations are available.
### Selecting the stop
Enter first letter of a stop name into the input field labeled as "Stop name".
Suggestions will be displayed in the dropdown located to the right.
Each name component is matched separately (case-insensitive), so:
- "ba" matches "Teatr Bagatela",
- "d g" matches "Dworzec Główny", "Dworzec Główny Tunel" and "Dworzec Główny Zachód",
- "aleja" matches "M1 Al. Pokoju" and "TAURON Arena Kraków Al. Pokoju",
- "święt" matches "Plac Wszystkich Świętych", "Św.Gertrudy" and "Św.Wawrzyńca".
When the selected suggestion in the dropdown matches the desired stop,
click the "Go" button or (alternatively) press the ENTER key.
### Display
After selecting the stop, the following information are visible:
- Line - line number,
- Direction - final stop on the line,
- Time - predicted/scheduled departure time,
- Delay - calculated delay from the schedule.
Relative times (eg. 3 min) are real-time arrivals based on tram location data.
Absolute times (eg. 8:01) are scheduled departures, shown when the tram cannot be located.
To the left of the time is an icon representing the tram type:
♿ - low-floor tram,
*♿ - partially low-floor tram,
‐ - high-floor tram.
Hover over an icon to show the tooltip with tram identifier and vehicle type.
Rows have different background depending on the tram status:
- green - at the stop,
- white - en-route,
- yellow - delayed 4 or more minutes,
- red - delayed 10 or more minutes.
### Auto-refresh
The list is automatically updated every 20 seconds. It is possible to manually
reload the data using the "Refresh" button.
When an error occurs, automatic update is disabled and manual refresh is required.
This event is indicated by the red message box just over the stop name.
### Bookmarks
Changing the language or selecting a stop causes the address to change.
You may bookmark the address to avoid entering the data each time.
## License