corpus form help #1818
corpus form help #1818
Conversation
update documentation
There was a problem hiding this comment.
I wasn't sure how elaborate this should be.
The full specification (at the bottom) is necessary so users can troubleshoot their data. But after I wrote that section, I thought it made the process sound more intimidating than it is. Most of those requirements are just what the export software will do by default. So that's why I also added a basic explanation for Excel and Python.
| <i>Advanced usage:</i> | ||
| If you want to write or edit the JSON file for a corpus directly, you can | ||
| consult the | ||
| <a href="/api/corpus/definition-schema">specification</a>. | ||
| This is encoded as a | ||
| as a <a href="https://json-schema.org/">JSON schema</a>. |
There was a problem hiding this comment.
This is really quite advanced. Maybe save it for the manual?
frontend/src/app/corpus-definitions/definitions-overview/definitions-overview.component.html
Show resolved
Hide resolved
frontend/src/app/corpus-definitions/definitions-overview/definitions-overview.component.ts
Show resolved
Hide resolved
frontend/src/app/corpus-definitions/definitions-overview/definitions-overview.component.ts
Show resolved
Hide resolved
| title: string; | ||
| id: string; | ||
| } | ||
|
|
||
| export interface ManualSection { | ||
| title: string; | ||
| pages: ManualSection[]; | ||
| permissions?: 'canEditCorpus'[] |
There was a problem hiding this comment.
What does this type signify? 0-n repetitions of 'canEditCorpus' ?
There was a problem hiding this comment.
For some reason, I wrote this so it could be expanded with other permissions. So you might add other options to this list, e.g. ('canEditCorpus' | 'isAuthenticated')[]. Could also type this string[] to get the same idea.
But in practice, this is either undefined or ['canEditCorpus']
Adds explanatory text and some manual pages for the corpus form.
The manual pages are hidden if the user does not have access to this feature, mainly to avoid confusion while this is still in development.
Also adds page titles, and a confirm modal when deleting a corpus.