sslabdata 4.0.0__tar.gz → 5.0.0__tar.gz

{sslabdata-4.0.0/sslabdata.egg-info → sslabdata-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sslabdata
-Version: 4.0.0
+Version: 5.0.0
 Summary: Renderer-agnostic academic lab data assembler: BibTeX + YAML → structured data
 Author: Siddhartha Srinivasa
 License-Expression: MIT
@@ -255,6 +255,9 @@ author names to people:
   website: "https://example.org/people/bbrown"
   co_advisor: "Peggy Park"
   start_year: 2021
+  bio: |
+    Bob Brown is a PhD student advised by Alice Adams and Peggy Park.
+    He works on shared control for assistive robot arms.
 
 - id: "iingram"
   name: "Ivan Ingram"
@@ -271,6 +274,16 @@ author names to people:
 `id` and `name` are required. `role` is any non-empty string, so any lab's
 roles fit; `status` is `current` (the default) or `alumni`.
 
+`bio` is a short biography in plain text, not Markdown or HTML: it is
+emitted as written and a renderer escapes it. Line breaks are kept as YAML
+reads them, so a block scalar (`|`) keeps each line, and a renderer may treat
+a blank line as a paragraph break. A person without one gets `bio: null`; an
+empty string is emitted as written, as any other person field is. Keep the
+structured facts in their own fields: nothing reads `degree`, years or
+`current_position` out of a bio, so an alumni line such as "PhD 2022, now
+Research Scientist at Example Robotics" is for the renderer to build from
+those fields.
+
 ### External co-authors (optional, `data/collaborators.yaml`)
 
 A list of co-authors outside the lab whose spellings you want grouped
@@ -306,24 +319,26 @@ deciding which URLs are safe to render is the renderer's job.
 ### Checking inputs in an editor
 
 Each input file has a JSON Schema in
-[`schema/input/v1/`](https://github.com/siddhss5/sslabdata/tree/main/schema/input/v1):
+[`schema/input/v2/`](https://github.com/siddhss5/sslabdata/tree/main/schema/input/v2):
 `lab.schema.json`, `people.schema.json`, `projects.schema.json` and
 `collaborators.schema.json`. The wheel installs them under
-`sslabdata/schema/input/v1/`. An editor can use them to check and complete
+`sslabdata/schema/input/v2/`. An editor can use them to check and complete
 the files as you write; `--validate` stays the check, and also reports what
 a schema cannot see, such as a repeated id or a missing file. With the YAML
 language server (the VS Code YAML extension, among others), name the schema
 in a comment at the top of the file:
 
 ```yaml
-# yaml-language-server: $schema=https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v1/schema/input/v1/people.schema.json
+# yaml-language-server: $schema=https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v2/schema/input/v2/people.schema.json
 - id: "aadams"
   name: "Alice Adams"
   role: "professor"
 ```
 
-The URL is the schema's `$id`, served from the `input-schema-v1` tag, which is
+The URL is the schema's `$id`, served from the `input-schema-v2` tag, which is
 never moved ([`SPEC.md` §6](https://github.com/siddhss5/sslabdata/blob/main/SPEC.md#6-version-policy)).
+A file that names v1 still validates, because v1 allows keys it does not
+list, but only v2 checks and completes `bio`.
 Use `lab.schema.json`, `projects.schema.json` or `collaborators.schema.json`
 in the same way for the other files.
 

{sslabdata-4.0.0 → sslabdata-5.0.0}/README.md

@@ -218,6 +218,9 @@ author names to people:
   website: "https://example.org/people/bbrown"
   co_advisor: "Peggy Park"
   start_year: 2021
+  bio: |
+    Bob Brown is a PhD student advised by Alice Adams and Peggy Park.
+    He works on shared control for assistive robot arms.
 
 - id: "iingram"
   name: "Ivan Ingram"
@@ -234,6 +237,16 @@ author names to people:
 `id` and `name` are required. `role` is any non-empty string, so any lab's
 roles fit; `status` is `current` (the default) or `alumni`.
 
+`bio` is a short biography in plain text, not Markdown or HTML: it is
+emitted as written and a renderer escapes it. Line breaks are kept as YAML
+reads them, so a block scalar (`|`) keeps each line, and a renderer may treat
+a blank line as a paragraph break. A person without one gets `bio: null`; an
+empty string is emitted as written, as any other person field is. Keep the
+structured facts in their own fields: nothing reads `degree`, years or
+`current_position` out of a bio, so an alumni line such as "PhD 2022, now
+Research Scientist at Example Robotics" is for the renderer to build from
+those fields.
+
 ### External co-authors (optional, `data/collaborators.yaml`)
 
 A list of co-authors outside the lab whose spellings you want grouped
@@ -269,24 +282,26 @@ deciding which URLs are safe to render is the renderer's job.
 ### Checking inputs in an editor
 
 Each input file has a JSON Schema in
-[`schema/input/v1/`](https://github.com/siddhss5/sslabdata/tree/main/schema/input/v1):
+[`schema/input/v2/`](https://github.com/siddhss5/sslabdata/tree/main/schema/input/v2):
 `lab.schema.json`, `people.schema.json`, `projects.schema.json` and
 `collaborators.schema.json`. The wheel installs them under
-`sslabdata/schema/input/v1/`. An editor can use them to check and complete
+`sslabdata/schema/input/v2/`. An editor can use them to check and complete
 the files as you write; `--validate` stays the check, and also reports what
 a schema cannot see, such as a repeated id or a missing file. With the YAML
 language server (the VS Code YAML extension, among others), name the schema
 in a comment at the top of the file:
 
 ```yaml
-# yaml-language-server: $schema=https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v1/schema/input/v1/people.schema.json
+# yaml-language-server: $schema=https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v2/schema/input/v2/people.schema.json
 - id: "aadams"
   name: "Alice Adams"
   role: "professor"
 ```
 
-The URL is the schema's `$id`, served from the `input-schema-v1` tag, which is
+The URL is the schema's `$id`, served from the `input-schema-v2` tag, which is
 never moved ([`SPEC.md` §6](https://github.com/siddhss5/sslabdata/blob/main/SPEC.md#6-version-policy)).
+A file that names v1 still validates, because v1 allows keys it does not
+list, but only v2 checks and completes `bio`.
 Use `lab.schema.json`, `projects.schema.json` or `collaborators.schema.json`
 in the same way for the other files.
 

{sslabdata-4.0.0 → sslabdata-5.0.0}/SPEC.md

@@ -7,7 +7,7 @@ them.
 This file states the parts of that contract a JSON Schema cannot express:
 what the strings in the document are, what order the lists are in, what an
 absent key means, which fields are computed, when the version changes, and
-how a repeated `@string` macro resolves. `schema/v6/output.schema.json`
+how a repeated `@string` macro resolves. `schema/v7/output.schema.json`
 states the rest.
 
 Everything here is normative unless it carries a `Target` note. A `Target`
@@ -16,8 +16,8 @@ names the issue that will make it true. Until that issue lands, the rule is
 the intent and the note is the fact. What changed at each release, and what
 it replaced, is in [`CHANGELOG.md`](CHANGELOG.md), not here.
 
-- Applies to: `schema_version` 6 (`sslabdata.models.SCHEMA_VERSION`), package
-  version 4.0.0 (`sslabdata.__version__`).
+- Applies to: `schema_version` 7 (`sslabdata.models.SCHEMA_VERSION`), package
+  version 5.0.0 (`sslabdata.__version__`).
 
 ### How this file cites the code
 
@@ -25,7 +25,7 @@ Every rule below is grounded in a named part of the code rather than a line
 number, because line numbers rot silently: a function such as
 `sslabdata.parsers.bibtex.parse_all_works()`, a method such as
 `Person.to_dict()`, a module-level constant such as `TEXT_FIELDS`, a JSON
-Pointer into `schema/v6/output.schema.json` such as `/$defs/person/required`, or
+Pointer into `schema/v7/output.schema.json` such as `/$defs/person/required`, or
 a `tests/COVERAGE.md` row key such as `config.people_file.missing`. A bare
 statement is cited by its enclosing function.
 
@@ -275,7 +275,7 @@ Codes in use:
 | `PROJECTS-ID-DUPLICATE` | Two projects declare one `id`. Located at the second. Both are kept. A validation error. |
 | `PROJECTS-STATUS-INVALID` | A project's `status` is present and is not `active` or `completed`. A missing status reads as `active`, and so does one that is not a string. A warning. |
 | `RECORD-KEY-UNKNOWN` | A person, project or collaborator record holds a key sslabdata does not read (`sslabdata.loaders.PERSON_KEYS`, `PROJECT_KEYS`, `COLLABORATOR_KEYS`), such as `hobby` or a misspelt `webiste`. One code for all three files. Located at `<people_file>:<id>:<key>`, `<projects_file>:<id>:<key>` or `<collaborators_file>:<collaborator name>:<key>`, once per key. The key is ignored and never emitted; the record is kept. Only a record that is loaded is checked, so a record missing a required field reports that alone. A warning. |
-| `RECORD-TYPE-INVALID` | An optional field of a person, project or collaborator record has a value of the wrong type, other than the `role` and `status` that have codes of their own. A person's `photo`, `website`, `email`, `co_advisor`, `degree`, `thesis_title` and `current_position`, and a project's `description`, `website` and `image`, are strings; a person's `start_year` and `end_year` are integers, not booleans; a person's or collaborator's `aliases` is a list of non-empty strings. One code for all three files, located at `<file>:<id>:<field>` (a collaborator's name for its id). The value is read as empty, so it is emitted as `null`, and a wrong `aliases` declares none; the record is kept. Only a record that is loaded is checked. A warning. |
+| `RECORD-TYPE-INVALID` | An optional field of a person, project or collaborator record has a value of the wrong type, other than the `role` and `status` that have codes of their own. A person's `photo`, `website`, `email`, `co_advisor`, `degree`, `thesis_title`, `current_position` and `bio`, and a project's `description`, `website` and `image`, are strings; a person's `start_year` and `end_year` are integers, not booleans; a person's or collaborator's `aliases` is a list of non-empty strings. One code for all three files, located at `<file>:<id>:<field>` (a collaborator's name for its id). The value is read as empty, so it is emitted as `null`, and a wrong `aliases` declares none; the record is kept. Only a record that is loaded is checked. A warning. |
 | `RECORD-KEY-REPEATED` | A key is given twice in one mapping of a people, projects or collaborators file, which YAML alone would read as its last value, silently dropping the first. Every YAML file sslabdata reads is read with one loader that finds these (`sslabdata.config.YAMLLoader`). Keys are compared as YAML reads them, so `1` and `0x1` are one key. A merge key (`<<`) is not a repeat: the keys it merges in are overridden by the mapping's own, as YAML merge keys are defined. One code for all three files. Located at `<file>:<id>:<key>` (a collaborator's name for its id), with the path below the record's top level joined by `.` and a list member's index in brackets; the record is named by nothing when the repeated key is its `id` (a collaborator's `name`), and a repeat outside any record is located at `<file>::<path>`. The prose names the key and both lines. Every repeat is reported; the record is not loaded, and the run is fatal, as for a missing field: which value was meant is not sslabdata's to guess. |
 | `CONFIG-NOT-A-MAPPING` | `lab.yaml` is not a mapping of keys, or is empty. Fatal at load. |
 | `CONFIG-KEY-MISSING` | A required key is absent: `bib_dir`, or the `name` or `category` of a `bib_files` entry (`lab.yaml:bib_files:name`). Fatal at load. |
@@ -541,10 +541,20 @@ converts nor checks them:
 - **The person and project strings supplied in YAML.**
   `sslabdata.loaders.load_people()` and `load_projects()` perform no conversion
   of any kind — they check the types of a record's fields, a person's `role` and that a
-  `status` is one they know, but emit every string as written — so a person's `name`, `role`, `current_position` or
-  `thesis_title`, and a project's `title` or `description`, are copied
+  `status` is one they know, but emit every string as written — so a person's `name`, `role`, `current_position`,
+  `thesis_title` or `bio`, and a project's `title` or `description`, are copied
   straight from `people.yaml` and `projects.yaml`. Not every YAML string is
   emitted — `aliases` and the configuration paths are not; see heading 3.
+  "As written" is the string YAML reads, after control characters are
+  removed and NFC is applied as for every input string (above), and nothing
+  else: an empty or whitespace-only string is emitted as such, not as
+  `null`, and line breaks are kept. That matters most for a person's `bio`,
+  the one of these meant to run over several lines: a literal block scalar
+  (`|`) keeps each line break and the final one, a folded one (`>`) joins
+  lines with a space and keeps a blank line as a line break, and `\n` in a
+  double-quoted string is a line break. It is plain text like the rest — not
+  Markdown and not HTML — and a renderer escapes it, and may read a blank
+  line as a paragraph break.
 - **`work.category`**, which comes from the `category` of the `bib_files`
   entry in `lab.yaml`, not from the `.bib` file
   (`sslabdata.config.LabDataConfig.from_yaml()`, then
@@ -805,7 +815,7 @@ sslabdata's own output as input, and a wrong derivation becomes permanent.
 | `author.resolution` | **Derived** — `status` over `resolved`, `unresolved` and `ambiguous`, and `method` `exact`, or `null` when nothing matched (`resolve_authors()`). Both are open strings; `fuzzy` is never emitted. |
 | `author.equal_contribution` | **Derived** — whether the entry wrote a `*` marker on any part of the name (`sslabdata.parsers.bibtex.marks_equal_contribution()`). |
 | `work.editors[*]` | The same, minus `collaborator_key` and `equal_contribution`. An editor that matched nobody is simply `person_id: null` (`parse_editor_list()`). |
-| `person.*` except the two below | Input — the fields of `people_file` (`sslabdata.loaders.load_people()`). `aliases` is read for matching and is **not** emitted. `status` is `current` or `alumni`, and `current` when absent; `role` is open, any non-empty string (`PEOPLE-STATUS-INVALID`, `PEOPLE-ROLE-INVALID`). |
+| `person.*` except the two below | Input — the fields of `people_file` (`sslabdata.loaders.load_people()`). `aliases` is read for matching and is **not** emitted. `status` is `current` or `alumni`, and `current` when absent; `role` is open, any non-empty string (`PEOPLE-STATUS-INVALID`, `PEOPLE-ROLE-INVALID`). `bio` is a short biography in plain text with its line breaks as written (§2), and `null` when absent; it is carried and never read: nothing in the document is derived from it, and no `degree`, year or `current_position` is read out of one. |
 | `person.work_ids` | **Derived** — back-links over authorships (`sslabdata.resolver.compute_backlinks()`). Editors are not authorships and are not listed. |
 | `project.id`, `title`, `description`, `website`, `image`, `status` | Input — the fields of `projects_file` (`sslabdata.loaders.load_projects()`). `status` is one of `active` and `completed`, and `active` when absent (`PROJECTS-STATUS-INVALID`). `image` is a URL or a site path, the same kind of value as a person's `photo`, carried as plain text: deciding which URLs are safe to render is the renderer's job. |
 | `project.work_ids`, `people_ids` | **Derived** — back-links, and the people reached through them (`compute_backlinks()`). |
@@ -1120,14 +1130,14 @@ meaning and guarantees, and each of them is a bump.
 has been published is never edited. Version `N`'s schema stays reachable, byte
 for byte, at its own path after version `N+1` ships, so a consumer pinned to
 `N` keeps a stable target. `schema/v3/output.schema.json`,
-`schema/v4/output.schema.json`, `schema/v5/output.schema.json` and
-`schema/v6/output.schema.json` are those paths, and `tests/COVERAGE.md` row
-`output.versioned_schema` asserts that the older three are unchanged byte for
-byte and still say `3`, `4` and `5`.
-
-**The `$id` is a pinned tag URL.** v6's `$id` is
-`https://raw.githubusercontent.com/siddhss5/sslabdata/schema-v6/schema/v6/output.schema.json`.
-The rule that makes it a contract rather than a guess: **the `schema-v6` tag
+`schema/v4/output.schema.json`, `schema/v5/output.schema.json`,
+`schema/v6/output.schema.json` and `schema/v7/output.schema.json` are those
+paths, and `tests/COVERAGE.md` row `output.versioned_schema` asserts that the
+older four are unchanged byte for byte and still say `3`, `4`, `5` and `6`.
+
+**The `$id` is a pinned tag URL.** v7's `$id` is
+`https://raw.githubusercontent.com/siddhss5/sslabdata/schema-v7/schema/v7/output.schema.json`.
+The rule that makes it a contract rather than a guess: **the `schema-v7` tag
 is created when this version ships and is never moved.** A branch URL such as
 `blob/main` is not usable — it serves an HTML page rather than the schema, so
 no consumer can ever have resolved v3's `$id` — and this repository publishes
@@ -1142,11 +1152,11 @@ rule.
 descriptions inside those files, name the repository `labdata`, and the files
 are left byte for byte as published rather than rewritten. v4's raw `$id`
 resolves, because GitHub redirects `labdata` to `sslabdata`. v3's `blob/main`
-`$id` does not resolve, as above. The `$id`s, titles and descriptions of v5
-and v6 say `sslabdata`.
+`$id` does not resolve, as above. The `$id`s, titles and descriptions of v5,
+v6 and v7 say `sslabdata`.
 
 **The input schemas are versioned apart from the document.**
-`schema/input/v1/` holds a JSON Schema for each input file: `lab.schema.json`,
+`schema/input/v2/` holds a JSON Schema for each input file: `lab.schema.json`,
 `people.schema.json`, `projects.schema.json` and `collaborators.schema.json`.
 They describe what the loaders accept; the loaders stay the authority, and
 the diagnostic codes above report what a schema cannot see. The input format
@@ -1154,9 +1164,13 @@ and the document change for different reasons, so the input schemas carry
 their own version rather than `schema_version`. They follow the same rules:
 a published input schema is never edited, any change to one is a new
 version at a new path, and its `$id` is a pinned tag URL,
-`https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v1/schema/input/v1/<file>.schema.json`,
-whose `input-schema-v1` tag is created when this version ships and is never
-moved.
+`https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v2/schema/input/v2/<file>.schema.json`,
+whose `input-schema-v2` tag is created when this version ships and is never
+moved. A version holds all four files, so a change to one of them versions
+the set: v2 adds a person's `bio` to `people.schema.json`, and its other three
+files differ from v1's only in the tag their `$id`s and descriptions name. `schema/input/v1/`, served
+from the `input-schema-v1` tag, stays byte for byte as published; the wheel
+installs only the current version.
 
 **Version history.** What each `schema_version` changed is in
 [`CHANGELOG.md`](CHANGELOG.md).
@@ -1256,6 +1270,24 @@ So each rejected type is rejected for a stated reason, and each has a home:
 | Alumni | Not a collection — a `status` on a person (`sslabdata.models.Person.status`). |
 | Robots, platforms, facilities | Your site repository; one of 27 surveyed sites had such a page. |
 
+**An attribute of an entity the document already has is not an entity.**
+The evidence above, and the question #60 asks of a candidate — would
+sslabdata do anything with it beyond carrying it — decide which *entities*
+the document has: collections with records of their own, ids, references
+and an order, each of which the compiler has to check and a renderer has to
+understand. A field
+on a person, work or project raises none of that. Its owner is already
+admitted, the field has one value of one type, and the only work it asks
+for is what every input string gets: control characters removed, NFC and
+the text rule (§2). A person already carries attributes sslabdata does
+nothing else with — `photo`, `website`, `thesis_title`, `current_position` —
+and a person's `bio` is one more. Such a field is judged on two questions
+instead: does it belong to that entity rather than to a page of the site,
+and is it the only place the fact can live, so that it does not copy a
+structured field into text that will drift from it. A bio passes both; an
+alumni line such as "PhD 2012, now at Example Robotics" fails the second,
+because `degree`, `end_year` and `current_position` already hold it.
+
 **There is no generic extension mechanism and no `collections` escape hatch.**
 What one would carry is mostly prose, and its one real service — catching
 references that point at nothing — is delivered by #58 without the document
@@ -1267,7 +1299,7 @@ vocabularies, not over arbitrary content.
 
 ## 9. What this file is not
 
-It does not list the document's fields; `schema/v6/output.schema.json` does.
+It does not list the document's fields; `schema/v7/output.schema.json` does.
 It does not describe renderers such as
 [sslabdata-site](https://github.com/siddhss5/sslabdata-site), which are
 downstream consumers in their own repositories. It does not describe the input formats `lab.yaml`,

{sslabdata-4.0.0 → sslabdata-5.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sslabdata"
-version = "4.0.0"
+version = "5.0.0"
 description = "Renderer-agnostic academic lab data assembler: BibTeX + YAML → structured data"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -58,8 +58,8 @@ requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"
 
 # The current output schema and input schemas are public wheel data, installed
-# at sslabdata/schema/v6/output.schema.json and
-# sslabdata/schema/input/v1/*.schema.json. The package directory is mapped onto
+# at sslabdata/schema/v7/output.schema.json and
+# sslabdata/schema/input/v2/*.schema.json. The package directory is mapped onto
 # the repository's schema/ directory so each frozen file has one copy and one
 # path; earlier versions stay in the sdist only. schema/__init__.py makes the
 # mapped directory a regular package, which editable installs need to resolve.
@@ -71,7 +71,7 @@ packages = ["sslabdata", "sslabdata.parsers", "sslabdata.schema"]
 "sslabdata.schema" = "schema"
 
 [tool.setuptools.package-data]
-"sslabdata.schema" = ["v6/output.schema.json", "input/v1/*.schema.json"]
+"sslabdata.schema" = ["v7/output.schema.json", "input/v2/*.schema.json"]
 # The starting point `sslabdata init` copies.
 "sslabdata" = ["templates/init/*.yaml", "templates/init/bib/*.bib"]
 

sslabdata-5.0.0/schema/input/v2/collaborators.schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v2/schema/input/v2/collaborators.schema.json",
+  "title": "sslabdata collaborators file",
+  "description": "The file lab.yaml names as collaborators_file: co-authors outside the lab whose spellings are grouped together, one record each. A record never makes anyone a lab member. It describes what sslabdata's loader accepts; the loader stays the authority, and reports each problem under a code in SPEC.md, Diagnostic codes. A record key not listed here is reported as RECORD-KEY-UNKNOWN and ignored, so it is allowed. Published input schemas are immutable: this one is served from the input-schema-v2 tag, which is created when this version ships and is never moved (SPEC.md §6).",
+  "type": ["array", "null"],
+  "items": { "$ref": "#/$defs/collaborator" },
+  "$defs": {
+    "nonEmptyString": { "type": "string", "pattern": "\\S" },
+    "collaborator": {
+      "type": "object",
+      "required": ["name"],
+      "additionalProperties": true,
+      "properties": {
+        "name": { "$ref": "#/$defs/nonEmptyString" },
+        "aliases": {
+          "description": "Other spellings of the name, grouped with it.",
+          "type": ["array", "null"],
+          "items": { "$ref": "#/$defs/nonEmptyString" }
+        }
+      }
+    }
+  }
+}

sslabdata-5.0.0/schema/input/v2/lab.schema.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v2/schema/input/v2/lab.schema.json",
+  "title": "sslabdata lab.yaml",
+  "description": "The configuration file sslabdata is run with (--config). It describes what sslabdata's loader accepts; the loader stays the authority, and reports each problem under a code in SPEC.md, Diagnostic codes. A key not listed here is reported as CONFIG-KEY-UNKNOWN and ignored, so it is allowed. Published input schemas are immutable: this one is served from the input-schema-v2 tag, which is created when this version ships and is never moved (SPEC.md §6).",
+  "type": "object",
+  "required": ["bib_dir"],
+  "additionalProperties": true,
+  "properties": {
+    "lab": {
+      "description": "The lab header, copied into the document's lab unchanged (SPEC.md §5). The keys below are typed; any other key is allowed and copied through. sslabdata warns when it declares no name (CONFIG-LAB-NAME-MISSING).",
+      "type": ["object", "null"],
+      "additionalProperties": true,
+      "properties": {
+        "name": { "type": "string" },
+        "description": { "type": "string" },
+        "institution": { "type": "string" },
+        "department": { "type": "string" },
+        "website": { "type": "string" },
+        "email": { "type": "string" },
+        "address": { "type": "string" },
+        "logo": { "type": "string" },
+        "links": { "type": "object" }
+      }
+    },
+    "site": {
+      "description": "Read by renderers, not by sslabdata, and accepted without being checked."
+    },
+    "bib_dir": {
+      "description": "The directory the bib_files names are under, relative to the directory sslabdata is run from.",
+      "type": "string"
+    },
+    "bib_files": {
+      "description": "The .bib files to read. sslabdata warns when there are none (CONFIG-BIB-FILES-MISSING).",
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "required": ["name", "category"],
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "description": "A name under bib_dir, emitted as work.source.file: never absolute, and never leaving bib_dir (SPEC.md §5).",
+            "type": "string"
+          },
+          "category": {
+            "description": "Emitted as the category of every work in this file.",
+            "type": "string"
+          }
+        }
+      }
+    },
+    "pdf_base_url": {
+      "description": "A work with no pdf field gets this URL plus its citation key as its pdf link. Leave it out to guess no pdf links; an empty or blank value is an error.",
+      "type": ["string", "null"],
+      "minLength": 1,
+      "pattern": "\\S"
+    },
+    "people_file": {
+      "description": "The people file (people.schema.json), relative to the directory sslabdata is run from.",
+      "type": ["string", "null"]
+    },
+    "projects_file": {
+      "description": "The projects file (projects.schema.json), relative to the directory sslabdata is run from.",
+      "type": ["string", "null"]
+    },
+    "collaborators_file": {
+      "description": "The external co-authors file (collaborators.schema.json), relative to the directory sslabdata is run from.",
+      "type": ["string", "null"]
+    }
+  }
+}

sslabdata-5.0.0/schema/input/v2/people.schema.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v2/schema/input/v2/people.schema.json",
+  "title": "sslabdata people file",
+  "description": "The file lab.yaml names as people_file: a list of lab members and alumni, one record each. It describes what sslabdata's loader accepts; the loader stays the authority, and reports each problem under a code in SPEC.md, Diagnostic codes. A record key not listed here is reported as RECORD-KEY-UNKNOWN and ignored, so it is allowed. What each field becomes in the document is in SPEC.md §5. Published input schemas are immutable: this one is served from the input-schema-v2 tag, which is created when this version ships and is never moved (SPEC.md §6).",
+  "type": ["array", "null"],
+  "items": { "$ref": "#/$defs/person" },
+  "$defs": {
+    "nonEmptyString": { "type": "string", "pattern": "\\S" },
+    "optionalString": { "type": ["string", "null"] },
+    "optionalYear": { "type": ["integer", "null"] },
+    "person": {
+      "type": "object",
+      "required": ["id", "name", "role"],
+      "additionalProperties": true,
+      "properties": {
+        "id": {
+          "description": "The person's id, unique in the file (PEOPLE-ID-DUPLICATE).",
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "name": { "$ref": "#/$defs/nonEmptyString" },
+        "aliases": {
+          "description": "Other spellings of the name, used to match BibTeX authors and never emitted.",
+          "type": ["array", "null"],
+          "items": { "$ref": "#/$defs/nonEmptyString" }
+        },
+        "role": {
+          "description": "Any non-empty string; there is no list of roles (PEOPLE-ROLE-INVALID).",
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "status": {
+          "description": "current when absent (PEOPLE-STATUS-INVALID).",
+          "enum": ["current", "alumni"]
+        },
+        "photo": { "$ref": "#/$defs/optionalString" },
+        "website": { "$ref": "#/$defs/optionalString" },
+        "email": { "$ref": "#/$defs/optionalString" },
+        "co_advisor": { "$ref": "#/$defs/optionalString" },
+        "start_year": { "$ref": "#/$defs/optionalYear" },
+        "end_year": { "$ref": "#/$defs/optionalYear" },
+        "degree": { "$ref": "#/$defs/optionalString" },
+        "thesis_title": { "$ref": "#/$defs/optionalString" },
+        "current_position": { "$ref": "#/$defs/optionalString" },
+        "bio": {
+          "description": "A short biography, as plain text: not Markdown or HTML. Line breaks are kept as written (SPEC.md §2).",
+          "$ref": "#/$defs/optionalString"
+        }
+      }
+    }
+  }
+}

sslabdata-5.0.0/schema/input/v2/projects.schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/siddhss5/sslabdata/input-schema-v2/schema/input/v2/projects.schema.json",
+  "title": "sslabdata projects file",
+  "description": "The file lab.yaml names as projects_file: a list of research projects, one record each. It describes what sslabdata's loader accepts; the loader stays the authority, and reports each problem under a code in SPEC.md, Diagnostic codes. A record key not listed here is reported as RECORD-KEY-UNKNOWN and ignored, so it is allowed. What each field becomes in the document is in SPEC.md §5. Published input schemas are immutable: this one is served from the input-schema-v2 tag, which is created when this version ships and is never moved (SPEC.md §6).",
+  "type": ["array", "null"],
+  "items": { "$ref": "#/$defs/project" },
+  "$defs": {
+    "nonEmptyString": { "type": "string", "pattern": "\\S" },
+    "optionalString": { "type": ["string", "null"] },
+    "project": {
+      "type": "object",
+      "required": ["id", "title"],
+      "additionalProperties": true,
+      "properties": {
+        "id": {
+          "description": "The project's id, unique in the file (PROJECTS-ID-DUPLICATE). A work's project field names it.",
+          "$ref": "#/$defs/nonEmptyString"
+        },
+        "title": { "$ref": "#/$defs/nonEmptyString" },
+        "description": { "$ref": "#/$defs/optionalString" },
+        "website": { "$ref": "#/$defs/optionalString" },
+        "image": {
+          "description": "A URL or a site path, carried as plain text.",
+          "$ref": "#/$defs/optionalString"
+        },
+        "status": {
+          "description": "active when absent (PROJECTS-STATUS-INVALID).",
+          "enum": ["active", "completed"]
+        }
+      }
+    }
+  }
+}