Restructure documents/ to subfolder-per-document format with book files
This commit is contained in:
parent
e6a0aaa9f1
commit
8a16015e0b
48
documents/README.md
Normal file
48
documents/README.md
Normal file
@ -0,0 +1,48 @@
|
||||
# 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
|
||||
}
|
||||
```
|
||||
Binary file not shown.
7
documents/arbeit/README.md
Normal file
7
documents/arbeit/README.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Document Role
|
||||
|
||||
This is a base reference book for this project.
|
||||
|
||||
# Clean up
|
||||
|
||||
This document should be kept indefinitely as a reference for the project.
|
||||
1820
documents/arbeit/arbeit.index.json
Normal file
1820
documents/arbeit/arbeit.index.json
Normal file
File diff suppressed because it is too large
Load Diff
3672
documents/arbeit/arbeit.md
Normal file
3672
documents/arbeit/arbeit.md
Normal file
File diff suppressed because one or more lines are too long
11
documents/arbeit/metadata.jsonc
Normal file
11
documents/arbeit/metadata.jsonc
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
// This file contains metadata used for rendering this document in the KPG app.
|
||||
"id": "arbeit",
|
||||
"title": "Kooperative Prozessgestaltung in der Sozialen Arbeit",
|
||||
"pdfPath": "PDF Hochuli-Freund_Kooperative-Prozessgestaltung in der Sozialen Arbeit.pdf",
|
||||
"markdownPath": "arbeit.md",
|
||||
"pageIndexPath": "arbeit.index.json",
|
||||
"pageCount": 386,
|
||||
"startPage": 0,
|
||||
"tocPageNumber": 10
|
||||
}
|
||||
@ -1,23 +0,0 @@
|
||||
{
|
||||
"books": [
|
||||
{
|
||||
"id": "praxis",
|
||||
"title": "Kooperative Prozessgestaltung in der Praxis",
|
||||
"pdfPath": ".mentor/books/PDF Buch_Kooperative-Prozessgestaltung in der praxis.pdf",
|
||||
"markdownPath": "docs/reference/PDF Buch_Kooperative-Prozessgestaltung in der praxis.md",
|
||||
"pageIndexPath": "tmp/praxis-pages.txt",
|
||||
"pageCount": 297,
|
||||
"startPage": 0
|
||||
},
|
||||
{
|
||||
"id": "arbeit",
|
||||
"title": "Kooperative Prozessgestaltung in der Sozialen Arbeit",
|
||||
"pdfPath": ".mentor/books/PDF Hochuli-Freund_Kooperative-Prozessgestaltung in der Sozialen Arbeit.pdf",
|
||||
"markdownPath": "docs/reference/PDF Hochuli-Freund_Kooperative-Prozessgestaltung in der Sozialen Arbeit.md",
|
||||
"pageIndexPath": "tmp/arbeit-pages.txt",
|
||||
"pageCount": 386,
|
||||
"startPage": 0,
|
||||
"tocPageNumber": 10
|
||||
}
|
||||
]
|
||||
}
|
||||
Binary file not shown.
7
documents/praxis/README.md
Normal file
7
documents/praxis/README.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Document Role
|
||||
|
||||
This is a base reference book for this project.
|
||||
|
||||
# Clean up
|
||||
|
||||
This document should be kept indefinitely as a reference for the project.
|
||||
10
documents/praxis/metadata.jsonc
Normal file
10
documents/praxis/metadata.jsonc
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
// 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
|
||||
}
|
||||
1425
documents/praxis/praxis.index.json
Normal file
1425
documents/praxis/praxis.index.json
Normal file
File diff suppressed because it is too large
Load Diff
4080
documents/praxis/praxis.md
Normal file
4080
documents/praxis/praxis.md
Normal file
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user