Skip to content

Commit

Permalink
Update documentation with the URL of the new DSFR site (#27)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ash-Crow
Ash-Crow authored Oct 19, 2022
1 parent 51b24fa commit ba912a4
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 40 deletions.
2 changes: 1 addition & 1 deletion README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Django-DSFR is a Django app to integrate the `French government Design System ("

This app was created as a part of `Open Collectivités <https://github.com/entrepreneur-interet-general/opencollectivites>`_ and is very much a work in progress. See the `documentation (in French) <https://entrepreneur-interet-general.github.io/django-dsfr/>`_ for details.

Django-DSFR (partly) implements the `version 1.7.2 of the DSFR <https://gouvfr.atlassian.net/wiki/spaces/DB/pages/978354177/Version+1.4>`_.
Django-DSFR (partly) implements the `version 1.7.2 of the DSFR <https://www.systeme-de-design.gouv.fr/a-propos/versions-du-dsfr/version-courante>`_.

Requirements
------------
Expand Down
85 changes: 46 additions & 39 deletions example_app/tag_specifics.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"content": "<p><b>Bold</b> and <em>emphatic</em> Example content</p>",
}
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/312082509/Accord+on+-+Accordion",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/accordeon",
},
"alert": {
"title": "Alertes (alerts)",
Expand All @@ -35,7 +35,7 @@
"heading_tag": "h3",
},
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/736362500/Alertes+-+Alerts",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/alerte",
},
"badge": {
"title": "Badge",
Expand All @@ -57,9 +57,12 @@
"extra_classes": "fr-badge--success",
},
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/851869737/Badges",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/badge",
},
"breadcrumb": {
"title": "Fil d’Ariane (breadcrumb)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/fil-d-ariane",
},
"breadcrumb": {"title": "Fil d’Ariane (breadcrumb)"},
"button": {
"title": "Boutons (buttons)",
"sample_data": [
Expand All @@ -68,7 +71,7 @@
"onclick": "alert('button doing stuff')",
}
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/217284660/Boutons+-+Buttons",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/bouton",
},
"callout": {
"title": "Mise en avant (callout)",
Expand All @@ -94,7 +97,7 @@
},
},
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/222331196/Mise+en+avant+-+Call-out",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/mise-en-avant",
},
"card": {
"title": "Carte (card)",
Expand Down Expand Up @@ -248,9 +251,12 @@
},
},
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/222331445/Carte+-+Card",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/carte",
},
"favicon": {
"title": "Icône de favoris (favicon)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/icones-de-favoris",
},
"favicon": {"title": "Icône de favoris (favicon)"},
"highlight": {
"title": "Mise en exergue (highlight)",
"sample_data": [
Expand All @@ -259,7 +265,7 @@
"size_class": "fr-text--sm",
}
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/223019199/Mise+en+exergue+-+Highlight",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/mise-en-exergue",
},
"input": {
"title": "Champs de saisie (input)",
Expand All @@ -280,7 +286,7 @@
"max": "2021-09-23",
},
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/217088099/Champs+de+saisie+-+Input",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/champ-de-saisie",
},
"link": {
"title": "Lien (link)",
Expand All @@ -292,11 +298,11 @@
"extra_classes": "fr-link--lg",
}
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/217284725/Liens+-+Links",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/liens",
},
"pagination": {
"title": "Pagination (pagination)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/223051980/Pagination+-+Pagination",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/pagination",
},
"quote": {
"title": "Citation (quote)",
Expand All @@ -316,7 +322,7 @@
"image_url": "/django-dsfr/static/img/placeholder.1x1.svg",
}
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/771358744/Citation+-+Quote",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/citation",
},
"select": {
"title": "Listes déroulantes (selects)",
Expand All @@ -336,7 +342,7 @@
],
}
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/223019306/Liste+d+roulante+-+Select",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/liste-deroulante",
},
"sidemenu": {
"title": "Menu latéral (sidemenu)",
Expand Down Expand Up @@ -381,7 +387,7 @@
],
}
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/258998801/Menu+lat+ral+-+Side+menu",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/menu-lateral",
},
"skiplinks": {
"title": "Liens d’évitement (skiplinks)",
Expand All @@ -391,7 +397,7 @@
{"link": "#navigation-header", "label": "Menu"},
]
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/260014417/Liens+d+vitement+-+Skiplinks",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/liens-d-evitement",
},
"summary": {
"title": "Sommaire (summary)",
Expand All @@ -401,7 +407,7 @@
{"link": "link_2", "label": "Second item title"},
]
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/262898307/Sommaire+-+Summary",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/sommaire",
},
"table": {
"title": "Tableau (table)",
Expand All @@ -412,7 +418,7 @@
"content": [["a", "b", "c"], ["d", "e", "f"]],
}
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/312016971/Tableau+-+Table",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/tableau",
},
"tag": {
"title": "Tag (tag)",
Expand Down Expand Up @@ -443,11 +449,11 @@
"extra_classes": "fr-tag--green-emeraude",
},
],
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/310706305/Tag",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/tag",
},
"theme_modale": {
"title": "Modale de sélection du thème",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/579928166/Param+tres+d+affichage+-+Switch+theme",
"title": "Paramètres d'affichage (display)",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/parametres-d-affichage",
},
"tile": {
"title": "Tuile (tile)",
Expand All @@ -458,6 +464,7 @@
"image_path": "/django-dsfr/static/img/placeholder.1x1.svg",
}
],
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/tuile",
},
}

Expand Down Expand Up @@ -523,75 +530,75 @@
NOT_YET_IMPLEMENTED_TAGS = {
"file_upload": {
"title": "Ajout de fichier (file upload)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/864190467/Ajout+de+fichier+-+File+upload",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/ajout-de-fichier",
},
"notice": {
"title": "Bandeau d’information importante (notice)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/992903190/Bandeau+d+information+importante",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/bandeau-d-information-importante",
},
"search_bar": {
"title": "Barre de recherche (search bar)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/217186376/Barre+de+recherche+-+Search+bar",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/barre-de-recherche",
},
"franceconnect": {
"title": "Bouton FranceConnect",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/967868417/Bouton+FranceConnect",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/bouton-franceconnect",
},
"radio": {
"title": "Bouton radio (radio)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/217088553/Boutons+radio+-+Radio+button",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/boutons-radio",
},
"radio_rich": {
"title": "Bouton radio riche (radio_rich)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/368935129/Boutons+radio+riches+-+Radio+buttons+extended",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/boutons-radio-riches",
},
"checkbox": {
"title": "Case à cocher (checkbox)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/217251933/Case+cocher+-+Checkbox",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/case-a-cocher",
},
"responsive_medias": {
"title": "Contenu média (responsive_medias)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/223019554/Contenu+m+dias+-+Responsive+medias",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/contenu-medias",
},
"consent": {
"title": "Gestionnaire de consentement (consent)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/609189956/Gestionnaire+de+consentement+-+Consent+banner",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/gestionnaire-de-consentement",
},
"stepper": {
"title": "Indicateur d’étapes",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/1010860097/Indicateur+d+tapes",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/indicateur-d-etape",
},
"toggle": {
"title": "Interrupteur (toggle)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/368935138/Interrupteur+-+Toggle+switch",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/interrupteur",
},
"newsletter_follow": {
"title": "Lettre d’information et réseaux sociaux (newsletter & follow)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/779747332/Lettre+d+information+et+r+seaux+sociaux+-+Newsletter+Follow+us",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/lettre-d-info-et-reseaux-sociaux",
},
"modal": {
"title": "Modale (modal)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/476610770/Modale+-+Modal",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/modale",
},
"navigation": {
"title": "Navigation principale (navigation)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/222789853/Navigation+principale+-+Main+navigation",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/navigation-principale",
},
"tab": {
"title": "Onglet (tab)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/367985267/Onglets+-+Tabs",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/onglets",
},
"share": {
"title": "Partage (share)",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/771555355/Partage+-+Share",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/partage",
},
"translate": {
"title": "Sélecteur de langue",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/1034158081/S+lecteur+de+langues",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/selecteur-de-langue",
},
"download": {
"title": "Téléchargement de fichier",
"doc_url": "https://gouvfr.atlassian.net/wiki/spaces/DB/pages/980025345/T+l+chargement+de+fichier",
"doc_url": "https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/telechargement-de-fichier",
},
}

Expand Down
2 changes: 2 additions & 0 deletions example_app/templates/example_app/page_tag.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
<h1> {{ title }} </h1>

{% if doc_url %}
<p>
{% dsfr_link url=doc_url label="Voir la page de documentation du composant sur le Système de Design de l’État" is_external=True extra_classes="fr-link--lg" %}
</p>
{% endif %}

<h2>Documentation du tag</h2>
Expand Down

0 comments on commit ba912a4

Please sign in to comment.