Adding the 2026 guidance document
This commit is contained in:
parent
17be769e3d
commit
8717988e80
Binary file not shown.
@ -1,48 +0,0 @@
|
|||||||
# Documents
|
|
||||||
|
|
||||||
This directory contains documents related to the project. This document serves as an index and overview of the contents.
|
|
||||||
|
|
||||||
Documents should be added into the collection in subdirectories. Each document should contain a README.md file with the following structure:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
# Document Role
|
|
||||||
|
|
||||||
Describe the role of this document in the project. For example, is it a reference book, a case study, a methodological guide, etc.?
|
|
||||||
|
|
||||||
# Clean up
|
|
||||||
|
|
||||||
Describe the conditions under which this document can be removed from the collection. For example, if it is a reference book, it might be kept indefinitely, while a case study might be removed after the project is completed.
|
|
||||||
```
|
|
||||||
|
|
||||||
# Document Metadata
|
|
||||||
|
|
||||||
Each folder contains a `metadata.jsonc` file that provides metadata for the document. This metadata is used for rendering the document in the KPG app. The structure of the metadata file is as follows:
|
|
||||||
|
|
||||||
```jsonc
|
|
||||||
{
|
|
||||||
"id": "unique-document-id",
|
|
||||||
"title": "Document Title", // The title of the document to be displayed in the app
|
|
||||||
"pdfPath": "path/to/document.pdf", // The relative path to the original PDF document
|
|
||||||
"markdownPath": "path/to/document.md", // The relative path to the markdown transcription of the PDF
|
|
||||||
"pageIndexPath": "path/to/pageIndex.json", // The relative path to the page index file
|
|
||||||
"iconPath": "path/to/icon.png", // (Optional) The relative path to an icon representing the document
|
|
||||||
"pageCount": totalNumberOfPages, // The total number of pages in the original PDF document
|
|
||||||
"startPage": 0 // Whether we start the numbering with page 0 (cover page) or page 1 - essentially, whether the page has a non-numbered cover page or not.
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Note:** All paths are relative to the location of the `metadata.jsonc` file.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```jsonc
|
|
||||||
{
|
|
||||||
// This file contains metadata used for rendering this document in the KPG app.
|
|
||||||
"id": "praxis",
|
|
||||||
"title": "Kooperative Prozessgestaltung in der Praxis",
|
|
||||||
"pdfPath": "PDF Buch_Kooperative-Prozessgestaltung in der praxis.pdf",
|
|
||||||
"markdownPath": "PDF Buch_Kooperative-Prozessgestaltung in der praxis.md",
|
|
||||||
"pageIndexPath": "praxis.index.json",
|
|
||||||
"pageCount": 297,
|
|
||||||
"startPage": 0
|
|
||||||
}
|
|
||||||
```
|
|
||||||
Loading…
Reference in New Issue
Block a user