Initialise un dépôt de document de travail (WP) OFCE
setup_wp.RdCopie les gabarits embarqués dans le package (`inst/setup_wp/`) à la racine du dépôt, initialise la branche `gh-pages` pour la pré-publication, et adapte le `_quarto.yml` avec les métadonnées du WP (titre, numéro, année, langue, URLs).
Usage
setup_wp(
path = ".",
lang = "fr",
hypothesis = NULL,
versionning = NULL,
stage_target = NULL
)Arguments
- path
Chemin vers la racine du dépôt. Défaut `"."`.
- lang
Chaîne. Langue principale : `"fr"` (défaut) ou `"en"`.
- hypothesis
Logique. Active les commentaires Hypothesis. Défaut `FALSE`.
- versionning
Logique. Si `TRUE` et WP publié (`wp` non `NULL`), ajoute `/v0` au `site-path`.
- stage_target
Chaîne. Destination de pré-publication (brouillon, `wp` non encore attribué) : `"auto"` (défaut pour un nouveau dépôt) est écrit littéralement dans `_quarto.yml` et réévalué à chaque appel de [deploy_wp()] selon le propriétaire GitHub *au moment du déploiement* — `"ftp"` (staging OFCE) pour les dépôts de l'organisation `ofce`, `"gh-pages"` sinon. Cela permet à un transfert de propriété vers `ofce` de changer la destination sans repasser par `setup_wp()`. `"gh-pages"` et `"ftp"` forcent explicitement la destination (écrits tels quels, plus jamais réévalués). `"ofce"` est un alias hérité de `"ftp"`, accepté pour compatibilité avec d'anciens `_quarto.yml` mais normalisé en `"ftp"` à l'écriture. Une valeur déjà présente dans `_quarto.yml` est toujours conservée telle quelle — la résolution automatique ne s'applique qu'à un dépôt sans `stage-target`.
Details
Précondition bloquante : `path` doit déjà être un dépôt git (`git init`, ou un clone d'un dépôt GitHub existant) — sinon la fonction s'arrête immédiatement avec [cli::cli_abort()]. `_quarto.yml`, lui, n'a pas besoin d'exister au préalable : `setup_wp()` le crée depuis le gabarit du package si absent.
Juste avant d'appeler [ofce::setup_quarto()] pour poser les extensions Quarto OFCE, `setup_wp()` vérifie aussi (via `check_ofce_version()`) que le package **ofce** installé est en version `>= 1.3.39` — sinon la fonction s'arrête immédiatement avec [cli::cli_abort()].
La fonction est **non-destructive** pour les fichiers utilisateur : sur un dépôt existant, les fichiers gabarits `.qmd` et scripts (dont `_quarto.yml`) ne sont pas écrasés, et les champs YAML ne sont mis à jour que si l'argument correspondant a été fourni explicitement. Les champs déjà absents ne sont pas injectés. `repo-url`, `favicon` et `ofce_wp: true` sont toujours positionnés (valeurs dérivées sans ambiguïté). `website.site-url`/`website.site-path` sont eux aussi toujours (re)calculés dès que `wp` est non nul — valeur lue dans `_quarto.yml` ou fournie par le registre central — pour qu'un `site-path` manquant (fichier édité à la main, ou créé avant cette fonctionnalité) soit toujours réparé.
En revanche, les **workflows GitHub Actions** (`.github/workflows/`) sont **toujours mis à jour** depuis la version de référence du package : ils ne doivent pas être modifiés manuellement par l'utilisateur, et chaque appel à `setup_wp()` réapplie les corrections et mises à jour de templates.
Pour les WPs publiés (`wp` non nul), la fonction met à jour la variable GitHub Actions `FTP_SERVER_DIR` (publique, visible dans Settings → Variables) à partir du `site-path` du `_quarto.yml`. Les workflows `ftp_deploy.yml` et `ftp_stage.yml` sont aussi migrés automatiquement si `server-dir` y est encore codé en dur, et si l'étape de vérification anti-collision (voir [wp_manifest()]) y est absente.
`wp` et `annee` ne sont **pas** des arguments : ils sont soit lus depuis un `_quarto.yml` déjà existant, soit écrasés par une entrée confirmée du registre central (`ofce/wp-registry`), jamais choisis librement par l'appelant. Un dépôt sans `_quarto.yml` et sans entrée de registre reste un brouillon (`wp` absent) ; pour obtenir un numéro, utiliser [wp_registry_request()] puis relancer `setup_wp()` une fois la PR fusionnée. De même, le titre affiché dans le résumé est toujours déduit de `index.qmd` (ou du nom du dépôt GitHub) — il n'y a plus d'argument `website_title`.
La variable `FTP_STAGING_DIR` est toujours positionnée (brouillon ou publié) à `repo/version/` — l'utilisateur FTP de staging ayant un chroot sur `www/staging/`, le chemin effectif sur le serveur est `www/staging/repo/version/`. Ce chemin est utilisé par `ftp_stage.yml` pour déposer les versions de revue avant enregistrement dans le registre central (voir [wp_registry_request()]).
Toujours pour les WPs publiés, `citation.issue` (`"année-wp"`, sans zéro de remplissage) et `citation.url` (`https://www.ofce.fr/wp/année/wp/`, l'URL publique stable, sans segment de version) sont recalculés à chaque appel à partir de `annee`/`wp` — ce sont des valeurs dérivées, jamais éditées manuellement.
Les extensions Quarto OFCE (`_extensions/`) sont installées/mises à jour via [ofce::setup_quarto()], qui les récupère depuis le dépôt GitHub `OFCE/ofce-quarto-extensions` — la fonction nécessite donc un accès réseau. D'éventuelles extensions périmées (installées par une version antérieure du package) sont signalées par un avertissement, jamais supprimées automatiquement.
`author` est destiné à ne vivre que dans `_quarto.yml` : si `index.qmd` en porte une (héritage d'un ancien gabarit, ou ajout manuel), elle est déplacée vers `_quarto.yml` – remplaçant la valeur qui y était déjà, généralement le placeholder du gabarit – puis commentée dans `index.qmd`, avec un avertissement décrivant le déplacement. Un `index.qmd` sans clé `author` ne déclenche aucune modification.
Les clés `format.*` de `_quarto.yml`/`index.qmd` sont nettoyées à chaque appel : `wp-html` reste l'unique format HTML actif (toute autre clé `*-html`, ex. `format.html`, est commentée ; `wp-html` est ajouté à `_quarto.yml` **et** à `index.qmd` s'il y est absent). Côté PDF, `wp-pdf` (LaTeX) et `wp-typst` (Typst) sont les deux seuls moteurs légitimes — toute autre clé PDF (`pdf`, `typst`, `ofce-pdf`, ...) est commentée. `wp-typst` est ajouté par défaut dans `index.qmd` uniquement quand **ni** `wp-pdf` **ni** `wp-typst` n'est déjà déclaré : un `wp-pdf` déjà présent n'est jamais remplacé. Si les deux sont déclarés simultanément, `wp-pdf` est commenté et `wp-typst` l'emporte. Le nom du PDF de brouillon (`wp` non attribué) est `ofce-draft-repo-version.pdf` (ex. `ofce-draft-wp-fg-loyers-v1.pdf`), identique quel que soit le moteur actif (`wp-pdf`/`wp-typst`) — sans segment de version si `version` n'est pas encore renseignée — recalculé à chaque appel. Une fois publié (`wp`/`annee` connus), les deux moteurs produisent `OFCEWPannee-wp.pdf`.