Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

process extra fields #3152

Closed
wants to merge 10 commits into from
Closed

process extra fields #3152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0862c2a
process extra fields
retorquere Sep 27, 2023
951023d
separate out field aliases
retorquere Sep 27, 2023
a6131b0
less code, more config
retorquere Oct 10, 2023
84046ea
more config, less code
retorquere Oct 10, 2023
050f09c
lint
retorquere Oct 10, 2023
3247209
use before declaration
retorquere Oct 11, 2023
52ff0ae
extra config in all-caps
retorquere Oct 12, 2023
8f2205c
doc
retorquere Oct 12, 2023
ace32be
rename
retorquere Oct 12, 2023
cb48b93
don't write migrated fields back into the note
retorquere Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
234 changes: 207 additions & 27 deletions BibLaTeX.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"exportFileData": false,
"useJournalAbbreviation": false
},
"lastUpdated": "2022-10-12 19:26:00"
"lastUpdated": "2023-10-17 15:35:00"
}

/*
Expand Down Expand Up @@ -78,12 +78,11 @@ var fieldMap = {
*/
// Exported in BibTeX and BibLaTeX
var revExtraIds = {
LCCN: 'lccn',
MR: 'mrnumber',
Zbl: 'zmnumber',
PMCID: 'pmcid',
PMID: 'pmid',
DOI: 'doi'
lccn: 'lccn',
mr: 'mrnumber',
zbl: 'zmnumber',
pmcid: 'pmcid',
pmid: 'pmid',
};

// Imported by BibTeX. Exported by BibLaTeX only
Expand All @@ -98,19 +97,205 @@ var revEprintIds = {
GoogleBooksID: 'googlebooks'
};

function parseExtraFields(extra) {
var lines = extra.split(/[\r\n]+/);
var fields = [];
for (var i = 0; i < lines.length; i++) {
var rec = { raw: lines[i] };
var line = lines[i].trim();
var splitAt = line.indexOf(':');
if (splitAt > 1) {
rec.field = line.substr(0, splitAt).trim();
rec.value = line.substr(splitAt + 1).trim();
}
fields.push(rec);
const EXTRA_FIELDS = { // fields picked up in structured key-value format in the same way as citeproc would
field: { // english-text label or CSL field => Zotero fields
'application number': ['applicationNumber'],
'archive id': ['archiveID'],
'loc in archive': ['archiveLocation'],
'artwork size': ['artworkSize'],
assignee: ['assignee'],
'file type': ['audioFileType'],
format: ['audioRecordingFormat', 'format', 'videoRecordingFormat'],
'bill number': ['billNumber'],
'blog title': ['blogTitle'],
'book title': ['bookTitle'],
'call number': ['callNumber'],
'case name': ['caseName'],
'citation key': ['citationKey'],
code: ['code'],
'code number': ['codeNumber'],
'code pages': ['codePages'],
'code volume': ['codeVolume'],
committee: ['committee'],
company: ['company'],
'conference name': ['conferenceName'],
country: ['country'],
court: ['court'],
date: ['date', 'dateDecided', 'dateEnacted', 'issueDate'],
'date added': ['dateAdded'],
'date decided': ['dateDecided'],
'date enacted': ['dateEnacted'],
modified: ['dateModified'],
'dictionary title': ['dictionaryTitle'],
distributor: ['distributor'],
'docket number': ['docketNumber'],
'document number': ['documentNumber'],
doi: ['DOI'],
'encyclopedia title': ['encyclopediaTitle'],
'episode number': ['episodeNumber'],
'filing date': ['filingDate'],
'first page': ['firstPage'],
'forumlistserv title': ['forumTitle'],
history: ['history'],
identifier: ['identifier'],
institution: ['institution'],
isbn: ['ISBN'],
issn: ['ISSN'],
'issue date': ['issueDate'],
'issuing authority': ['issuingAuthority'],
'item type': ['itemType'],
'journal abbr': ['journalAbbreviation'],
label: ['label'],
'legal status': ['legalStatus'],
'legislative body': ['legislativeBody'],
type: ['genre', 'letterType', 'manuscriptType', 'mapType', 'postType', 'presentationType', 'reportType', 'thesisType', 'type', 'websiteType'],
'library catalogue': ['libraryCatalog'],
'meeting name': ['meetingName'],
'name of act': ['nameOfAct'],
network: ['network'],
'nr of volumes': ['numberOfVolumes'],
'# of volumes': ['numberOfVolumes'],
'nr of pages': ['numPages'],
'# of pages': ['numPages'],
organization: ['organization'],
pages: ['codePages', 'firstPage', 'pages'],
'patent number': ['patentNumber'],
place: ['place', 'repositoryLocation'],
'post type': ['postType'],
'priority numbers': ['priorityNumbers'],
'proceedings title': ['proceedingsTitle'],
'prog language': ['programmingLanguage'],
'program title': ['programTitle'],
publication: ['blogTitle', 'bookTitle', 'dictionaryTitle', 'encyclopediaTitle', 'forumTitle', 'proceedingsTitle', 'programTitle', 'publicationTitle', 'websiteTitle'],
'public law number': ['publicLawNumber'],
reporter: ['reporter'],
'reporter volume': ['reporterVolume'],
'report number': ['reportNumber'],
'report type': ['reportType'],
repository: ['repository'],
'repo location': ['repositoryLocation'],
rights: ['rights'],
'running time': ['runningTime'],
series: ['series'],
'series number': ['seriesNumber'],
'series text': ['seriesText'],
'series title': ['seriesTitle'],
session: ['session'],
'short title': ['shortTitle'],
studio: ['studio'],
subject: ['subject'],
system: ['system'],
university: ['university'],
url: ['url'],
'website title': ['websiteTitle'],
'website type': ['websiteType'],
abstract: ['abstractNote'],
archive: ['archive'],
archivelocation: ['archiveLocation'],
authority: ['authority'],
'call-number': ['applicationNumber', 'callNumber'],
'chapter-number': ['session'],
'collection-number': ['seriesNumber'],
'collection-title': ['series', 'seriesTitle'],
'container-title': ['code', 'publicationTitle', 'reporter'],
dimensions: ['artworkSize', 'runningTime'],
edition: ['edition'],
'event-place': ['place'],
'event-title': ['conferenceName', 'meetingName'],
genre: ['programmingLanguage', 'type'],
issue: ['issue', 'priorityNumbers'],
journalabbreviation: ['journalAbbreviation'],
language: ['language'],
license: ['rights'],
medium: ['medium', 'system'],
number: ['number'],
'number-of-pages': ['numPages'],
'number-of-volumes': ['numberOfVolumes'],
page: ['pages'],
publisher: ['publisher'],
'publisher-place': ['place'],
references: ['history', 'references'],
scale: ['scale'],
section: ['committee', 'section'],
shorttitle: ['shortTitle'],
source: ['libraryCatalog'],
status: ['status'],
title: ['title'],
'title-short': ['shortTitle'],
version: ['versionNumber'],
volume: ['codeNumber', 'volume'],
accessed: ['accessDate'],
issued: ['date'],
submitted: ['filingDate']
},
creator: { // CSL creator => Zotero creator
author: 'author',
'container-author': 'bookAuthor',
performer: 'castMember',
composer: 'composer',
contributor: 'contributor',
director: 'director',
editor: 'editor',
guest: 'guest',
interviewer: 'interviewer',
producer: 'producer',
recipient: 'recipient',
'reviewed-author': 'reviewedAuthor',
'collection-editor': 'seriesEditor',
'script-writer': 'scriptwriter',
translator: 'translator'
}
};

/*
* this function parses structured key-value lines from the `extra` field as citeproc does, and
* stores them into the item as regular item fields. This way, the extra information present is
* taken into account when generating the biblatex output. The recognized fields are removed
* from the `extra` field in the process as their purpose is not general-purpose item notes.
*/
function parseAndConvertExtraFields(item) {
if (!item.extra) return null;

const fields = [];
item.extra = item.extra.split('\n').filter((line) => { // discard lines we're consuming into the object
const rec = { raw: line };
const kv = line.match(/^([^:]+)\s*:\s*(.+)/);
if (kv) {
const label = kv[1].toLowerCase();
const value = kv[2];
for (const field of (EXTRA_FIELDS.field[label] || [])) {
rec.field = label;
rec.value = value;
item[field] = item[field] || rec.value;
}

const creatorType = EXTRA_FIELDS.creator[label];
if (creatorType) {
rec.field = label;

const name = value.split('||').map(n => n.trim());
if (name.length === 2) {
item.creators.push(rec.value = { creatorType, firstName: name[1], lastName: name[0] });
}
else {
item.creators.push(rec.value = { creatorType, name: value });
}
}

if (revExtraIds[label]) {
rec.field = label;
rec.value = value;
}

if (rec.field) {
fields.push(rec);
return false;
}
}

return true;
}).join('\n');

return fields;
}

Expand Down Expand Up @@ -526,7 +711,7 @@ function doExport() {

if (!type) type = "misc";

var extraFields = item.extra ? parseExtraFields(item.extra) : null;
var extraFields = parseAndConvertExtraFields(item);
var citekey = buildCiteKey(item, extraFields, citekeys);

// write citation key (removed the comma)
Expand Down Expand Up @@ -805,8 +990,7 @@ function doExport() {
if (extraFields) {
// Export identifiers
// Dedicated fields
for (let i = 0; i < extraFields.length; i++) {
var rec = extraFields[i];
for (const rec of extraFields) {
if (!rec.field) continue;

if (!revExtraIds[rec.field] && !revEprintIds[rec.field]) continue;
Expand All @@ -825,13 +1009,9 @@ function doExport() {
writeField('eprint', '{' + value + '}', true);
}
}
extraFields.splice(i, 1);
i--;
}

var extra = extraFieldsToString(extraFields);
if (extra && !noteused) writeField("note", extra);
}
if (item.extra && !noteused) writeField("note", item.extra);

if (item.tags && item.tags.length) {
var tagString = "";
Expand Down
Loading
Loading