Skip to content

Commit

Permalink
Add pages
Browse files Browse the repository at this point in the history
  • Loading branch information
aguiraf committed Dec 3, 2024
1 parent c5f3ad7 commit 9c88f5d
Show file tree
Hide file tree
Showing 139 changed files with 3,397 additions and 28 deletions.
1,844 changes: 1,844 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

61 changes: 57 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,61 @@
title: Just the Docs Template
description: A starter template for a Jeykll site using the Just the Docs theme!
title: Documentazione Transit Café
description: Portale di documentazione del Transit Café
theme: just-the-docs

url: https://just-the-docs.github.io
url: https://5tsrl.github.io/cafe-docs/

defaults:
- scope:
path: "pages" # an empty string here means all files in the project
type: "pages"
values:
layout: "default"



aux_links_new_tab: true
aux_links:
Template Repository: https://github.com/just-the-docs/just-the-docs-template
Cafe Repository: https://github.com/5Tsrl/cafe-ui

# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/cafe150.png"

# Set a path/url to a favicon that will be displayed by the browser
favicon_ico: "/assets/favicon.ico"

nav_enabled: true


# Footer content
# appears at the bottom of every page's main content
# Note: The footer_content option is deprecated and will be removed in a future major release. Please use `_includes/footer_custom.html` for more robust markup / liquid-based content.
footer_content: "Copyright &copy; <a href=\"https://www.5t.torino.it\">5T srl</a>"

# Footer last edited timestamp
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html

# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/5Tsrl/cafe-docs" # the github URL for your repo
gh_edit_branch: "main" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

callouts_level: quiet # or loud
callouts:
highlight:
color: yellow
important:
title: Important
color: blue
new:
title: New
color: green
note:
title: Note
color: purple
warning:
title: Warning
color: red
Binary file added assets/cafe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/cafe150.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/favicon.ico
Binary file not shown.
Binary file added img/actions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/add-fare-zone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/add-snapshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/add-stop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/agency-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/agency-mandatory-fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/auth0-token-generator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/available-snapshots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/available-versions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/blocked-feed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/calendar-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/calendar-legend.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/create-feed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/create-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/create-user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/create-version-feed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/create-version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/delete-node.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/download-calendar-string.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/edit-calendars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/edit-fare-rules.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/edit-fares.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/edit-frequencies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/edit-pattern-geometry.png
Binary file added img/edit-patterns.png
Binary file added img/edit-routes.png
Binary file added img/edit-stops.png
Binary file added img/edit-timetables.png
Binary file added img/editor-from-scratch.png
Binary file added img/export-gtfs.png
Binary file added img/export-shp.png
Binary file added img/feed-info.png
Binary file added img/feed-overview.png
Binary file added img/feed-profile.png
Binary file added img/feed-settings.png
Binary file added img/feed-version-navigator.png
Binary file added img/graph-manager.png
Binary file added img/lines-manager.png
Binary file added img/load-version-editor.png
Binary file added img/load-version.png
Binary file added img/make-snapshot.png
Binary file added img/manager-read-only.png
Binary file added img/normalize-stop-time.png
Binary file added img/overview-data-validation.png
Binary file added img/overview-data.png
Binary file added img/overview-editor.png
Binary file added img/overview-manager.png
Binary file added img/overview-progr-km.png
Binary file added img/overview-project.png
Binary file added img/overview-tool.png
Binary file added img/password-reset-logged-in.png
Binary file added img/password-reset-logged-out.png
Binary file added img/pattern-add-stop.png
Binary file added img/pattern-insert-stop.png
Binary file added img/pattern-manager.png
Binary file added img/pattern-popup.png
Binary file added img/pattern-shape-panel.png
Binary file added img/pattern-stop-order.png
Binary file added img/pattern-stop-remove.png
Binary file added img/pattern-stop-toolbar.png
Binary file added img/pattern-toolbar.png
Binary file added img/pattern-version-confirm.png
Binary file added img/project-feed-list.png
Binary file added img/project-profile.png
Binary file added img/project-vs-feed.PNG
Binary file added img/public-portal.png
Binary file added img/quick-access-toolbar-feed-source.png
Binary file added img/quick-access-toolbar.png
Binary file added img/read-only.png
Binary file added img/report-corse-pdf.png
Binary file added img/report-corse.png
Binary file added img/report-linee-pdf.png
Binary file added img/report-linee.png
Binary file added img/report-orari-pdf.png
Binary file added img/report-orari.png
Binary file added img/reports.png
Binary file added img/schedule-exception.png
Binary file added img/schedule-toolbar.png
Binary file added img/select-trips.png
Binary file added img/settings-osserva.png
Binary file added img/shape-shadow.png
Binary file added img/snapshot-line.png
Binary file added img/snapshot-toolbar.png
Binary file added img/stops-manager.png
Binary file added img/summary-feed.png
Binary file added img/timetable-selector.png
Binary file added img/timetables-manager.png
Binary file added img/trip-duplica.png
Binary file added img/trip-version.png
Binary file added img/upload-feed.png
Binary file added img/upload-shp.png
Binary file added img/upload-zip-shp.png
Binary file added img/user-admin-detail.png
Binary file added img/user-admin.png
Binary file added img/user-profile.png
Binary file added img/version-pattern.png
Binary file added img/version-trips.png
Binary file added img/version-union.png
Binary file added img/version-vs-snapshots-editor.png
Binary file added img/video-creazione-calendario.png
Binary file added img/video-creazione-linea.png
Binary file added img/video-creazione-percorso.png
Binary file added img/video-gestione-corse.png
Binary file added img/video-inserimento-corsa.png
Binary file added img/video-modifica-percorso.png
Binary file added img/video-snapshot-versioni.png
Binary file added img/video-versionamento-percorso.png
Binary file added img/view-all-stops.png
34 changes: 10 additions & 24 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,21 @@
---
title: Home
layout: home
nav_order: 1
description: "Transit Café è uno strumento web gestire feed GTFS."
permalink: /
---

This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
# Transit Café

If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
Transit Café è uno strumento web per creare, gestire, validare e pubblicare dati del trasporto pubblico, in particolare dati utilizzati nel PEA (Programma di Esercizio Aziendale) e nel formato GTFS (General Transit Feed Specification).

More specifically, the created site:
![screenshot](img/public-portal.png)

- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
Nelle pagine seguenti saranno illustrate le funzioni del Transit Café.
Per i dettagli si rimanda alla lista dei contenuti disponibili nella parte sinistra della pagina.

Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
Visita la [pagina di accesso a Transit Café](https://cafe.5t.torino.it) per entrare nella piattaforma.

[Browse our documentation][Just the Docs] to learn more about how to use this theme.

To get started with creating a site, simply:

1. click "[use this template]" to create a GitHub repository
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions

If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.

----

[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).

[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
[GitHub Pages]: https://docs.github.com/en/pages
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
[Jekyll]: https://jekyllrb.com
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
Per richieste di supporto nell'utilizzo dello strumento contattare [email protected].
54 changes: 54 additions & 0 deletions pages/appendici/appendix-cafe-summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Glossario dei termini
parent: Appendici
nav_order: 1
---

# 2- Glossario dei termini

Di seguito sono riportate alcune parole chiave per l'utilizzo di Transit Café.

##### Progetto:
- è una raccolta di feed e relativi versionamenti;
- può rappresentare una determinata area geografica e contenere tutti i contratti di servizio attivi nell'area;
- ha associata l'icona di una cartella.


##### Feed:
- può essere identificato con un contratto di esercizio del PEA;
- può contenere più versioni della stessa base dati,
- viene visualizzato nel modulo manager;
- è modificabile nel modulo editor.


##### Manager:

Il modulo Manager si occupa della gestione ed analisi dei feed e di tutte le informazioni ad essi correlate e contiene:
- navigatore di versioni e snapshot;
- periodo di validità del feed;
- informazioni su fermate, linee, percorsi, orari;
- reportistica.


##### Editor:

Il modulo Editor è lo strumento cartografico per la modifica dei dati e permette di:
- modificare, visualizzare e disegnare le linee ed i percorsi;
- modificare la geometria del percorso di una linea con un instradamento automatico o in modalità manuale;
- versionare il dato;
- gestire gli orari e i calendari/frequenze.


##### Snapshot:
- è una versione "di lavoro" di un set di dati;
- rappresenta un punto di salvataggio;
- può essere esportato o usato come punto di partenza per modifiche future;
- è associato al simbolo di una fotocamera;
- può essere modifica nel modulo editor.


##### Versione:
- rappresenta una variante contrattuale della base dati originale;
- può essere creata da uno snapshot;
- può essere analizzata con il modulo manager;
- può essere modifica nel modulo editor.
133 changes: 133 additions & 0 deletions pages/appendici/appendix-gtfs-warnings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
---
title: Glossario degli errori
parent: Appendici
nav_order: 1
---

# 1- Errori di validazione

Gli errori sono consultabili dagli utenti nella sezione dedicata nel manager. La correzione delle segnalazioni non può avvenire nel manager ma solo in fase di modifica del feed.

![img](/img/overview-data-validation.png)

Di seguito sono riportati alcuni degli errori più comuni:

##### Corse spurie nel percorso
Alcuni percorsi risultano avere al loro interno delle corse con km contrattuali diversi da quelli riportati nel percorso. Valutare se spostare tali corse in nuovi percorsi.

*Questo errore deve necessariamente essere corretto ai fini di una corretta gestione del feed.*

##### Codici corsa duplicati a livello di linea
Alcune linee risultano avere corse con codice corsa duplicato. È necessario che il codice corsa sia univoco all'interno di una linea.

*Questo errore deve necessariamente essere corretto ai fini di una corretta gestione del feed.*

##### Codici corsa duplicati a livello di percorso
Alcuni percorsi risultano avere corse con codice corsa duplicato. È necessario che il codice corsa sia univoco all'interno di un percorso della linea.

*Questo errore deve necessariamente essere corretto ai fini di una corretta gestione del feed.*

##### Calendari duplicati
Alcuni calendari risultano avere la stessa definizione di giorni di servizio. Sarebbe opportuno evitare la proliferazione dei calendari.

*È consigliabile evitare di creare calendari uguali tra loro. All'appendice 3 - Nomenclatura calendari si possono trovare maggiori informazioni sull'argomento*

##### Tempo di viaggio nullo
Il veicolo arriva alla fermata allo stesso orario in cui parte dalla precedente.

*Questo errore può essere trascurato in caso di fermate molto vicine, in cui varia solo la cifra relativa ai secondi.*

##### Tempo di viaggio negativo
Il veicolo arriva a questa fermata prima di partire dalla precedente.

*È consigliabile controllare la correttezza degli intertempi e degli orari di partenza e sosta in una fermata.*

##### Data senza servizio
Non vi sono service_id attivi per una data compresa nell'intervallo di date con un servizio definito.

*Questo errore può essere trascurato in caso vi siano giorni in cui non è attivo il servizio di trasporto.*

##### Fermata in area a bassa densità abitativa
Una fermata è posizionata in un'area geografica con una bassa densità di popolazione.

*Questo errore può essere trascurato in caso il posizionamento della fermata sia corretto.*

##### Tragitto troppo lento
Il veicolo sta viaggiando molto lentamente per raggiungere la fermata rispetto a quella precedente.

*Questo segnalazione è sintomo di una errata velocità commerciale rispetto a quanto ammissibile per il tipo di strada. È consigliabile controllare gli intertempi tra le fermate.*

##### Tragitto troppo rapido
Il veicolo sta viaggiando molto velocemente per raggiungere la fermata rispetto a quella precedente.

*Questo segnalazione è sintomo di una errata velocità commerciale rispetto a quanto ammissibile per il tipo di strada. È consigliabile controllare gli intertempi tra le fermate.*

##### Fermata non utilizzata
La fermata non è utilizzata da alcuna corsa.

*Questo errore è presente in ogni feed di Transit Café, in quanto sono presenti tutte le fermate regionali all'interno di ogni feed.*

##### Il nome breve della linea e il nome esteso sono vuoti
Una linea non ha il nome breve della linea o il nome esteso.

*Sia il nome breve che il nome esteso sono richiesti dalle specifiche GTFS.*

##### Il nome breve di una linea è troppo lungo
Il campo nome breve di una linea ha troppi caratteri.

*Il nome breve di una linea non dovrebbe contenere più di 3-4 caratteri, dato che le applicazioni che usano il GTFS potrebbero usare il nome breve in contesti in cui vi sono limiti di spazio per il testo (es. etichette su una mappa).*

##### Il nome esteso della linea contiene il nome breve
Lo nome breve di una linea è incluso nel nome esteso.

*Il nome esteso della linea non deve contenere il nome breve, dato che le applicazioni che usano il GTFS potrebbero combinare il nome esteso e quello breve per un nome combinato (es. una linea con nome breve “A” e nome esteso “Dora Express” può essere indicata come “A - Dora Express”).*

##### La descrizione della linea è uguale al nome della linea
La descrizione e il nome di una linea sono identici.

*La descrizione è un campo opzionale e dovrebbe essere incluso solo se fornisce informazioni aggiuntive oltre a ciò che è incluso nel nome della linea.*

##### Tipo mezzo che opera la linea non valido
Un tipo mezzo specificato non corrisponde a nessuno dei valori di tipo mezzo definiti da GTFS.

*I valori accettati per il campo in analisi sono definiti nelle specifiche del GTFS e attualmente includono 8 differenti modalità di trasporto (tram, metropolitana, treno, bus, traghetto, funivia, funicolare).*

##### Nessun orario per la corsa
Una corsa non contiene informazioni sui passaggi in fermata.

*Questo indica che le informazioni sugli orari per questa corsa non sono corrette.*

##### Orario partenza prima dell'arrivo
Una corsa inizia una fermata prima del suo termine.

*Questo indica che le informazioni sugli orari per questa corsa non sono corrette.*

##### Passaggio in fermata non in sequenza
Una corsa arriva prima di partire dalla fermata precedente.

*Questo indica che le informazioni sugli orari per questa corsa non sono corrette.*

##### Corsa duplicata
Due o più corse condividono la stessa sequenza di fermate e orari di partenza.

*Questo indica che ci possono essere corse duplicate.*

##### Corse sovrapposte nel block
Due o più corse con sovrapposizione di un block.

*Un block rappresenta una sequenza di corse operate da un singolo veicolo, e il block ID è un campo opzionale che indica a blocco appartiene il veicolo. Se la numerazione del block è usata nella registrazione della corsa, e due o più corse si sovrappongono nel tempo ma condividono un comune block ID, allora questo indica o la presenza di informazioni sbagliate sugli orari programmati o block ID non corretto .*

##### Fermate duplicate
Due fermate hanno la stessa posizione in un feed.

*Considera di unire le fermate che condividono la stessa posizione o usa la gerarchia stazione/fermata per specificare le posizioni di un gruppo di fermate.*

##### Tracciato geometrico della corsa al contrario
La direzione del tracciato geometrico della corsa non corrisponde a quella della sequenza di fermate.

*Invertire o correggere lo shape della corsa in modo da adattarsi all'ordine delle fermate di questa corsa.*

##### Geometria mancante
La corsa non ha un tracciato geometrico di riferimento.

*Gli shape sono opzionali ma raccomandati.*
61 changes: 61 additions & 0 deletions pages/appendici/appendix-naming-calendar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Nomenclatura calendari
parent: Appendici
nav_order: 1
---

# 3 - Nomenclatura calendari

Di seguito sono riportate alcune sigle utili per identificare un calendario. L'elenco riprende la nomenclatura adottata dal sistema Omnibus a livello regionale:

| Id calendario | Descrizione |
|---------------|-----------------------------------------------------------------------|
| 1 | Lunedì |
| 2 | Martedì |
| 3 | Mercoledì |
| 4 | Giovedì |
| 5 | Venerdì |
| PREF | Giorni prefestivi |
| SAB | Sabato |
| DOM | Domenica |
| SAB+PF | Sabato e prefestivi |
| E | Periodo estivo |
| I | Periodo invernale |
| A | Solo agosto |
| -A | Escluso agosto |
| -H | Escluso 2 settimane ad agosto |
| -F | Escluso 3 settimane ad agosto |
| -A4 | Escluso 4 settimane ad agosto |
| -S | Periodo non scolastico |
| FER2 | Feriale 2 gg. settimana |
| FER3 | Feriale 3 gg. settimana |
| FER4 | Feriale 4 gg. settimana |
| FER5 | Feriale escluso sabato |
| FER6 | Feriale compreso sabato |
| FER5-FN | Feriale escluso sabato escluso settimana di Ferragosto e Natale |
| GIOR | Giornaliera (feriali e festivi) |
| FER-SLV | Feriale esclusi giorni scolatici dal lunedì al venerdì |
| FEST | Festiva |
| FEST/B | Festiva dal 01/04 al 30/09 |
| FEST/B2 | Festiva dal 01/01 al 31/03 e dal 01/10 al 31/12 |
| FEST-3 | Festiva escluso Natale, Capodanno e 1° maggio |
| FEST-7 | Solo giorni festivi |
| FEST-N | Festiva escluso Natale |
| FEST-NC | Festiva escluso Natale e Capodanno |
| NAT | Solo giorno di Natale |
| SABFESTLA | Sabato e giorni festivi domenica compresa nei mesi di luglio e agosto |
| SCOL | Scolastica |
| SCOLG2 | Scolastica 2 gg. settimana |
| SCOLG3 | Scolastica 3 gg. settimana |
| SCOLG4 | Scolastica 4 gg. settimana |
| SCOLG5 | Scolastica 5 gg. settimana |

Le singole sigle possono essere combinate per dare origine a particolari calendari, ad esempio:

| Id calendario | Descrizione |
|---------------|-----------------------------------------------------------------------------------|
| FER5GGI | Feriale 5 gg. settimana periodo invernale |
| SCOL1 | Scolastica lunedì |
| FER5-A/B | Feriale escluso sabato e agosto a settimane alterne |
| FER5-A/C | Feriale escluso sabato e agosto a settimane alterne |
| FER6-SA/B2 | Feriale compreso sabato periodo non scolatico escluse 2° e 3° settimana di agosto |
Loading

0 comments on commit 9c88f5d

Please sign in to comment.