docs/site/search/search_index.json
2024-04-26 18:45:10 +01:00

1 line
21 KiB
JSON

{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome Use this micro-site to find help, tips and guidance to get the best out of OwlBoard. What is OwlBoard OwlBoard is a web-app which provides you with access to: Live Station Departure boards Up-to date timetable information PIS Codes for GWR and HEx services Network Rail Location code lookups Delay/Cancellation reason code descriptions The app is targeted to railway staff and some features will only be available after registering with a railway email address.","title":"Welcome"},{"location":"#welcome","text":"Use this micro-site to find help, tips and guidance to get the best out of OwlBoard.","title":"Welcome"},{"location":"#what-is-owlboard","text":"OwlBoard is a web-app which provides you with access to: Live Station Departure boards Up-to date timetable information PIS Codes for GWR and HEx services Network Rail Location code lookups Delay/Cancellation reason code descriptions The app is targeted to railway staff and some features will only be available after registering with a railway email address.","title":"What is OwlBoard"},{"location":"api-intro/","text":"OwlBoard API OwlBoard is powered by an API. The API is currently undocumented, a link to the documentation will be provided when it is ready.","title":"OwlBoard API"},{"location":"api-intro/#owlboard-api","text":"OwlBoard is powered by an API. The API is currently undocumented, a link to the documentation will be provided when it is ready.","title":"OwlBoard API"},{"location":"code-lookup/","text":"Code Lookup The Code Lookup page lets you enter a known code and see the matching codes. You can enter a CRS, TIPLOC, STANOX or NLC to lookup. CRS/3ALPHA - Three character code identifying a station. BRI - Bristol Temple Meads EXD - Exeter St. Davids TIPLOC 4-7 character code identifying a timing point. BATHSPA - Bath Spa ELYY - Ely WARM301 - Warminster Signal 301 STANOX 5 character code identifying a location NLC 6 character code identifying a location or accounting location 197800 - Windermere 354400 - Weymouth G OTS","title":"Code Lookup"},{"location":"code-lookup/#code-lookup","text":"The Code Lookup page lets you enter a known code and see the matching codes. You can enter a CRS, TIPLOC, STANOX or NLC to lookup. CRS/3ALPHA - Three character code identifying a station. BRI - Bristol Temple Meads EXD - Exeter St. Davids TIPLOC 4-7 character code identifying a timing point. BATHSPA - Bath Spa ELYY - Ely WARM301 - Warminster Signal 301 STANOX 5 character code identifying a location NLC 6 character code identifying a location or accounting location 197800 - Windermere 354400 - Weymouth G OTS","title":"Code Lookup"},{"location":"components/","text":"OwlBoard Components OwlBoard is powered by several programs. Web The OwlBoard website is powered by Svelte. The speed is improved by installing components into your browser to reduce the amount of data that flows between the server and your device. It has been designed to work well over very weak connections. API Server The OwlBoard API Server is powered by ExpressJS. The responses are kept as small as possible to improve performance over weak connections. The API Server is what provides data to the OwlBoard website. Timetable Manager timetable-mgr is the newest addition to the OwlBoard suite. Replacing db-manager. timetable-mgr fetches timetable data from Network Rail daily, and also listens for VSTP messages which adds VSTP planned trains into the local timetable. It is written in Go for fast performance. Diagram Parser dg-parser reads diagrams and extracts headcodes and PIS codes before referencing the timetable to find which service the PIS code is valid for. These PIS codes are then semi-automatically added to OwlBoard.","title":"OwlBoard Components"},{"location":"components/#owlboard-components","text":"OwlBoard is powered by several programs.","title":"OwlBoard Components"},{"location":"components/#web","text":"The OwlBoard website is powered by Svelte. The speed is improved by installing components into your browser to reduce the amount of data that flows between the server and your device. It has been designed to work well over very weak connections.","title":"Web"},{"location":"components/#api-server","text":"The OwlBoard API Server is powered by ExpressJS. The responses are kept as small as possible to improve performance over weak connections. The API Server is what provides data to the OwlBoard website.","title":"API Server"},{"location":"components/#timetable-manager","text":"timetable-mgr is the newest addition to the OwlBoard suite. Replacing db-manager. timetable-mgr fetches timetable data from Network Rail daily, and also listens for VSTP messages which adds VSTP planned trains into the local timetable. It is written in Go for fast performance.","title":"Timetable Manager"},{"location":"components/#diagram-parser","text":"dg-parser reads diagrams and extracts headcodes and PIS codes before referencing the timetable to find which service the PIS code is valid for. These PIS codes are then semi-automatically added to OwlBoard.","title":"Diagram Parser"},{"location":"departures/","text":"Departure Boards Departure boards are accessed from the homepage by entering a CRS code or TIPLOC in to the textbox. If you are registered, you will see a Staff Departure Board, otherwise you'll see a Public Departure Board. Staff Departure Board Staff live departure boards show as much information as is available in an easy-ish to read format. Travel alerts are displayed at the top, tap the orange bar to expand the alerts. Tap again to close the alerts. Train length is not always available so may be missing for some services. Cancelled trains are shown crossed out. Delay or Cancellation reasons are shown underneath the service they apply to. Non-passenger services are shown faded. Non-public platform numbers are shown faded. Train Details Tap on any train to see further details. Public Departure Board The public departure board shows less information. Alerts are still shown, and you can click on a service to see more detail.","title":"Departure Boards"},{"location":"departures/#departure-boards","text":"Departure boards are accessed from the homepage by entering a CRS code or TIPLOC in to the textbox. If you are registered, you will see a Staff Departure Board, otherwise you'll see a Public Departure Board.","title":"Departure Boards"},{"location":"departures/#staff-departure-board","text":"Staff live departure boards show as much information as is available in an easy-ish to read format. Travel alerts are displayed at the top, tap the orange bar to expand the alerts. Tap again to close the alerts. Train length is not always available so may be missing for some services. Cancelled trains are shown crossed out. Delay or Cancellation reasons are shown underneath the service they apply to. Non-passenger services are shown faded. Non-public platform numbers are shown faded.","title":"Staff Departure Board"},{"location":"departures/#train-details","text":"Tap on any train to see further details.","title":"Train Details"},{"location":"departures/#public-departure-board","text":"The public departure board shows less information. Alerts are still shown, and you can click on a service to see more detail.","title":"Public Departure Board"},{"location":"menu/","text":"Menu The menu is the gateway to additional features. Your Data Your Data shows you the data held about you, captured when you registered. A very limited amount of data is held about you: Registration Domain (eg. owlboard.info, example-toc.co.uk) Access Time (the last time you accessed OwlBoard) UUID (your unique password, stored in your browser) Registration See the registration guide for details. Settings See the settings guide for details. Help Provides pathways to get help, such as out Facebook group, issue reporting and this help site. About Gives some background information about OwlBoard. Location Reference Code Lookup See the code lookup guide for details. Reason Code Lookup Provides a way to look up a 'reason code'. A 'reason code' is a three digit code which maps to a reason for a delay or cancellation. Privacy Policy Links to the OwlBoard privacy policy. Component Versions Shows the version of the various pieces of software the provide the OwlBoard service. Statistics Shows statistics about the OwlBoard service: Last update of Timetable, PIS, Reason and location code data Request counts (how many times data has been requested) Database lengths (how many individual items are stored)","title":"Menu"},{"location":"menu/#menu","text":"The menu is the gateway to additional features.","title":"Menu"},{"location":"menu/#your-data","text":"Your Data shows you the data held about you, captured when you registered. A very limited amount of data is held about you: Registration Domain (eg. owlboard.info, example-toc.co.uk) Access Time (the last time you accessed OwlBoard) UUID (your unique password, stored in your browser)","title":"Your Data"},{"location":"menu/#registration","text":"See the registration guide for details.","title":"Registration"},{"location":"menu/#settings","text":"See the settings guide for details.","title":"Settings"},{"location":"menu/#help","text":"Provides pathways to get help, such as out Facebook group, issue reporting and this help site.","title":"Help"},{"location":"menu/#about","text":"Gives some background information about OwlBoard.","title":"About"},{"location":"menu/#location-reference-code-lookup","text":"See the code lookup guide for details.","title":"Location Reference Code Lookup"},{"location":"menu/#reason-code-lookup","text":"Provides a way to look up a 'reason code'. A 'reason code' is a three digit code which maps to a reason for a delay or cancellation.","title":"Reason Code Lookup"},{"location":"menu/#privacy-policy","text":"Links to the OwlBoard privacy policy.","title":"Privacy Policy"},{"location":"menu/#component-versions","text":"Shows the version of the various pieces of software the provide the OwlBoard service.","title":"Component Versions"},{"location":"menu/#statistics","text":"Shows statistics about the OwlBoard service: Last update of Timetable, PIS, Reason and location code data Request counts (how many times data has been requested) Database lengths (how many individual items are stored)","title":"Statistics"},{"location":"pages/","text":"Pages Homepage The OwlBoard homepage gives you fast access to Departure Boards and Timetable searches. You also have a Quick Links section which you can configure your own shortcuts for stations and headcodes. Check the settings guide for further details. PIS Finder More details in the PIS guide The PIS Finder page gives you an easy way to search for PIS codes based on the CRS code of the origin and destination station. This finder can only return exact matches. Check the PIS guide for more details and help finding partial matches. Menu More details in the Menu guide","title":"Pages"},{"location":"pages/#pages","text":"","title":"Pages"},{"location":"pages/#homepage","text":"The OwlBoard homepage gives you fast access to Departure Boards and Timetable searches. You also have a Quick Links section which you can configure your own shortcuts for stations and headcodes. Check the settings guide for further details.","title":"Homepage"},{"location":"pages/#pis-finder","text":"More details in the PIS guide The PIS Finder page gives you an easy way to search for PIS codes based on the CRS code of the origin and destination station. This finder can only return exact matches. Check the PIS guide for more details and help finding partial matches.","title":"PIS Finder"},{"location":"pages/#menu","text":"More details in the Menu guide","title":"Menu"},{"location":"pis/","text":"PIS PIS code lookup is supported for GWR and HEx services There are two ways for you to find PIS codes; using the timetable search on the homepage, and using the PIS Finder page. Timetable Search By typing a headcode into the timetable search, you are more likely to find a match. Partial matches are returned through the timetable search - where you need to skip stops the number of stops to skip will be specified. To find out how to use the timetable search, see the timetable guide . PIS Finder As an alternative to the Timetable Search, you can use the PIS Finder. Here, you simply enter the CRS code of the start and end station to see matches. All PIS codes that match the start and end locations are returned: You can check the results to find a code that contains the stops you need. Some routes contain a large number of codes which may make finding a suitable code difficult. It is recommended that you use the timetable search instead.","title":"PIS"},{"location":"pis/#pis","text":"PIS code lookup is supported for GWR and HEx services There are two ways for you to find PIS codes; using the timetable search on the homepage, and using the PIS Finder page.","title":"PIS"},{"location":"pis/#timetable-search","text":"By typing a headcode into the timetable search, you are more likely to find a match. Partial matches are returned through the timetable search - where you need to skip stops the number of stops to skip will be specified. To find out how to use the timetable search, see the timetable guide .","title":"Timetable Search"},{"location":"pis/#pis-finder","text":"As an alternative to the Timetable Search, you can use the PIS Finder. Here, you simply enter the CRS code of the start and end station to see matches. All PIS codes that match the start and end locations are returned: You can check the results to find a code that contains the stops you need. Some routes contain a large number of codes which may make finding a suitable code difficult. It is recommended that you use the timetable search instead.","title":"PIS Finder"},{"location":"registering/","text":"Registering for OwlBoard Certain features are exclusively accessible to users who register with a railway email address. We accept email addresses from a wide range of railway companies, including operators, maintenance firms, and infrastructure providers. If your email address is not accepted during registration, you will receive a notification. Should you believe that your email address should qualify, please don't hesitate to contact us. Why register? Registering gives you access to the following features: Live Station Departure Boards: Up to the next 40 services Up to the next 2 hours Shunts and ECS movements Non-public platform numbers Detailed train information PIS Code Lookup: Lookup by start and end station Lookup by headcode Timetable Lookup: Find trains by headcode Detailed timetable information PIS code information per-train Without registering, you still have access to departure boards but with much less detail and with ECS movements and non-public platform numbers hidden. Registration Detail Registering will generate a password, you won't need to enter it though because it is stored in your browser. You will remain logged in unless you clear your browsing data or change browsers. If you do not use OwlBoard for 90 days, your registration will be cleared from the server and you will need to register again. Registration codes expire after 30 minutes, if you try to enter your registration code after it has expired, your registration will fail and you'll need to register again. Registration Guide Open the menu from the bottom bar . Then click on the Registration link to open the registration page. Click on Registration, then enter a work email address. You'll also need to agree to the very short privacy policy. Once you click submit, an email will be sent containing your registration code. Open your emails, remember to check your Spam/Junk folder. It should only take a moment for the email to arrive, but allow 30 minutes before re-registering. The email will contain your registration code. The email also contains a link to the code-entry page. You can alternatively go back to the page where you entered your email and click to enter your code there. After entering your code, you should see a success message . If you see an error message, you may have entered your code incorrectly or it may have expired. You can try to enter the code again or follow this guide again to request a new code.","title":"Registering for OwlBoard"},{"location":"registering/#registering-for-owlboard","text":"Certain features are exclusively accessible to users who register with a railway email address. We accept email addresses from a wide range of railway companies, including operators, maintenance firms, and infrastructure providers. If your email address is not accepted during registration, you will receive a notification. Should you believe that your email address should qualify, please don't hesitate to contact us.","title":"Registering for OwlBoard"},{"location":"registering/#why-register","text":"Registering gives you access to the following features: Live Station Departure Boards: Up to the next 40 services Up to the next 2 hours Shunts and ECS movements Non-public platform numbers Detailed train information PIS Code Lookup: Lookup by start and end station Lookup by headcode Timetable Lookup: Find trains by headcode Detailed timetable information PIS code information per-train Without registering, you still have access to departure boards but with much less detail and with ECS movements and non-public platform numbers hidden.","title":"Why register?"},{"location":"registering/#registration-detail","text":"Registering will generate a password, you won't need to enter it though because it is stored in your browser. You will remain logged in unless you clear your browsing data or change browsers. If you do not use OwlBoard for 90 days, your registration will be cleared from the server and you will need to register again. Registration codes expire after 30 minutes, if you try to enter your registration code after it has expired, your registration will fail and you'll need to register again.","title":"Registration Detail"},{"location":"registering/#registration-guide","text":"Open the menu from the bottom bar . Then click on the Registration link to open the registration page. Click on Registration, then enter a work email address. You'll also need to agree to the very short privacy policy. Once you click submit, an email will be sent containing your registration code. Open your emails, remember to check your Spam/Junk folder. It should only take a moment for the email to arrive, but allow 30 minutes before re-registering. The email will contain your registration code. The email also contains a link to the code-entry page. You can alternatively go back to the page where you entered your email and click to enter your code there. After entering your code, you should see a success message . If you see an error message, you may have entered your code incorrectly or it may have expired. You can try to enter the code again or follow this guide again to request a new code.","title":"Registration Guide"},{"location":"settings/","text":"Settings The settings page lets you set up your personal Quick Links. Each quick link can be either a CRS code or a headcode and will be shown on the homepage. Set them to the stations and trains that you frequently lookup to give you quicker access to the data. A CRS code is the three character code which identifies a station. You can find then used on National Rail Enquiries, ticket machines and many apps used in the industry.","title":"Settings"},{"location":"settings/#settings","text":"The settings page lets you set up your personal Quick Links. Each quick link can be either a CRS code or a headcode and will be shown on the homepage. Set them to the stations and trains that you frequently lookup to give you quicker access to the data. A CRS code is the three character code which identifies a station. You can find then used on National Rail Enquiries, ticket machines and many apps used in the industry.","title":"Settings"},{"location":"timetable/","text":"Timetable Search The timetable search is found on the homepage. About Timetable search shows all timetabled services, including passenger, ECS and freight services. Short notice 'VSTP' services are also shown although these are often missing detail - including only the details needed to run the service. Results Enter the headcode that you'd like to search for. All trains with that headcode running today will be shown: Detail Tap on one of the services to see the service detail: All of the details shown are from the timetable. Changes to platform numbers and delays are not shown here. PIS Codes are only supported for GWR and HEx services at this time.","title":"Timetable Search"},{"location":"timetable/#timetable-search","text":"The timetable search is found on the homepage.","title":"Timetable Search"},{"location":"timetable/#about","text":"Timetable search shows all timetabled services, including passenger, ECS and freight services. Short notice 'VSTP' services are also shown although these are often missing detail - including only the details needed to run the service.","title":"About"},{"location":"timetable/#results","text":"Enter the headcode that you'd like to search for. All trains with that headcode running today will be shown:","title":"Results"},{"location":"timetable/#detail","text":"Tap on one of the services to see the service detail: All of the details shown are from the timetable. Changes to platform numbers and delays are not shown here. PIS Codes are only supported for GWR and HEx services at this time.","title":"Detail"}]}