| 1 | = How to publish my results |
| 2 | |
| 3 | If your research in the NLP Centre yields results that can be included in the infrastructure, we encourage you to add them to the [https://lindat.mff.cuni.cz/repository/xmlui/?locale-attribute=en Lindat repository]. |
| 4 | |
| 5 | == Adding the result to the infrastructure |
| 6 | |
| 7 | When making a deposit into the infrastructure, the recommended information to include is: |
| 8 | - **description**: include the related publication + information how to cite it (the citation + the data in Bib(La)TeX format |
| 9 | - **licence**: you can use the NLP [https://nlp.fi.muni.cz/cs/LicenceWebService web service] or [https://nlp.fi.muni.cz/cs/LicenceWebCorpus corpus licence] |
| 10 | - **affiliation**: mark the relation to the NLP Centre (include the NLP Centre as the Publisher in the LINDAT repository) |
| 11 | - **archive** should contain 1) README file including the instructions, brief description, and information on how to cite the result (related paper); 2) .bib file of the related publication; 3) optionally, you can add a pdf of the related publication |
| 12 | |
| 13 | When developing a new version of your result that is already included in the repository, update the information there as well (add a new version). |
| 14 | |
| 15 | == FAIR Data |
| 16 | |
| 17 | Whenever possible, make your data follow the FAIR principles. The research infrastructure supports you in making so. |
| 18 | |
| 19 | - **F**indable: while LINDAT supports search, it is great if you can provide rich and explicit metadata |
| 20 | - **A**ccessible: use open protocols whenever possible, use authentication whenever needed |
| 21 | - **I**nteroperable: prefer well-established metadata vocabularies whenever possible (e.g., Dublin Core for document description), provide links to other data if applicable (e.g. !WikiData) |
| 22 | - **R**eusable: use community standards (e.g. !GitLab, !PapersWithCode), publish licences |
| 23 | |
| 24 | Find more on FAIR principles: https://www.go-fair.org/fair-principles/ |
| 25 | |
| 26 | == Webpage on nlp.fi.muni.cz/projects |
| 27 | |
| 28 | This section includes information on the recommended webpage content of a result published in the repository. It should include: |
| 29 | |
| 30 | - **description**: a brief introduction and the related publication |
| 31 | - **the tool/service**: is it a demo, API, or command-line tool? How to use it? |
| 32 | - **acknowledgments**: related projects, how to cite, link to the repository |
| 33 | - **licence** |
| 34 | |
| 35 | == Example |
| 36 | |
| 37 | A practical example can be found at [https://nlp.fi.muni.cz/trac/research/wiki/Lindat/CzAccent czaccent]. |