Files
eXParser-PLD/docs/user-manual_main.adoc

41 lines
1.9 KiB
Plaintext

= {software-name} User Manual: eLabFTW to NeXus Parser for PLD Fabrications
:author: Emanuele D'Amico
:description: eLabFTW to NeXus Parser for PLD Fabrications
:doctype: book
:email: emanuele+expars@damico.ing
:imagesdir: images
:keywords: nffa-di, elabftw, nexus, parser, data science, mdmc, naples, cnr-spin, cnr, spin institute, python, hdf5, cli
:revdate: 2026-05-14
:revnumber: v0.2.1
:revremark: alpha untested
:stem: latexmath
:toc:
// custom attributes
:disclamer: I'm in no position to give anyone coding/development/programming/testing tips. The only tips I can give you are based on my personal knowledge of this specific project.
:software-family: eXPars
:software-name: {software-family}-PLD
:repo-url: https://gitea.damico.ing/emanuele/eXParser-PLD
:repo-ssh: ssh://git@gitea.damico.ing/emanuele/eXParser-PLD.git
:elabftw-apikey-docs: https://doc.elabftw.net/docs/usage/api/#generating-a-key
:elabftw-site: https://elabftw.net
:nffa-di-site: https://nffa-di.it/en/about-us/project/
:nffa-di-rdp: https://nffa-di.it/it/research-data-policy/#3.1
:nffa-di-uo-acronyms: https://nffa-di.it/en/uo-acronyms-for-data-infrastructure-naming-convention
:go-fair-site: https://www.go-fair.org/fair-principles/
:fairmat-site: https://www.fairmat-nfdi.eu/fairmat/about-fairmat/consortium-fairmat#mission
:keepass-site: https://keepassxc.org/
:bitwarden-site: https://bitwarden.com/
:ncnr-viewer: https://ncnr.nist.gov/ncnrdata/view/nexus-hdf-viewer.html
:hdf5-viewer: https://myhdf5.hdfgroup.org/
include::user-manual_01.adoc[]
include::user-manual_02.adoc[]
//include::user-manual_03.adoc[]
///////////////////////////////////////////////////////////////////////////
// Look out for "method-specific" comments I've left before sections
// containing information about one method in particulare (e.g. PLD fab.)
// because that needs to be edited when writing the user manuals of other
// eXParser's