Commit 1f7dc110cae64fea7f36f14008b88eff08fdc980

Authored by Antoine Goutenoir
1 parent a4db6554
Exists in master

Provide sample files and add a help text below the train select.

content.yml
... ... @@ -5,7 +5,8 @@
5 5 # Metadata about this website
6 6 meta:
7 7 title: Travel Carbon Footprint Calculator
8   - description: A travel carbon footprint calculator for researchers.
  8 + description: |
  9 + A travel carbon footprint calculator for researchers and event organizers.
9 10 authors:
10 11 - name: Didier Barret
11 12 email: dbarret@irap.omp.eu
... ... @@ -458,16 +459,16 @@ home:
458 459 content: |
459 460 The inputs are provided in US English for the city and country
460 461 names, without diacritics. On each line, the city and country
461   - names must be separated by a comma. Pasting a csv file in the
  462 + names must be separated by a comma. Pasting a CSV file in the
462 463 form is possible, provided that a comma separates
463 464 the city and country names.
464 465  
465   - A round trip is defined by a city pair. If the user enters cityA as
466   - the origin city, and twice cityB as destinations, the tool returns
  466 + A round trip is defined by a city pair. If the user enters _cityA_ as
  467 + the origin city, and twice _cityB_ as destinations, the tool returns
467 468 the cumulative emission and distance from two round trips
468   - involving cityA and cityB, and indicates that 2 round trips were involved.
469   - The same happens if the user enters twice cityA as the city of origin
470   - and cityB as the sole destination.
  469 + involving _cityA_ and _cityB_, and indicates that 2 round trips were involved.
  470 + The same happens if the user enters twice _cityA_ as the city of origin
  471 + and _cityB_ as the sole destination.
471 472  
472 473 Three types of inputs can be considered
473 474 depending on whether the user wants an “individual” estimate
... ... @@ -629,6 +630,10 @@ estimate:
629 630 <br>
630 631 The spreadsheet's first sheet must have an <code>Address</code> column,
631 632 or a <code>City</code> and <code>Country</code> columns.
  633 + <br>
  634 + <a href="static/public/sample/sample_addresses.csv" target="_blank">Example CSV</a>
  635 + ⋅
  636 + <a href="static/public/sample/sample_addresses.xlsx" target="_blank">Example XLS</a>
632 637 destination_addresses: |
633 638 This is either the cities and countries to travel to
634 639 or the host city and country of the conference, meeting…
... ... @@ -640,6 +645,9 @@ estimate:
640 645 <br>
641 646 The spreadsheet's first sheet must have an <code>Address</code> column,
642 647 or a <code>City</code> and <code>Country</code> columns.
  648 + use_train_below_km: |
  649 + For <small>(single)</small> trips below this distance,
  650 + we'll ignore the plane models and use <code>23 g.km<sup>-1</sup></code>.
643 651  
644 652 # Labels accept HTML, but not markdown
645 653 # Descriptions accept neither, since we use the HTML title attribute
... ... @@ -664,6 +672,11 @@ estimate:
664 672 use_train_below_km:
665 673 label: Use train below
666 674 description: We will use train emission models instead of plane fo trips below this distance.
  675 +# values:
  676 +# - label: Do not consider train
  677 +# value: 0
  678 +# - label: 100 km (~ 1h)
  679 +# value: 100
667 680 origin_addresses:
668 681 label: Origin Cities
669 682 description: |
... ... @@ -686,13 +699,13 @@ estimate:
686 699 description: |
687 700 Accepted files: CSV, XLS, XLSX.
688 701 We will use the Address column, or the City and Country columns.
689   - error: Please use spreadsheet files only (CSV, XLS, XLSX)
  702 + error: Please only use spreadsheet files. (CSV, XLS, XLSX)
690 703 destination_addresses_file:
691 704 label: Destination Cities
692 705 description: |
693 706 Accepted files: CSV, XLS, XLSX.
694 707 We will use the Address column, or the City and Country columns.
695   - error: Please use spreadsheet files only (CSV, XLS, XLSX)
  708 + error: Please only use spreadsheet files. (CSV, XLS, XLSX)
696 709 # compute_optimal_destination:
697 710 # label: |
698 711 # Compute the destination city that will minimize emissions <br>
... ...
flaskr/static/public/sample/sample_addresses.csv 0 → 100644
... ... @@ -0,0 +1,5 @@
  1 +City,Country
  2 +Auroville,India
  3 +Adelaide,Australia
  4 +Toulouse,France
  5 +Barcelona,Spain
0 6 \ No newline at end of file
... ...
flaskr/static/public/sample/sample_addresses.xlsx 0 → 100644
No preview for this file type
flaskr/templates/estimate.html
... ... @@ -7,7 +7,7 @@
7 7 {% block hero %}
8 8 <div class="jumbotron">
9 9 <h1>{{ content.estimate.hero.title | safe }}</h1>
10   - <p>{{ content.estimate.hero.description | markdown | safe }}</p>
  10 + {{ content.estimate.hero.description | markdown | safe }}
11 11 </div>
12 12 {% endblock %}
13 13  
... ... @@ -160,9 +160,9 @@
160 160  
161 161 <div class="form-group">
162 162 {{ render_field(form.use_train_below_km) }}
163   -{# <small class="form-text text-muted">#}
164   -{# {{ content.estimate.help.use_train_below_km | safe }}#}
165   -{# </small>#}
  163 + <small class="form-text text-muted">
  164 + {{ content.estimate.help.use_train_below_km | safe }}
  165 + </small>
166 166 </div>
167 167  
168 168 <div class="form-group">
... ...