Skip to content

Commit

Permalink
docs: update faq
Browse files Browse the repository at this point in the history
  • Loading branch information
mthh committed Nov 14, 2024
1 parent ff011b2 commit 2e8968a
Show file tree
Hide file tree
Showing 2 changed files with 101 additions and 7 deletions.
65 changes: 60 additions & 5 deletions docs/en/faq.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,72 @@
# Frequently Asked Questions

::: warning
#### - Why is the rendering of some SVG exports different in Inkscape/Adobe Illustrator than when displaying the map in Magrit?

The english version of the documentation is currently under construction.
You can use desktop vector graphics software such as [Inkscape](https://inkscape.org/) (free and open source - we recommend it) or [Adobe Illustrator](https://www.adobe.com/fr/products/illustrator.html) to edit SVG files.

Some parts are not yet translated and some translations may be incomplete or inaccurate.
There are also online applications for editing SVG files, such as [SVG-Edit](https://svg-edit.github.io/svgedit/) or [Method Draw](https://editor.method.ac/).

:::
### - Why do some SVG exports render differently in Inkscape / Adobe Illustrator than when the map is displayed in Magrit?

When creating a map, if you select one of the fonts offered in Magrit (other than the user's operating system font families such as *Serif*, *Sans-Serif* and *Monospace*), the map may not render in the same way in vector drawing software (such as Inkscape or Adobe Illustrator) as it does in Magrit.

#### - Why is the rendering of some SVG exports different in Inkscape/Adobe Illustrator than when displaying the map in Magrit?
This is because the fonts used in Magrit are not installed on your machine, so the vector graphics software cannot display them correctly.

However, you can check that the map contains the fonts used in Magrit by opening the SVG file in a web browser.

To solve this problem, you can download the fonts used in your card and install them on your machine.

See the answer to the next question concerning the origin of the fonts used and how to download and install them on your machine.


### - What are the fonts offered in Magrit? What are their licenses?

The following fonts are available in Magrit:

- Montserrat
- Open Sans
- Roboto
- Great Vibes
- Lato
- Pacifico
- Amatic
- Oswald
- Lobster
- Playfair Display
- Dosis
- League Gothic

These are free, royalty-free fonts (according to a review by [Font Squirrel](https://www.fontsquirrel.com/).
They can be used freely for personal or commercial projects, and can be included in applications (as in Magrit) as well as in documents / images / etc.

It is also possible to select the font families of the user's operating system when creating a card: *Serif*, *Sans-Serif* and *Monospace*.

#### - Why is it not possible to display an "OpenStreetMap" type basemap in Magrit?

The Magrit development team chose not to integrate an “OpenStreetMap” type basemap directly into the application for several reasons:

- **Dependence on a third-party service**: displaying an “OpenStreetMap” basemap requires a third-party service (the OpenStreetMap server, or another provider) to retrieve the map tiles. This implies a dependence on this third-party service, which may be slow or unavailable, and in any case requires an Internet connection.

- **Keeping the spirit of the application**: Magrit is a thematic mapping application that lets you create and export customized maps from geographic data. The aim is to highlight the user's data and enable them to represent it clearly and effectively. The addition of an “OpenStreetMap” basemap could divert the user's attention from his own data, making the map more complex to read. On the other hand, it would probably lead to the creation of maps using the Mercator projection in cases where this is not the most appropriate.
There are applications dedicated to the creation of maps on an “OpenStreetMap” base map (such as [uMap](https://umap.openstreetmap.fr/fr/)), which make it easy to create maps with pins, information boxes displayed on click, etc.

However, the possibility of integrating such base maps into Magrit is being studied for a future version of the application.

#### - The performance of the application seems to be degraded when using certain datasets or when adding many datasets?

Magrit uses SVG technology to display user-created maps.

This technology performs very well for moderate-sized maps, but can show its limitations when maps become very complex (many datasets, many entities, very detailed geometries, etc.).

If you are experiencing slowdowns when using Magrit, here are a few ways to improve performance:

- **Simplify data**: if you're using very detailed data (e.g. polygons with many vertices), try simplifying them when importing into Magrit (with the option provided) or before importing into Magrit.
You can use a geometry simplification tool such as [Mapshaper](https://mapshaper.org/) to reduce the number of polygon vertices while retaining the essential information.

- **Reduce the number of datasets displayed**: if you have many datasets displayed simultaneously, try hiding (with the dedicated button in the layer manager)
layers that are not being used (for example, after creating a choropleth map, you can hide the raw data that was used to create the map, as it is now covered by the newly created layer).

- **Reduce the number of entities displayed**: if you have a large number of entities in your datasets, try filtering the data to display only those you need to create your map.
For example, if you have a dataset of communes in France and you only need communes from one département, filter the data (using Magrit's selection feature) to keep only communes from that département.

The Magrit development team is also working on improving the application's display performance and proposing solutions for managing larger datasets.
43 changes: 41 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,15 @@ Il existe également des applications en ligne qui permettent de modifier des fi

#### - Pourquoi le rendu de certains exports SVG n'est pas le même dans Inkscape / Adobe Illustrator que lors de l'affichage de la carte dans Magrit ?

Voir la réponse à la question suivante concernant l'origine des polices utilisées et la manière de les télécharger et installer sur votre machine.
Lors de la création d'une carte, si vous sélectionnez une des polices de caractères proposées dans Magrit (autre que les familles de polices du système d'exploitation de l'utilisateur telles que *Serif*, *Sans-Serif* et *Monospace*),
il est possible que le rendu de la carte ne soit pas le même dans un logiciel de dessin vectoriel (comme Inkscape ou Adobe Illustrator) que dans Magrit.

Cela est du au fait que les polices de caractères utilisées dans Magrit ne sont pas installées sur votre machine et que le logiciel de dessin vectoriel ne peut donc pas les afficher correctement.
Vous pouvez toutefois vérifier que la carte contient bien les polices de caractères utilisées dans Magrit en ouvrant le fichier SVG dans un navigateur Web.

Pour résoudre ce problème, vous pouvez télécharger les polices de caractères utilisées dans votre carte et les installer sur votre machine.

Voir la réponse à la question suivante concernant l'origine des polices utilisées et la manière de les télécharger et les installer sur votre machine.

#### - Quelles sont les polices d'écritures proposées dans Magrit ? Quelles sont leurs licences ?

Expand All @@ -32,9 +40,40 @@ Il s'agit de polices gratuites et libres de droit (d'après la revue qui en a é
Elles peuvent être utilisées librement pour des projets personnels ou commerciaux et peuvent aussi bien être incluses dans des applications
(comme c'est le cas dans Magrit) que dans des documents / images / etc.

Par ailleurs il est possible de sélectionner les familles de polices du système d'exploitation de l'utilisateur : Serif, Sans-Serif et Monospace.
Par ailleurs il est possible de sélectionner les familles de polices du système d'exploitation de l'utilisateur lors de la création d'une carte : *Serif*, *Sans-Serif* et *Monospace*.

#### - Pourquoi n'est-il pas possible d'afficher un fond de carte type "OpenStreetMap" dans Magrit ?

L'équipe de développement de Magrit a fait le choix de ne pas intégrer de fond de carte type "OpenStreetMap" directement dans l'application pour plusieurs raisons :

- **Dépendance à un service tiers** : afficher un fond de carte "OpenStreetMap" nécessite de faire appel à un service tiers (le serveur d'OpenStreetMap, ou d'un autre fournisseur) pour récupérer les tuiles de la carte.
Cela implique une dépendance à ce service tiers, qui peut être lent ou indisponible et nécessite dans tous les cas une connexion à Internet.

- **Conserver l'esprit de l'application** : Magrit est une application de cartographie thématique qui permet de créer et exporter des cartes personnalisées à partir de données géographiques.
L'objectif est de mettre en avant les données de l'utilisateur et de lui permettre de les représenter de manière claire et efficace.
L'ajout d'un fond de carte "OpenStreetMap" risquerait de détourner l'attention de l'utilisateur de ses propres données et pourrait rendre la carte plus complexe à lire.
Par ailleurs, cela conduirait probablement à la création de cartes utilisant la projection Mercator dans des cas où cela n'est pas le plus approprié.

Il existe des application dédiées à la création de cartes sur un fond de carte "OpenStreetMap" (comme [uMap](https://umap.openstreetmap.fr/fr/))
qui permettent de réaliser facilement des cartes avec des épingles, des boites d'informations affichées au clic, etc.

La possibilité d'intégrer de tels fonds de cartes dans Magrit est toutefois à l'étude pour une version future de l'application.

This comment has been minimized.

Copy link
@rCarto

rCarto Nov 14, 2024

Member

Je retirerais cette ligne qui semble dédire ce qui précède. Et je mettrais ligne 47.
"L'équipe de développement de Magrit a fait le choix de ne pas intégrer de fond de carte type "OpenStreetMap" directement dans l'application pour l'instant pour plusieurs raisons :"

This comment has been minimized.

Copy link
@mthh

mthh Nov 14, 2024

Author Member

👍


#### - Les performances de l'application semblent dégradées lors de l'utilisation de certains jeux de données ou lors de l'ajout de nombreux jeux de données ?

Magrit utilise la technologie SVG pour afficher les cartes créées par l'utilisateur.

Cette technologie est très performante pour des cartes de taille modérée mais peut montrer ses limites lorsque les cartes deviennent très complexes (nombreux jeux de données, nombreuses entités, géométries très détaillées, etc.).

Si vous constatez des ralentissements lors de l'utilisation de Magrit, voici quelques pistes pour améliorer les performances :

- **Simplifier les données** : si vous utilisez des données très détaillées (par exemple des polygones avec de nombreux sommets), essayez de les simplifier lors de l'import dans Magrit (avec l'option proposée) ou avant de les importer dans Magrit.
Vous pouvez utiliser un outils de simplification de géométries comme [Mapshaper](https://mapshaper.org/) pour réduire le nombre de sommets des polygones tout en conservant l'essentiel de l'information.

- **Réduire le nombre de jeux de données affichés** : si vous avez de nombreux jeux de données affichés simultanément, essayez de masquer (avec le bouton dédié dans la gestionnaire de couches)
les couches qui ne sont pas utilisées (par exemple, après création d'une carte choroplèthe, vous pouvez masquer les données brutes qui ont servi à la création de la carte puisqu'elles sont désormais recouvertes par la nouvelle couche créée).

- **Réduire le nombre d'entités affichées** : si vous avez de nombreux entités dans vos jeux de données, essayez de filtrer les données pour n'afficher que celles qui sont nécessaires à la création de votre carte.
Par exemple, si vous avez un jeu de données de communes en France et que vous n'avez besoin que des communes d'un département, filtrez les données (avec la fonctionnalité de sélection de Magrit) pour ne garder que les communes de ce département.

L'équipe de développement de Magrit travaille par ailleurs à améliorer les performances d'affichage de l'application et à proposer des solutions pour gérer des jeux de données plus importants.

This comment has been minimized.

Copy link
@rCarto

rCarto Nov 14, 2024

Member

Ici je mettrais un petit indice sur la techno que tu envisages, pour les connoisseurs.

This comment has been minimized.

Copy link
@mthh

mthh Nov 14, 2024

Author Member

👍

0 comments on commit 2e8968a

Please sign in to comment.