SyllabusDocument

Defined in: api.ts:76

Full in-memory syllabus document (classes, items, orders, item index).

Extends

• CollectionSyllabusDocument

Properties

description?

optional description?: string | null;

Defined in: utils/schemas.ts:394

Inherited from

CollectionSyllabusDocument.description

---

institution?

optional institution?: string | null;

Defined in: utils/schemas.ts:395

Inherited from

CollectionSyllabusDocument.institution

---

courseCode?

optional courseCode?: string | null;

Defined in: utils/schemas.ts:396

Inherited from

CollectionSyllabusDocument.courseCode

---

nomenclature?

optional nomenclature?: string;

Defined in: utils/schemas.ts:398

Inherited from

CollectionSyllabusDocument.nomenclature

---

priorities

priorities: object[];

Defined in: utils/schemas.ts:399

id

id: string;

name

name: string;

color?

optional color?: string | null;

order

order: number;

Inherited from

CollectionSyllabusDocument.priorities

---

locked?

optional locked?: boolean | null;

Defined in: utils/schemas.ts:400

Inherited from

CollectionSyllabusDocument.locked

---

links?

optional links?: string[];

Defined in: utils/schemas.ts:401

Inherited from

CollectionSyllabusDocument.links

---

cslStyle?

optional cslStyle?: string | null;

Defined in: utils/schemas.ts:402

Inherited from

CollectionSyllabusDocument.cslStyle

---

createSubcollections?

optional createSubcollections?: boolean;

Defined in: utils/schemas.ts:404

When true, class folders are created and deleted. Missing means off.

Inherited from

CollectionSyllabusDocument.createSubcollections

---

version

version: 2;

Defined in: utils/schemas.ts:447

Inherited from

CollectionSyllabusDocument.version

---

classes

classes: Record<string, {
  title?: string | null;
  description?: string | null;
  itemOrder?: string[];
  readingDate?: string | null;
  status?: "done" | null;
  number?: number;
  subcollectionKey?: string;
}>;

Defined in: utils/schemas.ts:450

Inherited from

CollectionSyllabusDocument.classes

---

classOrder?

optional classOrder?: string[];

Defined in: utils/schemas.ts:451

Inherited from

CollectionSyllabusDocument.classOrder

---

furtherReadingOrder?

optional furtherReadingOrder?: string[];

Defined in: utils/schemas.ts:453

Manual display order for further readings (Zotero item.keys).

Inherited from

CollectionSyllabusDocument.furtherReadingOrder

---

unnumberedOrder?

optional unnumberedOrder?: string[];

Defined in: utils/schemas.ts:462

Manual display order for unnumbered (no-class) assignments — typically Course Information and other priority’d items without a class number. Values are assignment IDs (same as class itemOrder).

Inherited from

CollectionSyllabusDocument.unnumberedOrder

---

items

items: Record<string, object[]>;

Defined in: utils/schemas.ts:466

Inherited from

CollectionSyllabusDocument.items

---

itemIndex?

optional itemIndex?: Record<string, {
  title?: string;
  doi?: string | null;
  isbn?: string | null;
  pmid?: string | null;
  pmcid?: string | null;
  arxiv?: string | null;
  exportId?: string | null;
}>;

Defined in: utils/schemas.ts:469

Inherited from

CollectionSyllabusDocument.itemIndex