citationFactory = async function(referenceData = ``, {cslStyle = styleApa, cslLocale = localeEnUs, linkCitations = true, linkBibliography = true} = {}) { // Terminology used (arbitrary and capricious!) // reference = an entry in the source, that may or may not be cited or included in the bibliography // citation = an actual citation in the current notebook // citation item = the citing of a particular reference in a citation // citation cluster = a grouping of citation items cited together in the notebook // bibliography = the displayed list of references // bibliography entry = a single reference included in the bibliography const citationEngineId = Math.random().toString(36).substr(2, 5); // Make scrolling to bibliography entries from citation items work! const scrollToBibliographyEntry = (event) => { const sourceLink = event.target; if ( sourceLink instanceof HTMLAnchorElement && sourceLink.classList.contains('csl-link') && sourceLink.getAttribute('href').match(/^#/) ) { const destinationEntry = document.querySelector(`.csl-entry${sourceLink.hash}[data-citation-engine-id="${sourceLink.dataset.citationEngineId}"]`); if (destinationEntry) { event.preventDefault(); destinationEntry.scrollIntoView(); } } }; if (linkCitations) { document.addEventListener('click', scrollToBibliographyEntry); invalidation.then(() => document.removeEventListener('click', scrollToBibliographyEntry)); } // Use citation.js to convert from bibtex (or other formats!) to CSL-JSON and put in a map const referenceMap = (await citationJs.async(referenceData, {generateGraph: false})) .format('data', {format: 'object'}) .reduce((map, reference) => { return map.set(reference.id, reference); }, new Map()); const referenceIds = Array.from(referenceMap.keys()); // Create and initialize citeproc for immediate inline citations const sys = { retrieveLocale: () => { return cslLocale; }, retrieveItem: (id) => { return referenceMap.get(id); }, }; const inlineEngine = new citeproc.Engine(sys, cslStyle); inlineEngine.updateItems(referenceIds); // Create inline citations! function cite(...citationItems) { try { // Use the last argument as citation properties if it is an object without an id const citationProperties = ( citationItems.length && (typeof citationItems[citationItems.length - 1] === 'object') && !citationItems[citationItems.length - 1].hasOwnProperty('id') ) ? citationItems.pop() : {}; citationProperties.noteIndex = 0; // Process the citation item objects citationItems = citationItems.map((citationItem) => { // Convert strings to objects citationItem = (typeof citationItem === 'string') ? {id: citationItem} : citationItem; // Add wrapper and optionally link citation to its reference citationItem.prefix = `${citationItem.prefix ? citationItem.prefix : ``}${linkCitations ? `` : ``}`; citationItem.suffix = `${linkCitations ? `` : ``}${citationItem.suffix ? citationItem.suffix : ``}`; return citationItem; }); // Convert into citeproc citation const citationCluster = { citationItems: citationItems, properties: citationProperties, }; // Generate text of citation (and unescape the HTML!) const citationPreview = inlineEngine.previewCitationCluster(citationCluster, [], [], 'html') .replace(/</g, '<') .replace(/>/g, '>'); // Create final HTML and attach cluster object const citationTag = html`${citationPreview}`; citationTag.citationCluster = citationCluster; return citationTag; } catch (e) { return `Citation error: ${e}`; } } // Create offline citations and a bibliography! cite.bibliography = function({showAll = false, showNone = false} = {}) { return Generators.observe((notify) => { let handledAll = false; let handledNoCitations = false; let handledNoReferences = false; let previousCitationItemTags = []; function observed() { // Find all citation items const citationItemTags = Array.from(document.querySelectorAll(`span.csl-citation-item[data-citation-engine-id="${citationEngineId}"]`)); // Do we have any new citations? const haveNewCitationItems = citationItemTags.length && ( citationItemTags.length !== previousCitationItemTags.length || citationItemTags.some((citationItemTag, index) => { return citationItemTag !== previousCitationItemTags[index]; }) ); let offlineEngine; if (haveNewCitationItems) { // Find all citation clusters const citationClusterTags = Array.from(document.querySelectorAll(`span.csl-citation-cluster[data-citation-engine-id="${citationEngineId}"]`)); // Create citeproc for full offline citations offlineEngine = new citeproc.Engine(sys, cslStyle); offlineEngine.opt.development_extensions.wrap_url_and_doi = linkBibliography; offlineEngine.updateItems(referenceIds); // Process all citations const processedClusterList = []; const processedClusterMap = new Map(); citationClusterTags.forEach((citationClusterTag) => { const processedClusterData = offlineEngine.processCitationCluster(citationClusterTag.citationCluster, processedClusterList, []); processedClusterData[1].forEach((processedCluster) => { processedClusterMap.set( processedCluster[2], processedCluster[1].replace(/</g, '<').replace(/>/g, '>') ); }); // Update list of citations processedClusterList.push([citationClusterTag.citationCluster.citationID, 0]); }); // Update all citations citationClusterTags.forEach((citationClusterTag, index) => { // Insert into existing HTML! citationClusterTag.innerHTML = processedClusterMap.get(citationClusterTag.citationCluster.citationID); }); // Store new tags previousCitationItemTags = Array.from(document.querySelectorAll(`span.csl-citation-item[data-citation-engine-id="${citationEngineId}"]`)); } // Warn if no references if (!referenceIds.length) { if (!handledNoReferences) { notify(html`No references?`); handledNoReferences = true; } return; } handledNoReferences = false; // Stop if not displaying if (showNone) { notify(html``); return; } let bibliographyEngine; if (showAll) { // Check if we've already rendered if (handledAll) { return; } // Create citeproc for the bibliography bibliographyEngine = new citeproc.Engine(sys, cslStyle); bibliographyEngine.opt.development_extensions.wrap_url_and_doi = linkBibliography; // Add cited items to bibliography bibliographyEngine.updateUncitedItems(referenceIds); handledAll = true; } else { // Warn if no citations if (!citationItemTags.length) { if (!handledNoCitations) { notify(html`No citations!`); handledNoCitations = true; } return; } handledNoCitations = false; // Check if anything changed if (!haveNewCitationItems) { return; } bibliographyEngine = offlineEngine; } // Generate bibliography! const bibliographyObject = bibliographyEngine.makeBibliography(); // Insert IDs to act as link targets const bibliographyEntries = bibliographyObject[1].map((bibliographyEntry, index) => { return bibliographyEntry.replace(' { return bibliographyString + bibliographyEntry; }, '') + bibliographyObject[0].bibend; // Define styles based on bibliography const bibliographyStyles = ` `; const bibliography = html`

${bibliographyStyles}${bibliographyString}

`; notify(bibliography); } const observer = new MutationObserver(observed); observer.observe(document.body, { childList: true, subtree: true }); observed(); return () => { observer.disconnect() }; }); }; return cite; }