Skip to content
This repository has been archived by the owner on Jul 28, 2023. It is now read-only.

Latest commit

 

History

History
148 lines (92 loc) · 4.91 KB

settings.md

File metadata and controls

148 lines (92 loc) · 4.91 KB
Raw

Geotrek-rando documentation

‹ Back to README

Settings & customization

All files you could create or edit have to be put in custom/ directory at the main root of the project. Any other location will be deleted or override by the build or upgrade processes.

The build process will also create empty files if they don't already exists.

Settings

There are two files in Geotrek-rando managing client side settings:

settings.custom.json

This file should remain a valid JSON file. Remember to check its validity each time you alter it.

In directory src/app/config/ there is a file named settings.default.json that contains the default setup. Each option of it can be copied to another one: settings.custom.json located in custom/ directory.

Both files are always loaded by the app, but every rules from the second one will override those from first one.

See JSON settings for more details about each available options.

_configuration.scss

This file should remain a valid SCSS file. Remember to check its validity each time you alter it.

In directory src/app/config/styles is _configuration.default.scss that should never be modify. But any setting you want to change should be added to _configuration.scss located in custom/.

Caution: Default options use a !default switch for each parameter. You should not copy this switch when adding your own options to _configuration.scss file.

See SCSS settings for more details about each available options.

Customization

Beyond settings, you also have ways to customize look & feel but also create new behaviors.

Templates

By creating HTML files in custom/public and enabling there use in settings, you have the possibility to use your own markup for some elements of the interface. For example :

  • custom-header.html
  • custom-home.html

The filename does not really matter as far as custom/templates will be used as root directory.

See templates settings for a complete list of templates you can configure.

See templates widgets for a partial list of widgets you can use in your templates.

Styles

The file named custom/_customisation.scss allows you to write as many SCSS as you need.

If you want to split your styles in multiple files, you have to use the SCSS @import 'filename' rule to include other .scss files.

See SCSS settings for more details and tips.

Behaviors

Having your own behavior available for your templates is possible through three files:

  • controller.js
  • directive.js
  • service.js

Those files have also to be in custom/ directory. You may follow the src/app/custom/*.example to use the right structure.

Images, fonts and others things

Everything from the public/ directory is directy served by the web server. But you sould not put anything directly there. Also, public/custom is a symbolic link pointing directy to custom/public.

So all elements that you want to be accessible through http should be placed in the custom/public/ directory and would be accessed with the path: /custom/.

For example: custom/public/my_picture.png would be accessed by the link http://my-geotrek-domain.com/custom/my_picture.png.

You should use absolute links for these files rather than relative ones (particulary if you activate HTML5 mode). Example: <img src="/custom/my_picture.jpg">

Translations

You can override default translation files available in src/app/translation/po. Don't edit these default files, use them to find which messages you want to override.

Create a custom/po/ folder. Then create the files for each language you are using (en.po, fr.po as an example).

Override the translations that you want in these files.

Example of content for custom/po/en.po:

msgid ""
msgstr ""
"Project: Geotrek-rando\n"
"Project-Id-Version: \n"
"POT-Creation-Date: \n"
"PO-Revision-Date: \n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Language: en\n"
"X-Generator: Poedit 1.7.4\n"

msgid "BANNER_TEXT"
msgstr "Rando in my park"

msgid "DEFAULT_META_TITLE"
msgstr "Rando my park"

msgid "DEFAULT_META_DESCRIPTION"
msgstr "Discover the treks in the national park!"

GPDR compliance

Two sections are involved in GPDR Compliance: Google analytics and report form.

Warning form

Only email is required to submit reports, and a disclaimer should be displayed for users sending a report.

This text can be changed by overriding REPORT_GPDR_DISCLAIMER in translations (see Translations section).