PandoCit

approved

by l'Atelier

Forked from Pandoc Reference List

Citations Pandoc, bibliothĂšque Zotero (API), lecteurs PDF/EPUB et annotations dans Obsidian. - This plugin has not been manually reviewed by Obsidian staff.

★ 4 stars↓ 420 downloadsUpdated 1mo agoGPL-3.0
PandoCit

PandoCit

Citations Pandoc dans Obsidian
panneau latéral · bibliographie WASM · intégration Zotero

l'Atelier
DĂ©veloppĂ© par l'Atelier — fabrication de livres et outils de recherche (EHESS)

đŸ‡«đŸ‡· Français · 🇬🇧 English · đŸ‡©đŸ‡Ș Deutsch · đŸ‡Ș🇾 Español

Site l'Atelier DépÎt GitHub Installer via BRAT


📾 Aperçu

Liste des référencesBibliothÚque
Panneau des références formatéesPanneau bibliothÚque Zotero

📖 À propos

Affiche dans le panneau latéral une liste de références formatée pour chaque clé de citation Pandoc ([@clef]) présente dans la note active.

âŹ‡ïž Installation via BRAT (1 clic)

ID du plugin (catalogue Obsidian) : pandocit — le dossier dans .obsidian/plugins/ doit s’appeler pandocit (sans le mot obsidian dans l’ID, conformĂ©ment aux rĂšgles du manifest). Si vous migrez depuis obsidian-pandoc-reference-list, renommez le dossier ou rĂ©installez, puis copiez data.json et pandoc.wasm.

  1. 🔌 Installer BRAT : Obsidian — BRAT
  2. ➕ Ajouter ce dĂ©pĂŽt avec l’option « Add Beta plugin » :
    https://github.com/Atelier-Recherche/pandocit

💡 Nos plugins peuvent ĂȘtre en attente de validation sur le catalogue Obsidian ; BRAT permet de les tester dĂšs maintenant. Voir aussi 🌐 l’Atelier.

⚙ Fonctionnement

  • 🩀 Le plugin utilise Pandoc 3.9 en WebAssembly (pandoc.wasm) pour convertir les fichiers de bibliographie (BibTeX, etc.) en CSL JSON. Aucune installation de Pandoc sur le systĂšme n’est nĂ©cessaire.
  • đŸ“± Compatible Obsidian bureau (Windows, macOS, Linux) et mobile (Android, iOS) : le mĂȘme plugin fonctionne sur ordinateur, tĂ©lĂ©phone et tablette.

🔧 Configuration

  1. 📚 Bibliographie
    Indiquez le chemin vers votre fichier de bibliographie (compatible Pandoc : .bib, .json CSL, etc.).

    • đŸ–„ïž Sur bureau : bouton de sĂ©lection ou chemin absolu / relatif au coffre.
    • đŸ“± Sur mobile : chemin relatif au coffre (ex. refs/bibliographie.bib). La boĂźte « ouvrir un fichier » n’est disponible que sur bureau.
  2. 🎹 Style de citation (CSL) (optionnel)
    Liste intégrée ou fichier .csl (chemin ou URL), éventuellement surchargé par le frontmatter (bibliography, csl, lang, etc.).

  3. 📋 Panneau des rĂ©fĂ©rences
    Palette de commandes : « PandoCit : Show reference list » (libellé selon la langue Obsidian).

  4. 🌐 Langue du plugin (optionnel)
    Dans les réglages du plugin : langue des libellés (paramÚtres, notices, panneau latéral).

📚 Zotero (optionnel)

🔗 Better BibTeX / flux local

L’intĂ©gration Better BibTeX et le rĂ©seau local convient surtout Ă  Obsidian bureau. Sur mobile, prĂ©fĂ©rez une bibliographie fichier dans le coffre.

☁ Zotero Web API

Une fois activée dans les réglages :

  • 🔑 ClĂ© API et bibliothĂšque personnelle ou de groupe (ID numĂ©rique).
  • đŸ‘„ Fusion de bibliothĂšques de groupe : IDs de groupes + Charger les groupes ou noms d’affichage personnalisĂ©s (une ligne par ID + libellĂ©).
  • 🔄 Synchronisation bidirectionnelle (modĂšle Zotero API).
  • đŸ“€ Export BibTeX optionnel vers un .bib dans le coffre (Pandoc, LaTeX, Typst).

Les donnĂ©es sont stockĂ©es en JSON dans le dossier du plugin ; aucun Node local Zotero n’est requis — usage hors ligne possible aprĂšs synchro.

🌳 Panneau « BibliothĂšque »

Commande : « Open library panel » / « Ouvrir le panneau bibliothÚque ».

Vue arborescente (collections, éléments sans classe, piÚces isolées, corbeille). Filtre, édition des notices (notes HTML Zotero), piÚces jointes PDF / fichiers sur la ligne.

  • ▾ Sous-arbre repliĂ© par dĂ©faut : icĂŽne chevron dans la bande des piĂšces jointes pour afficher / masquer les enfants.
  • đŸ·ïž Badges de type (livre, article
) selon la langue d’interface du plugin.

Commande « Sync Zotero library (Web API) » pour actualiser aprÚs la premiÚre synchro.

đŸ“„ Import d’un dossier PDF vers Zotero

Commande « Importer un dossier PDF vers Zotero » (panneau bibliothĂšque ou palette) : scan rĂ©cursif d’un dossier du coffre, dĂ©tection des doublons, clĂ©s de citation suggĂ©rĂ©es (auteur + annĂ©e + initiales du titre), collections « longs » / « courts » PDF, piĂšce jointe liĂ©e au coffre ou tĂ©lĂ©versĂ©e. RĂ©glages : dossier par dĂ©faut, motifs d’exclusion, regex sur les noms de fichiers.

📄 Lecteur PDF intĂ©grĂ©

  • Ouverture des PDF via le coffre dans le lecteur Obsidian natif.
  • Surlignage dans le PDF et/ou Zotero (API Web), avec styles mĂ©morisĂ©s et menu contextuel.
  • Panneau annotations : liste unifiĂ©e (PDF, Zotero), copie de rĂ©fĂ©rence Pandoc (> texte, lien Obsidian, [@citekey]).
  • Synchronisation des surlignages avec les piĂšces jointes Zotero liĂ©es au fichier du coffre.

📗 Lecteur EPUB intĂ©grĂ©

  • Lecteur foliate-js dans Obsidian (navigation, surlignage local).
  • Fichier sidecar d’annotations Ă  cĂŽtĂ© de l’EPUB.
  • DĂ©but de liaison Zotero (lecture / envoi d’annotations si piĂšce jointe EPUB reconnue) — voir roadmap ci-dessous.

📝 Hypothesis (optionnel)

Token API et groupe dans les réglages. Import des annotations Hypothesis vers le panneau document (EPUB) ; export des annotations locales vers Hypothesis. Interface masquée si non configuré.

đŸ—ș Roadmap (synthĂšse)

État actuel : citations Pandoc + Zotero API + PDF sont les plus matures ; EPUB et Hypothesis ont une base fonctionnelle à affiner.

PrioritéEPUBHypothesisAutres pistes
Court termePanneau annotations alignĂ© sur le PDF ; notes Zotero (HTML) depuis la bibliothĂšque ; stabilitĂ© surlignage ↔ Zotero (CFI)Jeux de tests (URI coffre, groupe public/privĂ©, aller-retour import/export) ; messages d’erreur plus explicitesImport dossier PDF : affiner filtres et retours utilisateur
Moyen termeRecherche dans le livre ; prĂ©fĂ©rences typographie ; conversion cible PDF ↔ Zotero comme pour le PDFSĂ©lecteurs riches (pas seulement citation textuelle) ; lien avec pages PDF si mĂȘme ouvrageCopier rĂ©fĂ©rence depuis annotations EPUB comme pour le PDF
Long termeParité fonctionnelle PDF/EPUB (overlay, mobile)Workflow de revue de littérature (sync planifiée, conflits)Plugin catalogue Obsidian ; tests CI étendus ; assets PDF locaux sans CDN

EPUB — dĂ©tail

  • Lecteur foliate, sidecar, toolbar de base
  • Lecture annotations Zotero existantes ; envoi highlight vers Zotero (API)
  • Édition / affichage des notes Zotero liĂ©es Ă  l’EPUB
  • Surlignage fluide avec synchro bidirectionnelle fiable
  • IntĂ©gration complĂšte au panneau « Annotations du document »
  • Tests sur gros fichiers et mobile

Hypothesis — dĂ©tail

  • Token + groupe ; import API search ; export POST
  • Tests systĂ©matiques (PDF annotĂ© dans le navigateur, EPUB, URIs multiples)
  • Robustesse rĂ©seau et quotas API
  • Harmonisation avec le flux Zotero (Ă©viter doublons, choix de source)

Autres idées

  • Insertion de citation (commande palette) : recherche Ă©lĂ©gante sur la bibliographie dĂ©jĂ  chargĂ©e (titre, auteur, clĂ©), aperçu formatĂ© citeproc, choix du format d’insertion ([@clef], note inline ^[
], etc.) — sans exiger Zotero installĂ© ; le flux BBT/CAYW reste un raccourci optionnel pour qui l’utilise dĂ©jĂ , pas une dĂ©pendance du plugin.
  • Renommage de clĂ© de citation : modifier une citekey (import PDF, bibliothĂšque Zotero, notice) et proposer de mettre Ă  jour toutes les occurrences dans le coffre ([@ancienne], @ancienne, liens [[@
]], notes de bas de page, etc.) avec aperçu des fichiers touchĂ©s avant validation.
  • Recherche globale dans les annotations (tous documents ouverts rĂ©cemment).
  • Export groupĂ© des rĂ©fĂ©rences d’une session de lecture.
  • Rappel de synchronisation Zotero avant export .bib.
  • Support Typst / modĂšles de notes de lecture depuis les annotations.

Les cases cochĂ©es reflĂštent l’état du dĂ©pĂŽt Ă  la date de la doc ; la roadmap peut Ă©voluer sur GitHub Issues.

đŸ’» DĂ©veloppement et build

Prérequis : Node.js et Yarn.

yarn install
yarn build

En CI / release, yarn install utilise --ignore-scripts et un cache Yarn local au runner (évite les corruptions du cache global ~/.cache/yarn).

Le build produit notamment :

  • main.js (bundle ; non versionnĂ© — fourni par les releases GitHub)
  • manifest.json, styles.css
  • pdf.worker.min.mjs, foliate-view.mjs (optionnels dans le coffre ; worker embarquĂ© dans main.js, lecteur EPUB tĂ©lĂ©chargeable depuis les rĂ©glages)
  • pdf-assets/, foliate/ (gĂ©nĂ©rĂ©s au build, non versionnĂ©s ; foliate/ sert au bundle foliate-view.mjs)

Déploiement local (Windows) :

.\Deploy-LocalPlugin.ps1

Copie main.js, manifest.json, styles.css, pdf.worker.min.mjs et foliate-view.mjs vers le dossier plugin Obsidian (préserve data.json et pandoc.wasm).

Release : .\Release-Plugin.ps1 incrémente la version, build, commit, tag et push ; la workflow release publie uniquement main.js, manifest.json et styles.css (exigence du catalogue Obsidian). Le worker PDF est inclus dans main.js ; un téléchargement optionnel de pdf.worker.min.mjs est proposé dans les réglages du plugin (comme pour pandoc.wasm).

Dans le coffre, installez aussi pandoc.wasm via les réglages du plugin (obligatoire pour les bibliographies non-JSON).

⚠ Limitations connues (WASM)

Pandoc WASM tourne dans un bac Ă  sable : pas d’accĂšs rĂ©seau arbitraire ni d’exĂ©cution de commandes systĂšme. Ce plugin n’utilise que la conversion bibliographie → CSL JSON.

🔗 Ressources

🌐 l'Atelieratelier.atechnologie.fr
📩 DĂ©pĂŽtgithub.com/Atelier-Recherche/pandocit
📄 Pandocpandoc.org — Releases / pandoc.wasm 3.9
🎓 CSLcitationstyles.org

đŸ‡«đŸ‡· Français · 🇬🇧 English · đŸ‡©đŸ‡Ș Deutsch · đŸ‡Ș🇾 Español

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.