InseeFrLab / InseeFrLab/quarto-insee-extension
Séparer l'extension du template revealJS
- Dominant language
- CSS
- Stars
- 2
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Vu la manière dont une extension quarto est créée, je trouve plus simple de séparer en deux repos l'extension et la présentation / formation à quarto complète.
Les fichiers liés à index.qmd seraient ainsi migrés dans un autre repo (par ex: revealjs-insee-demo) où l'extension quarto serait installée. Cela serait plus proche de l'usage usuel pour les utilisateurs de l'extension quarto-insee et par ailleurs plus pratique pour maintenir l'extension quarto insee. Un template plus léger (un seul fichier qmd plus court) resterait dans le repo de l'extension.
En effet, dans une extension, les chemins relatifs changent entre le repo "source" de l'extension et le repo qui l'utilise.
Dans un repo source (ici : quarto-insee-extension), les fichiers sont organisés comme cela :
```
├── _extensions
│ └── insee-clair
│ ├── auto-colors.lua
│ ├── ...
│ ├── _extension.yml
│ └── ressources
```
Mais si un utilisateur utilise cette extension, il la verra dans son repo sous cette architecture :
```
├── _extensions
│ └── inseefrlab <= nouveau dossier par user
│ ├── insee-clair
│ │ ├── auto-colors.lua
│ │ ├── ...
│ │ ├── _extension.yml
│ │ └── ressources
```
Ainsi, lorsque le template est dans le repo "origine", tous les chemins relatifs ne sont pas ceux d'un user classique.
Les fichiers à déplacer seraient :
- la banque d'image (dans ressources/img sauf les logos utilisés dans l'extension) : cela permet dans un premier temps d'alléger la taille de l'extension #7
- et les fichiers :
```
├── 01_styleParDefaut.qmd
├── 02_modulariteSupport.qmd
├── 03_parametresExecution.qmd
├── 04_fenetreModale.qmd
├── 05_exportPdf.qmd
├── 06_documentation.qmd
├── _brand.yml
├── data
│ ├── donnees_carte.Rdata
│ └── jeuDeDonnees_test_param.csv
├── index.qmd
├── img
│ ├── background_jobs_rstudio.png
│ ├── LOGOS_AUVERGNE-RHONE-ALPES_SIGNATURE_CMJN.jpg
│ └── renders_quarto.png
├── params.yml
├── presentation-quarto.Rproj
├── _quarto.yml
├── R
│ ├── data.qmd
│ ├── generateMap.R
│ ├── gestionJeuDonnees.R
│ ├── taillePlotlyFixee.R
│ └── taillePlotlyNonFixee.R
├── README.md # juste les parties comment utiliser le template quarto
├── renv
│ ├── activate.R
│ └── settings.json
├── renv.lock
├── _variables.yml
└── videos
└── presentation_nouveauLogo.mp4
```
Resterait ainsi dans l'extension :
```
.
├── CHANGELOG
├── _extensions
│ └── insee-clair
│ ├── auto-colors.lua
│ ├── custom_writer.lua
│ ├── _extensions
│ │ ├── confetti
│ │ ├── fontawesome
│ │ ├── multimodal
│ │ ├── pointer
│ │ └── verticator
│ ├── _extension.yml
│ └── ressources
│ ├── css
│ │ ├── default.css
│ │ ├── insee_clair.css
│ │ └── Insee_Commun.scss
│ ├── divers
│ │ └── Logo_Insee_SignatureAdroite.jpg
│ ├── img
│ │ ├── icones
│ │ │ └── play.svg
│ │ ├── licences
│ │ ├── logo_Regions
│ │ ├── logos
│ │ ├── logo_SSM
│ ├── open_document
│ │ ├── exemple_modification_writer.png
│ │ ├── libreOffice-template.odt
│ │ ├── template_writer_Final.odt
│ │ └── volet_lateral_style_et_formatage.png
│ └── revealJs
├── img
│ └── LOGOS_AUVERGNE-RHONE-ALPES_SIGNATURE_CMJN.jpg
├── LICENCE.md
├── README.md # allégé
├── template.qmd
└── template_writer.qmd
```
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by comparing _extensions/insee-clair/_extension.yml with _quarto.yml and the listed template files to map the relative paths that differ for installed users. Separate the listed presentation, data, images, R, renv, and video files from the extension, retain the specified extension files and lightweight templates, and verify that the resulting paths work from a user repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css, r
- Domain
- documentation, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100