diff --git a/Makefile b/Makefile deleted file mode 100644 index 56241b6..0000000 --- a/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXPROJ = Contesetlgendesvol1 -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/README.dbk b/README.dbk new file mode 100644 index 0000000..e1b9e9b --- /dev/null +++ b/README.dbk @@ -0,0 +1,17 @@ + + +
+ + Nerv Tales Network Documentation + + + XMPP client and server, authoring tool, library, accessibility, + adaptation, copyright exemption, risk, pdca, documents and + accounting management system. + + + Documentation only + +
diff --git a/README.rst b/README.rst deleted file mode 100644 index 5aa5d12..0000000 --- a/README.rst +++ /dev/null @@ -1,6 +0,0 @@ -Nerv Tales Network Documentation -################################ - -XMPP client and server, authoring tool, library, accessibility, adaptation, copyright exemption, risk, pdca, documents and accounting management system. - -Documentation only diff --git a/make.bat b/make.bat deleted file mode 100644 index 2e3ac25..0000000 --- a/make.bat +++ /dev/null @@ -1,36 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build -set SPHINXPROJ=Contesetlgendesvol1 - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% - -:end -popd diff --git a/make.sh b/make.sh deleted file mode 100755 index 8e66501..0000000 --- a/make.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/bin/env bash - -mkdir build -make -e SPHINXOPTS="-D language='en'" -e BUILDDIR=build/en html -make -e SPHINXOPTS="-D language='fr'" -e BUILDDIR=build/fr html -make -e SPHINXOPTS="-D language='nl'" -e BUILDDIR=build/nl html - -make -e SPHINXOPTS="-D language='en'" -e BUILDDIR=build/en gemini -make -e SPHINXOPTS="-D language='fr'" -e BUILDDIR=build/fr gemini -make -e SPHINXOPTS="-D language='nl'" -e BUILDDIR=build/nl gemini diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index a3578a9..0000000 --- a/requirements.txt +++ /dev/null @@ -1,19 +0,0 @@ -sphinxcontrib-bibtex -sphinx-galleria -pybtex-apa-style -sphinxcontrib-actdiag -sphinxcontrib-blockdiag -sphinxcontrib-nwdiag -sphinxcontrib-seqdiag -sphinx-issues -sphinx-sitemap -sphinxemoji -sphinx-git -sphinx-intl -sphinxcontrib-bibtex -reportlab -ablog -pybtex -#sphinx-storymaker -sphinx-fasvg -sphinx-nervproject-theme diff --git a/source/about.dbk b/source/about.dbk new file mode 100644 index 0000000..d696383 --- /dev/null +++ b/source/about.dbk @@ -0,0 +1,163 @@ + + +
+ + About Nerv Tales Network + + + Nerv Project ASBL develops Nerv Tales Network for it's internal + usage and all authorized entities for work adaptations. We want to + give an open-source and free of charge software to help all people + and foundations. + + + + + + + + + Details + + + Nerv Project ASBL + + + + + + + Contact + + + contact AT nerv-project.eu + + + + + Status + + + ASBL + + + + + + Address + + + +
+Rue Longue 27 Bte K10 +1420 Eigenbrakel +Belgium +
+ + + + + Phone + + + +32 (0)2 319 888 0 + + + + + Enterprise + + + 0756.741.342 + + + + + VAT + + + BE0756741342 + + + + + Editor number KBR + + + 15066 + + + + + Publication + + + Nerv Project ASBL + + + + + Production + + + Nerv Project ASBL + + + + + Webmaster + + + Nerv Project ASBL + + + + + Author + + + Nerv Project ASBL except expressly set out + + + + + Video + + + Nerv Project ASBL + + + + + Hosting + + + IT4Freedom + + + + + IBAN + + + BE02 7512 1068 4040 + + + + + BIC + + + AXABBE22 + + + + + + + Please contact us if you want to donate, as we need some + informations to create your invoice. + +
diff --git a/source/about.rst b/source/about.rst deleted file mode 100644 index 8535e77..0000000 --- a/source/about.rst +++ /dev/null @@ -1,34 +0,0 @@ -About Nerv Tales Network -======================== - -Nerv Project ASBL develops Nerv Tales Network for -it's internal usage and all authorized entities for -work adaptations. We want to give an open-source -and free of charge software to help all people and -foundations. - - -====================== ==================== -Details Nerv Project ASBL -====================== ==================== -Contact contact AT nerv-project.eu -Status ASBL -Address | Rue Longue 27 Bte K10 - | 1420 Eigenbrakel - | Belgium -Phone +32 (0)2 319 888 0 -Enterprise 0756.741.342 -VAT BE0756741342 -Editor number KBR 15066 -Publication Nerv Project ASBL -Production Nerv Project ASBL -Webmaster Nerv Project ASBL -Author Nerv Project ASBL except expressly set out -Video Nerv Project ASBL -Hosting IT4Freedom -IBAN BE02 7512 1068 4040 -BIC AXABBE22 -====================== ==================== - -Please contact us if you want to donate, as we -need some informations to create your invoice. diff --git a/source/administration/index.dbk b/source/administration/index.dbk new file mode 100644 index 0000000..5e6d038 --- /dev/null +++ b/source/administration/index.dbk @@ -0,0 +1,43 @@ + + +
+ + Administration manual + + + Danger + + + Please read this documentation before installing. Nerv Tales Network + uses encryption at multiple levels. You need to backup database and + keys. You'll lost all your data if you lost keys. + + + Danger + + + Do not use same process and same servers to manage, backup, restore, + control, provide or use the core server and the security server. + Sensible and private data can not be read in a compromised database + without keys to unencrypt. Separate all tools avoid compromising + data and keys in same time. + + + Using same server or same bastion for data and for key management is + prohibited in some cases. + + + Danger + + + You have to assign Data Protection Officier and Security Officier + roles before using software. You can have at most two security + officiers. DPO and SO can be the same person but DPO and SO can not + be in IT or management team (except some legal cases). + + + Nothing here. Sorry, we're working on the first version of software. + +
diff --git a/source/administration/index.rst b/source/administration/index.rst deleted file mode 100644 index 55773e1..0000000 --- a/source/administration/index.rst +++ /dev/null @@ -1,34 +0,0 @@ -Administration manual -===================== - -.. danger:: - - Please read this documentation before installing. - Nerv Tales Network uses encryption at multiple - levels. You need to backup database and keys. - You'll lost all your data if you lost keys. - -.. danger:: - - Do not use same process and same servers to - manage, backup, restore, control, provide or - use the core server and the security server. - Sensible and private data can not be read in - a compromised database without keys to unencrypt. - Separate all tools avoid compromising data and - keys in same time. - - Using same server or same bastion for data and - for key management is prohibited in some cases. - -.. danger:: - - You have to assign Data Protection Officier and - Security Officier roles before using software. - You can have at most two security officiers. DPO - and SO can be the same person but DPO and SO can - not be in IT or management team (except some - legal cases). - -Nothing here. Sorry, we're working on the first -version of software. diff --git a/source/conf.py b/source/conf.py deleted file mode 100644 index ddbb8b4..0000000 --- a/source/conf.py +++ /dev/null @@ -1,258 +0,0 @@ -# -*- coding: utf-8 -*- -import os - -project = 'Nerv Tales Network Documentation' -basename = 'nervtn-docs' -project_uid = basename # ISBN, etc. -baseurl = 'https://tn.nerv-project.eu' -copyright = '2021, Nerv Project ASBL' -author = 'Nerv Project ASBL' -publisher = 'Nerv Project ASBL' -site_url = 'https://tn.nerv-project.eu/' -vcs_uri = "https://procrastinator.nerv-project.eu/" -use_bibtex = True -use_git = True -html_favicon = '_static/favicon.ico' -language = 'en' - -version = "0.1" -release = "0.1" - -if use_git: - from git import Repo - repository_name = 'nerv-project/' - repository_name += basename - - repo = Repo( - os.path.join( - os.path.dirname(os.path.realpath(__file__)), - '..' - ) - ) - repo.config_reader() - - if not repo.head.is_detached: - version = repo.head.ref.name - release = version + ' [' + repo.commit().hexsha[:20] + ']' - - repository_uri = vcs_uri + repository_name - issues_uri = repository_uri + "/issues/{issue}" - issues_pr_uri = repository_uri + "/merge_requests/{pr}" - issues_commit_uri = repository_uri + "/commit/{commit}" - issues_user_uri = vcs_uri + "/{user}" - -extensions = [ - 'sphinxemoji.sphinxemoji', - 'sphinxcontrib.actdiag', - 'sphinxcontrib.blockdiag', - 'sphinxcontrib.nwdiag', - 'sphinxcontrib.seqdiag', - 'sphinx_galleria', - 'sphinx.ext.extlinks', - 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx_issues', - 'sphinx_sitemap', - 'sphinx_fasvg', -] - -if use_git: - extensions.append('sphinx_git') - -if use_bibtex: - extensions.append('sphinxcontrib.bibtex') - -locale_dirs = ['locale/'] - -templates_path = ['_templates'] - -source_suffix = '.rst' -master_doc = 'index' - -exclude_patterns = [] -pygments_style = 'sphinx' - - -html_logo = '_static/logo.svg' -html_theme = 'nervproject' -html_theme_options = { - "logoalt": project, - "social": [ - ('solid', 'building', 'BCE 0756.741.342', 'https://kbopub.economie.fgov.be/kbopub/toonondernemingps.html?ondernemingsnummer=756741342'), - ('solid', 'receipt', 'TVA BE0756741342', 'https://kbopub.economie.fgov.be/kbopub/toonondernemingps.html?ondernemingsnummer=756741342'), - ('solid', 'books', 'KBR Éditeur 15066', 'https://www.kbr.be'), - ('brands', 'twitter', 'twitter', 'http://twitter.com/@nerv_project'), - ('solid', 'mug-hot', 'gitea', 'https://procrastinator.nerv-project.eu/nerv-project/nervtn'), - ('solid', 'hashtag', 'xmpp', 'xmpp:technique@clac.nerv-project.eu'), - ('regular', 'comments', 'movim', 'https://clac.nerv-project.eu/'), - ('solid', 'paragraph', 'gemini', 'gemini://tales.nerv-project.eu'), - ('solid', 'rss', 'rss', 'https://www.nerv-project.eu/blog/atom.xml'), - ], - 'external_languages': [ - # ('code', 'name', 'baseurl'), - ('en', 'en', 'https://tn.nerv-project.eu/en'), - ('fr', 'fr', 'https://tn.nerv-project.eu/fr'), - ('nl', 'nl', 'https://tn.nerv-proect.eu/nl'), - ], - "twitter_user": "nerv_project", - "fathom": { - 'url': '//casanabo.nerv-project.eu', - 'id': 'BJLEM', - }, - "license": { - 'type': 'EUPL-1.2', - 'text': 'EUPL-1.2', - 'subtype': '', - 'version': '', - 'url': 'https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12' - } -} -html_static_path = ['_static'] -html_sidebars = { - '**': [ - 'about.html', - 'postcard.html', 'util/sidetoc.html', - 'recentposts.html', 'tagcloud.html', - 'categories.html', 'archives.html', - 'social.html', - 'util/searchbox.html', - ], -} -html_baseurl = baseurl - -htmlhelp_basename = basename - -pyppeteer_pdf_options = { - 'printBackground': True, - 'format': 'A4', - 'margin': { - 'top': '0mm', - 'bottom': '0mm', - 'left': '0mm', - 'right': '0mm' - } -} - -latex_engine = 'xelatex' -latex_toplevel_sectioning = 'chapter' -latex_show_urls = 'footnote' -latex_elements = { - # 'figure_align': 'htbp', - # 'extraclassoptions': '', - 'papersize': 'a4paper', - 'pointsize': '12pt', - 'extraclassoptions': 'twoside', - 'fontpkg': r''' - \defaultfontfeatures{Ligatures=TeX} - \setmainfont{Luciole} - \setsansfont{Luciole} - ''' -} -latex_show_pagerefs = True -latex_documents = [ - (master_doc, basename + '.tex', project, - author, 'book'), -] - - -man_pages = [ - (master_doc, basename.lower(), project, [author], 1) -] - - -texinfo_documents = [ - (master_doc, basename, project, - author, basename, '', - 'Miscellaneous'), -] - - -epub_title = project -epub_author = author -epub_publisher = publisher -epub_copyright = copyright - -epub_identifier = project_uid -epub_uid = '' -epub_exclude_files = [ - 'index.xhtml', - 'search.xhtml', - 'blog.xhtml', - 'submit_success.xhtml', - 'contact.xhtml', - '403.xhtml', - '404.xhtml', - 'blog/archive.xhtml', - 'blog/category.xhtml', - 'blog/drafts.xhtml', - 'blog/author.xhtml', - 'blog/language.xhtml', - 'blog/location.xhtml', - 'blog/location/braine-lalleud.xhtml', - 'blog/language/francais.xhtml', - 'blog/author/kujiu.xhtml', - 'blog/2014.xhtml', - 'blog/2015.xhtml', - 'blog/2016.xhtml', - 'blog/2017.xhtml', - 'blog/2018.xhtml', - 'blog/2019.xhtml', - 'blog/2020.xhtml', - 'blog/2021.xhtml', - 'blog/2022.xhtml', - 'blog/2023.xhtml', - 'blog/2024.xhtml', - 'google82f190054a773ed9.xhtml', - 'nav.xhtml', -] -epub_theme = 'epub' -epub_show_urls = 'footnote' - -diag_antialias = True -diag_transparency = True -diag_html_image_format = "SVG" -diag_latex_image_format = "PDF" -diag_fontpath = os.path.dirname(os.path.realpath(__file__)) -diag_fontpath = os.path.join(diag_fontpath, '_static', 'biolinumrah.ttf') -diag_debug = False - -actdiag_antialias = diag_antialias -actdiag_transparency = diag_transparency -actdiag_html_image_format = diag_html_image_format -actdiag_latex_image_format = diag_latex_image_format -actdiag_fontpath = diag_fontpath -actdiag_debug = diag_debug - -blockdiag_antialias = diag_antialias -blockdiag_transparency = diag_transparency -blockdiag_html_image_format = diag_html_image_format -blockdiag_fontpath = diag_fontpath -blockdiag_latex_image_format = diag_latex_image_format -blockdiag_debug = diag_debug - -nwdiag_antialias = diag_antialias -nwdiag_transparency = diag_transparency -nwdiag_html_image_format = diag_html_image_format -nwdiag_latex_image_format = diag_latex_image_format -nwdiag_fontpath = diag_fontpath -nwdiag_debug = diag_debug - -seqdiag_antialias = diag_antialias -seqdiag_transparency = diag_transparency -seqdiag_html_image_format = diag_html_image_format -seqdiag_latex_image_format = diag_latex_image_format -seqdiag_fontpath = diag_fontpath -seqdiag_debug = diag_debug - - -if use_bibtex: - from pybtex.style import formatting - from pybtex.richtext import Text, Tag - - class NervPybtexStyle(formatting.BaseStyle): - def format_article(self, entry): - return Text(Tag('em', entry.fields['key'])) - - bibtex_bibfiles = ['refs.bib'] - bibtex_default_style = 'unsrtalpha' - bibtex_reference_style = 'label' diff --git a/source/contributing.dbk b/source/contributing.dbk new file mode 100644 index 0000000..264176b --- /dev/null +++ b/source/contributing.dbk @@ -0,0 +1,78 @@ + + +
+ + Contributing + +
+ How to contribute? + + Before contributing, you must accept your work will be published + with EUPL-1.2 license or newer version. You keep intellectual + property of your contribution. + + + You can join us on XMPP, on + technique@clac.nerv-project.eu + channel. + + + You can find all tickets (not only technical) in + our + gitea instance. + +
+
+ Where's the source code? + + All code is in + our + git repository. + +
+
+ Can I contribute if I'm not a developer? + + Of course, yes! We need a lot of competencies, like: + + + + + translating; + + + + + testing; + + + + + specifying interfaces; + + + + + managing community; + + + + + writing manuals; + + + + + helping users; + + + + + and all you can do! + + + +
+
diff --git a/source/contributing.rst b/source/contributing.rst deleted file mode 100644 index 9d1707a..0000000 --- a/source/contributing.rst +++ /dev/null @@ -1,35 +0,0 @@ -Contributing -============ - -How to contribute? -~~~~~~~~~~~~~~~~~~ - -Before contributing, you must accept your work will be -published with EUPL-1.2 license or newer version. You -keep intellectual property of your contribution. - -You can join us on XMPP, on -`technique@clac.nerv-project.eu `_ -channel. - -You can find all tickets (not only technical) in -`our gitea instance `_. - -Where's the source code? -~~~~~~~~~~~~~~~~~~~~~~~~ - -All code is in -`our git repository `_. - -Can I contribute if I'm not a developer? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Of course, yes! We need a lot of competencies, like: - -- translating; -- testing; -- specifying interfaces; -- managing community; -- writing manuals; -- helping users; -- and all you can do! diff --git a/source/developing/index.dbk b/source/developing/index.dbk new file mode 100644 index 0000000..cab8eee --- /dev/null +++ b/source/developing/index.dbk @@ -0,0 +1,12 @@ + + +
+ + Developing manual + + + Nothing here. Sorry, we're working on the first version of software. + +
diff --git a/source/developing/index.rst b/source/developing/index.rst deleted file mode 100644 index ff73dd2..0000000 --- a/source/developing/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -Developing manual -================= - -Nothing here. Sorry, we're working on the first -version of software. diff --git a/source/history.rst b/source/history.rst deleted file mode 100644 index d8f5e2e..0000000 --- a/source/history.rst +++ /dev/null @@ -1,21 +0,0 @@ -Document history -================ - -Current version -^^^^^^^^^^^^^^^ - -These informations are automatically generated -by git. - -.. git_commit_detail:: - :branch: - :commit: - :uncommitted: - :untracked: - :sha_length: 20 - -Versions log -^^^^^^^^^^^^ - -.. git_changelog:: - :revisions: 1000000 diff --git a/source/index.dbk b/source/index.dbk new file mode 100644 index 0000000..8010230 --- /dev/null +++ b/source/index.dbk @@ -0,0 +1,144 @@ + + +
+ + Nerv Tales Network Documentation + + + Nerv Tales Network is a free software to manage all aspects about + books. It fits needs of writers, editors, adaptation to people with + specific needs, libraries, book shops, online libraries and book + shops, museums, schools, ebooks distributors and readers. It + manages: + + + + + Accessibility + + + + + Documents + + + + + Communication + + + + + Stocks and items + + + + + Projects + + + + + Accounting + + + + + Risks and objectives + + + + + Learning and documentary surveillance + + + + + On-line services + + + + + Help and consultancy + + + + + High security and confidentiality + + + + + Synchronization + + + + + Note + + + You can also use Nerv Tales Network on other applications if it fits + your needs. + + + Danger + + + Even if Nerv Tales Network have enough features and security + systems, it can't be used in the following cases: + + + + + classified documents management and storage; + + + + + health management except for entities authorized to deliver + adaptations of work of art; + + + + + any activity where the software need an agreement, a + certification, an habilitation, an audit or other administrative + stuff. + + + + + However, you can use Nerv Tales Network in these cases if you pass + all legal steps by yourself. You can't ask help to the community or + to Nerv Project ASBL in these cases, and you must conform to the + EUPL-1.2 license. + + + All works, the software, all plugins and documentations are under + the EUPL-1.2 license. + + + about roadmap contributing history + + + Please select the documentation you want to consult. + + + user/index administration/index developing/index + specifications/index + +
+ Bibliography + + Important + + + Even if we use standards in our bibliography and if we want to + implement them, Nerv Tales Network and Nerv Project ASBL are not + certified. If you need certification for your software, you must + pass them yourself. + +
+
diff --git a/source/index.rst b/source/index.rst deleted file mode 100644 index 9f1731e..0000000 --- a/source/index.rst +++ /dev/null @@ -1,84 +0,0 @@ -Nerv Tales Network Documentation -################################ - -Nerv Tales Network is a free software to manage all -aspects about books. It fits needs of writers, -editors, adaptation to people with specific needs, -libraries, book shops, online libraries and book -shops, museums, schools, ebooks distributors and -readers. It manages: - -- Accessibility -- Documents -- Communication -- Stocks and items -- Projects -- Accounting -- Risks and objectives -- Learning and documentary surveillance -- On-line services -- Help and consultancy -- High security and confidentiality -- Synchronization - -.. note:: - - You can also use Nerv Tales Network on other - applications if it fits your needs. - -.. danger:: - - Even if Nerv Tales Network have enough features - and security systems, it can't be used in the - following cases: - - - classified documents management and storage; - - health management except for entities - authorized to deliver adaptations of work of - art; - - any activity where the software need an - agreement, a certification, an habilitation, - an audit or other administrative stuff. - - However, you can use Nerv Tales Network in these - cases if you pass all legal steps by yourself. - You can't ask help to the community or to - Nerv Project ASBL in these cases, and you must - conform to the EUPL-1.2 license. - -All works, the software, all plugins and -documentations are under the EUPL-1.2 license. - -.. toctree:: - :hidden: - :caption: Community - - about - roadmap - contributing - history - -Please select the documentation you want to consult. - -.. toctree:: - :caption: Documentation - :maxdepth: 1 - - user/index - administration/index - developing/index - specifications/index - -Bibliography -~~~~~~~~~~~~ - -.. important:: - - Even if we use standards in our bibliography and if - we want to implement them, Nerv Tales Network and - Nerv Project ASBL are not certified. If you need - certification for your software, you must pass them - yourself. - -.. bibliography:: - :all: diff --git a/source/roadmap.dbk b/source/roadmap.dbk new file mode 100644 index 0000000..357597d --- /dev/null +++ b/source/roadmap.dbk @@ -0,0 +1,10 @@ + + +
+ + Roadmap + + +
diff --git a/source/roadmap.rst b/source/roadmap.rst deleted file mode 100644 index a6214ca..0000000 --- a/source/roadmap.rst +++ /dev/null @@ -1,2 +0,0 @@ -Roadmap -======= diff --git a/source/specifications/accessibility.dbk b/source/specifications/accessibility.dbk new file mode 100644 index 0000000..455a618 --- /dev/null +++ b/source/specifications/accessibility.dbk @@ -0,0 +1,39 @@ + + +
+ + Accessibility + + + + + WCAG 3.0 :citeWCAG3.0 Gold level + + + + + Conforms to COGA-Usable :citeCOGA-Usable, + UAAG :citeUAAG and ATAG + :citeATAG + + + + + Compatibility with EN301549 :citeEN301549 + requirements + + + + + Client in Qt, Web, telnet, SSH, TUI and audio only + + + + + Hardware client + + + +
diff --git a/source/specifications/accessibility.rst b/source/specifications/accessibility.rst deleted file mode 100644 index 6b68f02..0000000 --- a/source/specifications/accessibility.rst +++ /dev/null @@ -1,10 +0,0 @@ -Accessibility -============= - -- WCAG 3.0 :cite:p:`WCAG3.0` Gold level -- Conforms to COGA-Usable :cite:p:`COGA-Usable`, - UAAG :cite:p:`UAAG` and ATAG :cite:p:`ATAG` -- Compatibility with EN301549 :cite:p:`EN301549` - requirements -- Client in Qt, Web, telnet, SSH, TUI and audio only -- Hardware client diff --git a/source/specifications/accounting.dbk b/source/specifications/accounting.dbk new file mode 100644 index 0000000..6fb4d7b --- /dev/null +++ b/source/specifications/accounting.dbk @@ -0,0 +1,89 @@ + + +
+ + Accounting + + + + + Implementing IFRS standard for small and middle-sized + organization (but no certification) + + + + + Double-entry book-keeping + + + + + Multi-currency with conversion rates + + + + + CO2 equivalent double-entry book-keeping (parallel accounting to + manage environmental impacts) + + + + + Purchases, loans, subscriptions and selling + + + + + Point of sale, with specific screens for catering, libraries, + shops, etc. + + + + + Self-service point of sale + + + + + Payment terminal + + + + + Legal reporting + + + + + VAT declaration in XML for Belgium + + + + + Human resources + + + + + Paid and unpaid leaves + + + + + Payroll + + + + + Taxes calculator (general, specific products, employees, etc.) + + + + + Copyright bills, copyright exemption declarations + + + +
diff --git a/source/specifications/accounting.rst b/source/specifications/accounting.rst deleted file mode 100644 index 19668b4..0000000 --- a/source/specifications/accounting.rst +++ /dev/null @@ -1,22 +0,0 @@ -Accounting -========== - -- Implementing IFRS standard for small and middle-sized - organization (but no certification) -- Double-entry book-keeping -- Multi-currency with conversion rates -- CO2 equivalent double-entry book-keeping (parallel - accounting to manage environmental impacts) -- Purchases, loans, subscriptions and selling -- Point of sale, with specific screens for catering, - libraries, shops, etc. -- Self-service point of sale -- Payment terminal -- Legal reporting -- VAT declaration in XML for Belgium -- Human resources -- Paid and unpaid leaves -- Payroll -- Taxes calculator (general, specific products, - employees, etc.) -- Copyright bills, copyright exemption declarations diff --git a/source/specifications/communication.dbk b/source/specifications/communication.dbk new file mode 100644 index 0000000..9dbb8a1 --- /dev/null +++ b/source/specifications/communication.dbk @@ -0,0 +1,115 @@ + + +
+ + Communication + + + + + Secure chat and group chat (XMPP backend) + + + + + Text, audio and video chatting (XMPP backend) + + + + + Add reactions and replies to messages + + + + + Link to documents or other object in Nerv Tales Network (use + generic link to object) + + + + + Mail client and delivery system + + + + + Share email folders and addresses with other users + + + + + Confidential emails must disappear after the first user set it + as it (like disability proof) + + + + + Convert emails to tickets, save attachments as documents + + + + + SMTP, IMAP, EAS and JMAP compatibility + + + + + Contact management with tags and groups (CardDAV compatibility) + + + + + Birthday announcements + + + + + Event management and sharing (CalDAV compatibility) + + + + + Calendar management (internal and external) + + + + + Online registration to event/adviser + + + + + Contact forms + + + + + Bulletin board system with hierarchical categories (mixing with + XMPP group chat) - public and private boards + + + + + Phone calls (can write textual notes during a call) with SIP + compatibility + + + + + Communication with federated instances (XMPP chat) + + + + + Ticket management + + + + + Notifications (XMPP ?) + + + +
diff --git a/source/specifications/communication.rst b/source/specifications/communication.rst deleted file mode 100644 index 087c0ad..0000000 --- a/source/specifications/communication.rst +++ /dev/null @@ -1,33 +0,0 @@ -Communication -============= - -- Secure chat and group chat (XMPP backend) -- Text, audio and video chatting (XMPP backend) -- Add reactions and replies to messages -- Link to documents or other object in Nerv Tales - Network (use generic link to object) -- Mail client and delivery system -- Share email folders and addresses with other - users -- Confidential emails must disappear after the first - user set it as it (like disability proof) -- Convert emails to tickets, save attachments as - documents -- SMTP, IMAP, EAS and JMAP compatibility -- Contact management with tags and groups (CardDAV - compatibility) -- Birthday announcements -- Event management and sharing (CalDAV - compatibility) -- Calendar management (internal and external) -- Online registration to event/adviser -- Contact forms -- Bulletin board system with hierarchical categories - (mixing with XMPP group chat) - public and - private boards -- Phone calls (can write textual notes during a - call) with SIP compatibility -- Communication with federated instances (XMPP - chat) -- Ticket management -- Notifications (XMPP ?) diff --git a/source/specifications/documents.dbk b/source/specifications/documents.dbk new file mode 100644 index 0000000..85f00a2 --- /dev/null +++ b/source/specifications/documents.dbk @@ -0,0 +1,536 @@ + + +
+ + Documents + + + + + Documents in standard and simplified languages + + + + + Documents in sign languages + + + + + In video, audio or text + + + + + Read with speech synthesis or audio files + + + + + Subtitles for video + + + + + Audio-description for video + + + + + Text-description for video + + + + + Transcription of video + + + + + Bibliography management + + + + + Citation management + + + + + Glossary + + + + + Highlight current sentence in multimedia presentation (like + audio+text or video+text or audio+video+text) + + + + + Styles for descriptions, dialogues, actions and other types of + paragraphs/sentences + + + + + Styles for verbs, nouns, and other grammatical functions + + + + + Style for grammatical groups + + + + + Add little images and sounds for better comprehension + + + + + Alt text for images (mandatory) + + + + + Manage translations + + + + + DRM and encryption + + + + + Credentials and classification (secret and zone level) + + + + + Versioning (with git) + + + + + Dictionary (with synonyms) + + + + + Digital and physical documents (link with stocks) + + + + + External and internal use, licensing + + + + + Peer-adaptation with other organizations + + + + + Share by link, with other users, with federated instance, by + mail, by chat or by DODP (if permitted, DRMize or encrypt if + needed) + + + + + WebDAV synchronization + + + + + Slide show for photo + + + + + Compatibility with PDF, ePub, HTML, RTF, RST, Markdown, docx, + doc, xls, xlsx, odt, ods and DAISY + + + + + Connector for OCR + + + + + Automatic and manual classification by hierarchical tags + + + + + Printing to authorized printers (standard, label, braille) + + + + + Document creation: + + + + + Raw, vi and WYSIWYG mode + + + + + Add video track, synchronize with text + + + + + Add audio track, synchronize with text + + + + + Multi-track audio/video editor (with simple tools) + + + + + Add images (alt mandatory, option if images is only to help + comprehension) + + + + + Import existing audio or video clip + + + + + Import existing text + + + + + Import existing images + + + + + Organize titles + + + + + Characters, items, arenas, connections, scenes, + episodes/chapters, symbols and themes sheets + + + + + Dictionary and synonyms + + + + + Translation interface + + + + + Diagram editor (general, network, sequences, user activities) + + + + + Bibliography editor + + + + + For stories and fictions: + + + + + Resumes available + + + + + Character, arena, item sheets updated during the reading + + + + + Maps with characters + + + + + List of characters in scene + + + + + Timeline with events + + + + + Avatar for each character, item and arena + + + + + Display avatar on each dialogue line + + + + + Display avatar on each reference + + + + + Display mood when changing + + + + + Classic and visual novel presentation + + + + + Metadata: + + + + + Compatibility with RDA :citeRDA, + + + + + Peering with other instances + + + + + Synchronizing with other catalogs (OPAC, LRM, Fediverse, + Vidiverse, Electre, Dilibel, Dilicom, PRISM and others) + + + + + Compatibility with ISBD, MARC21, MarcXML, UNIMARC, INTERMARC, + DID - Digital Item Declaration, DCMI, BIBFRAME, MODS, EAD, METS, + PREMIS, MPEG21-DIDL, RDA, RDA-FR, FRAD, FRSAD, FRBR and LRM + + + + + Support of ISBN, ISSN and EAN + + + + + Recommendation + + + + + Difficulty level (syntax, vocabulary, spelling, specialization) + + + + + Copyright (only European laws): + + + + + Prepare declarations for copyright collects + + + + + Manage licenses, number of digital copies, number of days of + loans, number of loans, number of digitalizations, number of + photocopies (with pages ranges) + + + + + DRM (LCP), encryption, PDTB and tokens management + + + + + Warns about obligation of anti-copy paper + + + + + Manage copyright exemptions with legal requirements (with forms) + + + + + For all exemptions: + + + + + Not in public domain + + + + + License is less permissive than the exemption + + + + + Not for commercial use + + + + + Exemption is for a limited number of special cases + + + + + Do not strike a blow at normal business + + + + + Do not harm legitimate interest of holder of the right + + + + + Exemption for adaptation for disabled people: + + + + + Authorization of legal entity + + + + + Link to a legal license or a book in stock + + + + + No adaptation in standard market + + + + + Restrict reproduction, distribution, communication and disposal + (DRM, encryption, anti-copy paper or ink, braille) + + + + + Diligently adapt + + + + + Display all requirements on the web sites (with automatic + refresh) + + + + + Link to the membership of beneficiary + + + + + Active proof of disability of beneficiary + + + + + Active license on adaptation + + + + + Submission for editing: + + + + + Limit by dates and categories + + + + + Check-list for requirements + + + + + Form with personal data and selection of committee + + + + + Add document, automatically convert to internal structure + + + + + Check if new format is correct + + + + + Personal account for submitter + + + + + Traceability of reading and decision process, with reporting to + the submitter + + + + + Number of documents to review before in the submitter report + + + + + Decisions are anonymous, no private data to review a manuscript + + + + + Template for contracts + + + + + If used by authors: follow-up to your submissions in your own + instance, manage contracts and accounting + + + + + See also stock and items management for other properties of physical + documents. + +
diff --git a/source/specifications/documents.rst b/source/specifications/documents.rst deleted file mode 100644 index e5609ab..0000000 --- a/source/specifications/documents.rst +++ /dev/null @@ -1,156 +0,0 @@ -Documents -========= - -- Documents in standard and simplified languages -- Documents in sign languages -- In video, audio or text -- Read with speech synthesis or audio files -- Subtitles for video -- Audio-description for video -- Text-description for video -- Transcription of video -- Bibliography management -- Citation management -- Glossary -- Highlight current sentence in multimedia - presentation (like audio+text or video+text or - audio+video+text) -- Styles for descriptions, dialogues, actions and - other types of paragraphs/sentences -- Styles for verbs, nouns, and other grammatical - functions -- Style for grammatical groups -- Add little images and sounds for better - comprehension -- Alt text for images (mandatory) -- Manage translations -- DRM and encryption -- Credentials and classification (secret and - zone level) -- Versioning (with git) -- Dictionary (with synonyms) -- Digital and physical documents (link with stocks) -- External and internal use, licensing -- Peer-adaptation with other organizations -- Share by link, with other users, with federated - instance, by mail, by chat or by DODP (if - permitted, DRMize or encrypt if needed) -- WebDAV synchronization -- Slide show for photo -- Compatibility with PDF, ePub, HTML, RTF, RST, - Markdown, docx, doc, xls, xlsx, odt, ods and DAISY -- Connector for OCR -- Automatic and manual classification by - hierarchical tags -- Printing to authorized printers (standard, label, - braille) - -Document creation: - -- Raw, vi and WYSIWYG mode -- Add video track, synchronize with text -- Add audio track, synchronize with text -- Multi-track audio/video editor (with simple tools) -- Add images (alt mandatory, option if images is - only to help comprehension) -- Import existing audio or video clip -- Import existing text -- Import existing images -- Organize titles -- Characters, items, arenas, connections, scenes, - episodes/chapters, symbols and themes sheets -- Dictionary and synonyms -- Translation interface -- Diagram editor (general, network, sequences, user - activities) -- Bibliography editor - -For stories and fictions: - -- Resumes available -- Character, arena, item sheets updated during the - reading -- Maps with characters -- List of characters in scene -- Timeline with events -- Avatar for each character, item and arena -- Display avatar on each dialogue line -- Display avatar on each reference -- Display mood when changing -- Classic and visual novel presentation - -Metadata: - -- Compatibility with RDA :cite:p:`RDA`, -- Peering with other instances -- Synchronizing with other catalogs (OPAC, LRM, - Fediverse, Vidiverse, Electre, Dilibel, Dilicom, - PRISM and others) -- Compatibility with ISBD, MARC21, MarcXML, UNIMARC, - INTERMARC, DID - Digital Item Declaration, - DCMI, BIBFRAME, MODS, EAD, METS, PREMIS, - MPEG21-DIDL, RDA, RDA-FR, FRAD, - FRSAD, FRBR and LRM -- Support of ISBN, ISSN and EAN -- Recommendation -- Difficulty level (syntax, vocabulary, spelling, - specialization) - -Copyright (only European laws): - -- Prepare declarations for copyright collects -- Manage licenses, number of digital copies, number - of days of loans, number of loans, number of - digitalizations, number of photocopies (with - pages ranges) -- DRM (LCP), encryption, PDTB and tokens management -- Warns about obligation of anti-copy paper -- Manage copyright exemptions with legal - requirements (with forms) - -For all exemptions: - -- Not in public domain -- License is less permissive than the exemption -- Not for commercial use -- Exemption is for a limited number of special cases -- Do not strike a blow at normal business -- Do not harm legitimate interest of holder of the - right - -Exemption for adaptation for disabled people: - -- Authorization of legal entity -- Link to a legal license or a book in stock -- No adaptation in standard market -- Restrict reproduction, distribution, communication - and disposal (DRM, encryption, anti-copy paper - or ink, braille) -- Diligently adapt -- Display all requirements on the web sites (with - automatic refresh) -- Link to the membership of beneficiary -- Active proof of disability of beneficiary -- Active license on adaptation - -Submission for editing: - -- Limit by dates and categories -- Check-list for requirements -- Form with personal data and selection of committee -- Add document, automatically convert to internal - structure -- Check if new format is correct -- Personal account for submitter -- Traceability of reading and decision process, with - reporting to the submitter -- Number of documents to review before in the - submitter report -- Decisions are anonymous, no private data to review - a manuscript -- Template for contracts -- If used by authors: follow-up to your submissions - in your own instance, manage contracts and accounting - -See also stock and items management for other -properties of physical documents. diff --git a/source/specifications/help.dbk b/source/specifications/help.dbk new file mode 100644 index 0000000..fe14294 --- /dev/null +++ b/source/specifications/help.dbk @@ -0,0 +1,110 @@ + + +
+ + Help management + + + + + Internal and external help and documentation system + + + + + Ticketing system and contact forms + + + + + Send notifications + + + + + Questions and answers + + + + + Documentation, blog and website management + + + + + Chat (see communication) + + + + + Bulletin board system (see communication) + + + + + Knowledge management + + + + + Record in beneficiary/user file + + + + + Credentials on sensitive data depending on level of privacy + (health data in database) + + + + + Private messages to personal adviser + + + + + ITIL implementation of service center + + + + + GDPR complaints in separated channel + + + + + Security complaints in separated channel + + + + + Public legal information management (DPO, privacy, terms of use, + terms of sale, address, legal identifiers, etc.) + + + + + Internal legal information management (anti-harassment, + anti-bribery, human resources documentation, emergency + documentation) + + + + + Quality documentation, process documentation + + + + + Disaster recovery plan + + + + + Crisis communication manual + + + +
diff --git a/source/specifications/help.rst b/source/specifications/help.rst deleted file mode 100644 index 17622e0..0000000 --- a/source/specifications/help.rst +++ /dev/null @@ -1,28 +0,0 @@ -Help management -=============== - -- Internal and external help and documentation - system -- Ticketing system and contact forms -- Send notifications -- Questions and answers -- Documentation, blog and website management -- Chat (see :doc:`communication`) -- Bulletin board system (see :doc:`communication`) -- Knowledge management -- Record in beneficiary/user file -- Credentials on sensitive data depending on level - of privacy (health data in database) -- Private messages to personal adviser -- ITIL implementation of service center -- GDPR complaints in separated channel -- Security complaints in separated channel -- Public legal information management (DPO, - privacy, terms of use, terms of sale, address, - legal identifiers, etc.) -- Internal legal information management - (anti-harassment, anti-bribery, human resources - documentation, emergency documentation) -- Quality documentation, process documentation -- Disaster recovery plan -- Crisis communication manual diff --git a/source/specifications/index.dbk b/source/specifications/index.dbk new file mode 100644 index 0000000..3bedabe --- /dev/null +++ b/source/specifications/index.dbk @@ -0,0 +1,108 @@ + + +
+ + Specifications + +
+ NEPs + + Nerv Tales Network Enhancement Proposals are the official + continuous specification of project and of management process. See + doc:neps/00001 for more information. + + + Note + + + Title of NEP contains its status: + + + + + [E.] Experimental + + + + + [P.] Proposed + + + + + [S.] Stable + + + + + [D.] Deprecated + + + + + [O.] Obsolete + + + + + [R.] Rejected or retracted + + + + + and type: + + + + + [.I] Informational + + + + + [.P] Procedural + + + + + [.F] Feature + + + + + [.A] Architectural + + + + + [.N] Protocol + + + +
+ Active + + neps/00000 neps/00001 neps/00002 neps/00005 neps/00006 + neps/00007 neps/00008 neps/00009 + +
+
+ Archive + + +
+
+
+ Roadmap + + Some big features need to be developed, but we don't write the NEP + at this moment. + + + accessibility documents communication stocks projects accounting + quality_risk learning services help security synchronization + +
+
diff --git a/source/specifications/index.rst b/source/specifications/index.rst deleted file mode 100644 index c0ec164..0000000 --- a/source/specifications/index.rst +++ /dev/null @@ -1,103 +0,0 @@ -Specifications -============== - - -NEPs -^^^^ - -Nerv Tales Network Enhancement Proposals are the -official continuous specification of project and -of management process. See doc:`neps/00001` -for more information. - -.. note:: - - Title of NEP contains its status: - - - [C] Continuously updated - - [E] Experimental - - [P] Proposed - - [S] Stable - - [D] Deprecated - - [O] Obsolete - - [R] Rejected or retracted - - Only procedural and informational NEP can be - continuously updated. - -Active -~~~~~~ - -Procedural ----------- - -.. toctree:: - :maxdepth: 1 - - neps/00001 - neps/00002 - -Informational -------------- - -Protocol --------- - -.. toctree:: - :maxdepth: 1 - - neps/00003 - neps/00004 - -Features --------- - -.. toctree:: - :maxdepth: 1 - - neps/00005 - neps/00006 - neps/00007 - neps/00008 - -Other ------ - -Archive -~~~~~~~ - -Procedural ----------- - -Informational -------------- - -Protocol --------- - -Features --------- - -Other ------ - -Features to develop -^^^^^^^^^^^^^^^^^^^ - -Some big features need to be developed, but we don't -write the NEP at this moment. - -.. toctree:: - - accessibility - documents - communication - stocks - projects - accounting - quality_risk - learning - services - help - security - synchronization diff --git a/source/specifications/learning.dbk b/source/specifications/learning.dbk new file mode 100644 index 0000000..af26100 --- /dev/null +++ b/source/specifications/learning.dbk @@ -0,0 +1,46 @@ + + +
+ + Learning + + + + + Room management + + + + + Planning management + + + + + Student management, grading + + + + + Lessons, exams and exercises + + + + + Incorporate other documents + + + + + Learner projects + + + + + For learning in centre or online + + + +
diff --git a/source/specifications/learning.rst b/source/specifications/learning.rst deleted file mode 100644 index 909a5d3..0000000 --- a/source/specifications/learning.rst +++ /dev/null @@ -1,10 +0,0 @@ -Learning -======== - -- Room management -- Planning management -- Student management, grading -- Lessons, exams and exercises -- Incorporate other documents -- Learner projects -- For learning in centre or online diff --git a/source/specifications/neps/00000.dbk b/source/specifications/neps/00000.dbk new file mode 100644 index 0000000..777c45f --- /dev/null +++ b/source/specifications/neps/00000.dbk @@ -0,0 +1,60 @@ + + + + [EI] NEP00000 - NEP Template + NEP00000 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + NEP00001 + + Use this document as template for your NEP. + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release - little description here + + + Experimental + Informational + +
+ Objectives + + What objectives do you answer with this document? + +
+
+ Title1 + + Your stuff + +
+
+ Title2 + + Your stuff + +
+ Subtitle + + Other stuff + +
+
+ diff --git a/source/specifications/neps/00001.dbk b/source/specifications/neps/00001.dbk new file mode 100644 index 0000000..4c68004 --- /dev/null +++ b/source/specifications/neps/00001.dbk @@ -0,0 +1,90 @@ + + + + [EP] NEP00001 - NEP and development process + NEP00001 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + + This document defines development process for NervTN project. + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release - based on XEP-0001 from XSF Foundation + + + Experimental + Procedural + +
+ Objectives + + +
+
+ Base requirements + + +
+
+ Documentation + + +
+
+ Testing + + +
+
+ Code + + +
+
+ Submission + + +
+
+ Publication + + +
+
+ Code contribution + + +
+
+ External libraries + + +
+
+ Risk management + + +
+
+ Issues + + +
+ diff --git a/source/specifications/neps/00001.rst b/source/specifications/neps/00001.rst deleted file mode 100644 index fe79bd4..0000000 --- a/source/specifications/neps/00001.rst +++ /dev/null @@ -1,42 +0,0 @@ -[C] NEP00001 - NEP and development process -========================================== - -Objectives -^^^^^^^^^^ - -Nerv Tales Network Enhancement Proposals or NEPs define -the development process, protocol, features and all -information needed for the project. - -Base requirements -^^^^^^^^^^^^^^^^^ - -NEP Types -^^^^^^^^^ - -Submission -^^^^^^^^^^ - -Approval -^^^^^^^^ - -NEP states -^^^^^^^^^^ - -Documentation -^^^^^^^^^^^^^ - -Testing -^^^^^^^ - -Code contribution -^^^^^^^^^^^^^^^^^ - -External libraries -^^^^^^^^^^^^^^^^^^ - -Risk management -^^^^^^^^^^^^^^^ - -Issues -^^^^^^ diff --git a/source/specifications/neps/00002.dbk b/source/specifications/neps/00002.dbk new file mode 100644 index 0000000..c27790c --- /dev/null +++ b/source/specifications/neps/00002.dbk @@ -0,0 +1,75 @@ + + + + [EI] NEP00002 - Code convention + NEP00002 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + + + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release + + + Experimental + Informational + +
+ Objectives + + +
+
+ ReStructuredText + + +
+
+ Rust + + +
+
+ Python + + +
+
+ JavaScript + + +
+
+ Vue.js + + +
+
+ HTML + + +
+
+ CSS + + +
+ diff --git a/source/specifications/neps/00002.rst b/source/specifications/neps/00002.rst deleted file mode 100644 index f85e89d..0000000 --- a/source/specifications/neps/00002.rst +++ /dev/null @@ -1,20 +0,0 @@ -[C] NEP00002 - Code convention -============================== - -ReStructuredText -^^^^^^^^^^^^^^^^ - -Python -^^^^^^ - -JavaScript -^^^^^^^^^^ - -Vue.js -^^^^^^ - -HTML -^^^^ - -CSS -^^^ diff --git a/source/specifications/neps/00003.dbk b/source/specifications/neps/00003.dbk new file mode 100644 index 0000000..667ba82 --- /dev/null +++ b/source/specifications/neps/00003.dbk @@ -0,0 +1,40 @@ + + + + [EI] NEP00003 - Code of conduct + NEP00003 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + + + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release + + + Experimental + Informational + +
+ Objectives + + +
+ diff --git a/source/specifications/neps/00003.rst b/source/specifications/neps/00003.rst deleted file mode 100644 index ef8ec9f..0000000 --- a/source/specifications/neps/00003.rst +++ /dev/null @@ -1,9 +0,0 @@ -[E] NEP00003 - Base protocol -============================ - -Objectives -^^^^^^^^^^ - -XMPP use -^^^^^^^^ - diff --git a/source/specifications/neps/00004.dbk b/source/specifications/neps/00004.dbk new file mode 100644 index 0000000..a7f6477 --- /dev/null +++ b/source/specifications/neps/00004.dbk @@ -0,0 +1,55 @@ + + + + [EA] NEP00004 - General architecture + NEP00004 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + + + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release + + + Experimental + Architectural + +
+ Objectives + + +
+
+ Architecture + + +
+
+ Encryption + + +
+
+ Key management + + +
+ diff --git a/source/specifications/neps/00004.rst b/source/specifications/neps/00004.rst deleted file mode 100644 index 252adf7..0000000 --- a/source/specifications/neps/00004.rst +++ /dev/null @@ -1,14 +0,0 @@ -[E] NEP00004 - Security protocol -================================ - -Objectives -^^^^^^^^^^ - -Architecture -^^^^^^^^^^^^ - -Encryption -^^^^^^^^^^ - -Key management -^^^^^^^^^^^^^^ diff --git a/source/specifications/neps/00005.dbk b/source/specifications/neps/00005.dbk new file mode 100644 index 0000000..152fe42 --- /dev/null +++ b/source/specifications/neps/00005.dbk @@ -0,0 +1,55 @@ + + + + [EN] NEP00005 - Authentication and encryption + NEP00005 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + + + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release + + + Experimental + Protocol + +
+ Objectives + + +
+
+ Authentication process + + +
+
+ Encryption level + + +
+
+ Database encryption + + +
+ diff --git a/source/specifications/neps/00005.rst b/source/specifications/neps/00005.rst deleted file mode 100644 index 4681c6f..0000000 --- a/source/specifications/neps/00005.rst +++ /dev/null @@ -1,16 +0,0 @@ -[E] NEP00005 - Authentication and encryption -============================================ - -Objectives -^^^^^^^^^^ - -Authentication process -^^^^^^^^^^^^^^^^^^^^^^ - -Encryption level -^^^^^^^^^^^^^^^^ - -Database encryption -^^^^^^^^^^^^^^^^^^^ - - diff --git a/source/specifications/neps/00006.dbk b/source/specifications/neps/00006.dbk new file mode 100644 index 0000000..43f2dff --- /dev/null +++ b/source/specifications/neps/00006.dbk @@ -0,0 +1,40 @@ + + + + [EN] NEP00006 - Node communication + NEP00006 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + + + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release + + + Experimental + Protocol + +
+ Objectives + + +
+ diff --git a/source/specifications/neps/00006.rst b/source/specifications/neps/00006.rst deleted file mode 100644 index 412772a..0000000 --- a/source/specifications/neps/00006.rst +++ /dev/null @@ -1,33 +0,0 @@ -[E] NEP00006 - Contact management -================================= - -Objectives -^^^^^^^^^^ - -Contact list -^^^^^^^^^^^^ - -Informations -^^^^^^^^^^^^ - -Avatar -^^^^^^ - -Update process -^^^^^^^^^^^^^^ - -Using internal or provided informations -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Contact Sharing -^^^^^^^^^^^^^^^ - -vCard export -^^^^^^^^^^^^ - -DAV connector -^^^^^^^^^^^^^ - -JMAP connector -^^^^^^^^^^^^^^ - diff --git a/source/specifications/neps/00007.dbk b/source/specifications/neps/00007.dbk new file mode 100644 index 0000000..673a676 --- /dev/null +++ b/source/specifications/neps/00007.dbk @@ -0,0 +1,40 @@ + + + + [EN] NEP00007 - Component communication + NEP00007 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + + + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release + + + Experimental + Protocol + +
+ Objectives + + +
+ diff --git a/source/specifications/neps/00007.rst b/source/specifications/neps/00007.rst deleted file mode 100644 index 80f8e43..0000000 --- a/source/specifications/neps/00007.rst +++ /dev/null @@ -1,102 +0,0 @@ -[E] NEP00007 - Messaging (chat and mail) -======================================== - -Objectives -^^^^^^^^^^ - -Instant and non-instant -^^^^^^^^^^^^^^^^^^^^^^^ - -Private and group chat -^^^^^^^^^^^^^^^^^^^^^^ - -Notification -^^^^^^^^^^^^ - -Formatting -^^^^^^^^^^ - -Contact management -^^^^^^^^^^^^^^^^^^ - -Threading -^^^^^^^^^ - -Forwarding -^^^^^^^^^^ - -Servers, categories and rooms -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Mailing-list -^^^^^^^^^^^^ - -Tags and folders -^^^^^^^^^^^^^^^^ - -File attachment -^^^^^^^^^^^^^^^ - -Images and animations -^^^^^^^^^^^^^^^^^^^^^ - -Emoticons and stickers -^^^^^^^^^^^^^^^^^^^^^^ - -Links -^^^^^ - -Audio and video messages -^^^^^^^^^^^^^^^^^^^^^^^^ - -Streams and calls -^^^^^^^^^^^^^^^^^ - -Message sharing -^^^^^^^^^^^^^^^ - -Mailbox sharing -^^^^^^^^^^^^^^^ - -Communication with anonymous -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Website chat and contact form -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Blog, document, file or other object's comments -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Security and HTML threats -^^^^^^^^^^^^^^^^^^^^^^^^^ - -SPAM management -^^^^^^^^^^^^^^^ - -Log and headers -^^^^^^^^^^^^^^^ - -Accessibility features -^^^^^^^^^^^^^^^^^^^^^^ - -(like subtitling and/or signing by other people) - -IMAP connector -^^^^^^^^^^^^^^ - -JMAP connector -^^^^^^^^^^^^^^ - -SMTP connector -^^^^^^^^^^^^^^ - -DKIM, SPF and DMARC -^^^^^^^^^^^^^^^^^^^ - -SIP connector -^^^^^^^^^^^^^ - -Social network connectors -^^^^^^^^^^^^^^^^^^^^^^^^^ - -(Connect to Matrix, Mastodon, Diaspora, Facebook, Twitter). diff --git a/source/specifications/neps/00008.dbk b/source/specifications/neps/00008.dbk new file mode 100644 index 0000000..e7ceb92 --- /dev/null +++ b/source/specifications/neps/00008.dbk @@ -0,0 +1,85 @@ + + + + [EF] NEP00008 - Contact management + NEP00008 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + + + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release + + + Experimental + Feature + +
+ Objectives + + +
+
+ Contact list + + +
+
+ Informations + + +
+
+ Avatar + + +
+
+ Update process + + +
+
+ Using internal or provided informations + + +
+
+ Contact Sharing + + +
+
+ vCard export + + +
+
+ DAV connector + + +
+
+ JMAP connector + + +
+ diff --git a/source/specifications/neps/00008.rst b/source/specifications/neps/00008.rst deleted file mode 100644 index ecd7568..0000000 --- a/source/specifications/neps/00008.rst +++ /dev/null @@ -1,5 +0,0 @@ -[E] NEP00008 - File management -============================== - -Objectives -^^^^^^^^^^ diff --git a/source/specifications/neps/00009.dbk b/source/specifications/neps/00009.dbk new file mode 100644 index 0000000..7b353c3 --- /dev/null +++ b/source/specifications/neps/00009.dbk @@ -0,0 +1,197 @@ + + + + [EF] NEP00009 - Messaging + NEP00009 + + ChristopheBuffenoir + + Nerv Project ASBL + 2022Nerv Project ASBL + + License + This work is licensed under EUPL-1.2 + + 2022-04-25 + 2022-04-25 + 0.1 + Nerv Tales Network + + + + + + 0.1 + 2022-04-25 + + ChristopheBuffenoir + + Initial release + + + Experimental + Feature + +
+ Objectives + + +
+
+ Instant and non-instant + + +
+
+ Private and group chat + + +
+
+ Notification + + +
+
+ Formatting + + +
+
+ Contact management + + +
+
+ Threading + + +
+
+ Forwarding + + +
+
+ Servers, categories and rooms + + +
+
+ Mailing-list + + +
+
+ Tags and folders + + +
+
+ File attachment + + +
+
+ Images and animations + + +
+
+ Emoticons and stickers + + +
+
+ Links + + +
+
+ Audio and video messages + + +
+
+ Streams and calls + + +
+
+ Message sharing + + +
+
+ Mailbox sharing + + +
+
+ Communication with anonymous + + +
+
+ Website chat and contact form + + +
+
+ Blog, document, file or other object's comments + + +
+
+ Security and HTML threats + + +
+
+ SPAM management + + +
+
+ Log and headers + + +
+
+ Accessibility features + + (like subtitling and/or signing by other people) + +
+
+ IMAP connector + + +
+
+ JMAP connector + + +
+
+ SMTP connector + + +
+
+ DKIM, SPF and DMARC + + +
+
+ SIP connector + + +
+
+ Social network connectors + + (Connect to Matrix, Mastodon, Diaspora, Facebook, Twitter). + +
+ diff --git a/source/specifications/projects.dbk b/source/specifications/projects.dbk new file mode 100644 index 0000000..c092786 --- /dev/null +++ b/source/specifications/projects.dbk @@ -0,0 +1,41 @@ + + +
+ + Projects + + + + + Objectives, quality, risk and task management per project + + + + + Specific funds for project + + + + + Time sheets per project + + + + + Services and products of project (purchases and selling) + + + + + Grant management and reporting + + + + + Event and convention management + + + +
diff --git a/source/specifications/projects.rst b/source/specifications/projects.rst deleted file mode 100644 index fd98f38..0000000 --- a/source/specifications/projects.rst +++ /dev/null @@ -1,10 +0,0 @@ -Projects -======== - -- Objectives, quality, risk and task management per - project -- Specific funds for project -- Time sheets per project -- Services and products of project (purchases and selling) -- Grant management and reporting -- Event and convention management diff --git a/source/specifications/quality_risk.dbk b/source/specifications/quality_risk.dbk new file mode 100644 index 0000000..9224613 --- /dev/null +++ b/source/specifications/quality_risk.dbk @@ -0,0 +1,103 @@ + + +
+ + Quality and risk management + + + + + Define quality requirements + + + + + Internal documentation for process + + + + + Manage PDCA cycles + + + + + SLR and SLA management + + + + + Catalog of services and products + + + + + Test management + + + + + Audit management + + + + + Create objectives for company or by projects + + + + + Set tags on objectives (like GDPR, ISO27001, etc.) + + + + + Manage tickets, feedbacks and incidents with levels of priority, + of frequency and of seriousness + + + + + Set indicators automatically or manually + + + + + Manage impact of decision, incident, or indicator + + + + + Treatment of risks with evaluation on objectives, risks, and + costs + + + + + Evaluation of social and environmental impacts + + + + + Create templates of objectives and risks + + + + + Complete ITIL implementation + + + + + Disaster recovery plan + + + + + Online surveys (anonymous and non-anonymous) + + + +
diff --git a/source/specifications/quality_risk.rst b/source/specifications/quality_risk.rst deleted file mode 100644 index f706743..0000000 --- a/source/specifications/quality_risk.rst +++ /dev/null @@ -1,24 +0,0 @@ -Quality and risk management -=========================== - -- Define quality requirements -- Internal documentation for process -- Manage PDCA cycles -- SLR and SLA management -- Catalog of services and products -- Test management -- Audit management -- Create objectives for company or by projects -- Set tags on objectives (like GDPR, ISO27001, etc.) -- Manage tickets, feedbacks and incidents with - levels of priority, of frequency and of - seriousness -- Set indicators automatically or manually -- Manage impact of decision, incident, or indicator -- Treatment of risks with evaluation on objectives, - risks, and costs -- Evaluation of social and environmental impacts -- Create templates of objectives and risks -- Complete ITIL implementation -- Disaster recovery plan -- Online surveys (anonymous and non-anonymous) diff --git a/source/specifications/security.dbk b/source/specifications/security.dbk new file mode 100644 index 0000000..0747968 --- /dev/null +++ b/source/specifications/security.dbk @@ -0,0 +1,84 @@ + + +
+ + Security + + + + + Encrypted database + + + + + Encrypted hashed passwords + + + + + Separate server for key management + + + + + Update database when a key expires + + + + + Credentials management + + + + + Limit to two Security Officers + + + + + Two-factor authentication for all operations + + + + + Three or four-factor authentication for sensitive operations + + + + + Send notification to user when accessing on sensitive private + data + + + + + List of private data + + + + + Auto-expiration of private data with anonymization + + + + + Technician mode to help users, with no displayed data or fictive + data (except with agreement of user and security officer) + + + + + Digital rights management (LCP) or encryption of all documents + except public documents + + + + + Archive classification (restricted, secret, top secret levels) + + + +
diff --git a/source/specifications/security.rst b/source/specifications/security.rst deleted file mode 100644 index 33640c9..0000000 --- a/source/specifications/security.rst +++ /dev/null @@ -1,23 +0,0 @@ -Security -======== - -- Encrypted database -- Encrypted hashed passwords -- Separate server for key management -- Update database when a key expires -- Credentials management -- Limit to two Security Officers -- Two-factor authentication for all operations -- Three or four-factor authentication for sensitive - operations -- Send notification to user when accessing on - sensitive private data -- List of private data -- Auto-expiration of private data with anonymization -- Technician mode to help users, with no displayed - data or fictive data (except with agreement of - user and security officer) -- Digital rights management (LCP) or encryption of - all documents except public documents -- Archive classification (restricted, secret, top - secret levels) diff --git a/source/specifications/services.dbk b/source/specifications/services.dbk new file mode 100644 index 0000000..907c61d --- /dev/null +++ b/source/specifications/services.dbk @@ -0,0 +1,77 @@ + + +
+ + Online services + + + + + e-shop + + + + + e-library + + + + + e-learning + + + + + Accessible queue management in reception + + + + + Public mural screens and vocal announcements + + + + + Time sheets + + + + + On-site services with travel expenses + + + + + Custom reporting of actions in beneficiary file + + + + + Hotline management + + + + + Subscription management + + + + + Capacity supervision + + + + + Implementation of ITIL and ISO9001 requirements but no + certification + + + + + Catering + + + +
diff --git a/source/specifications/services.rst b/source/specifications/services.rst deleted file mode 100644 index 57d6709..0000000 --- a/source/specifications/services.rst +++ /dev/null @@ -1,17 +0,0 @@ -Online services -=============== - -- e-shop -- e-library -- e-learning -- Accessible queue management in reception -- Public mural screens and vocal announcements -- Time sheets -- On-site services with travel expenses -- Custom reporting of actions in beneficiary file -- Hotline management -- Subscription management -- Capacity supervision -- Implementation of ITIL and ISO9001 requirements but - no certification -- Catering diff --git a/source/specifications/stocks.dbk b/source/specifications/stocks.dbk new file mode 100644 index 0000000..9828635 --- /dev/null +++ b/source/specifications/stocks.dbk @@ -0,0 +1,122 @@ + + +
+ + Stocks and items + + + + + Items can be books, historical art, historical monuments, + digital books, video, CD, DVD, or what you want + + + + + List all previous and current owners (if needed) + + + + + List all restorations and corresponding reports + + + + + Requirements for preservation, transport and exhibition + + + + + Insurance management for preservation, transport and exhibition + + + + + Security management for preservation, transport and exhibition - + connecting to alarm systems + + + + + Set context of archeological discovery with reports, photo, + illustration, links to articles + + + + + Linked bibliography and documents + + + + + Derivative and composed manufactured products + + + + + Number of items in stock with individual sheet if historical + item or secondhand + + + + + Place in stock, in shop or in shelves + + + + + Alerts on minimum and maximum limit in stocks or in shelves + + + + + Maps of stocks, route for employees to prepare orders + + + + + Print labels for shipping + + + + + Manage RMA, serial numbers and guarantee + + + + + Special stock units (for packages) + + + + + Expiry date and queue management (LIFO, FIFO, etc.) + + + + + Automatically update stocks on shipping and reception, projected + stocks with current in and out orders + + + + + Provisioning contracts with libraries by adding a panel of + titles + + + + + Interact with other stock solutions (like Kardex) + + + + + Display informations on big screens in stocks (configurable) + + + +
diff --git a/source/specifications/stocks.rst b/source/specifications/stocks.rst deleted file mode 100644 index 78efa91..0000000 --- a/source/specifications/stocks.rst +++ /dev/null @@ -1,36 +0,0 @@ -Stocks and items -================ - -- Items can be books, historical art, historical - monuments, digital books, video, CD, DVD, or - what you want -- List all previous and current owners (if needed) -- List all restorations and corresponding reports -- Requirements for preservation, transport and - exhibition -- Insurance management for preservation, transport and - exhibition -- Security management for preservation, transport and - exhibition - connecting to alarm systems -- Set context of archeological discovery with reports, - photo, illustration, links to articles -- Linked bibliography and documents -- Derivative and composed manufactured products -- Number of items in stock with individual sheet if - historical item or secondhand -- Place in stock, in shop or in shelves -- Alerts on minimum and maximum limit in stocks or in - shelves -- Maps of stocks, route for employees to prepare orders -- Print labels for shipping -- Manage RMA, serial numbers and guarantee -- Special stock units (for packages) -- Expiry date and queue management (LIFO, FIFO, etc.) -- Automatically update stocks on shipping and - reception, projected stocks with current in and out - orders -- Provisioning contracts with libraries by adding a - panel of titles -- Interact with other stock solutions (like Kardex) -- Display informations on big screens in stocks - (configurable) diff --git a/source/specifications/synchronization.dbk b/source/specifications/synchronization.dbk new file mode 100644 index 0000000..726fd5c --- /dev/null +++ b/source/specifications/synchronization.dbk @@ -0,0 +1,98 @@ + + +
+ + Synchronization and API + + + + + Mail synchronization with SMTP, IMAP, EAS and JMAP + + + + + Print automatically + + + + + Contact, calendar and file synchronization with JMAP, CalDAV, + CardDAV and WebDAV + + + + + SmartSync compatibility + + + + + REST API (documented) + + + + + GraphQL API + + + + + DODP - Daisy Online Delivery Protocol + + + + + XMPP for instant messages, audio and video chat + + + + + OMEMO support + + + + + SIP for phone calls + + + + + LDAP and ActiveDirectory compatibility + + + + + KMIP protocol for key management + + + + + Kerberos, OAUTH2, FIDO, X509, PKCS11, CAS, SAML and OpenID + authentication + + + + + Atom/RSS feeds + + + + + FTP, SFTP and FTPS compatibility + + + + + Send HTTP/HTTPS requests + + + + + ESB features, low-code and automation + + + +
diff --git a/source/specifications/synchronization.rst b/source/specifications/synchronization.rst deleted file mode 100644 index 846a298..0000000 --- a/source/specifications/synchronization.rst +++ /dev/null @@ -1,22 +0,0 @@ -Synchronization and API -======================= - -- Mail synchronization with SMTP, IMAP, EAS and JMAP -- Print automatically -- Contact, calendar and file synchronization with - JMAP, CalDAV, CardDAV and WebDAV -- SmartSync compatibility -- REST API (documented) -- GraphQL API -- DODP - Daisy Online Delivery Protocol -- XMPP for instant messages, audio and video chat -- OMEMO support -- SIP for phone calls -- LDAP and ActiveDirectory compatibility -- KMIP protocol for key management -- Kerberos, OAUTH2, FIDO, X509, PKCS11, CAS, SAML - and OpenID authentication -- Atom/RSS feeds -- FTP, SFTP and FTPS compatibility -- Send HTTP/HTTPS requests -- ESB features, low-code and automation diff --git a/source/user/index.dbk b/source/user/index.dbk new file mode 100644 index 0000000..6900ba9 --- /dev/null +++ b/source/user/index.dbk @@ -0,0 +1,12 @@ + + +
+ + User manual + + + Nothing here. Sorry, we're working on the first version of software. + +
diff --git a/source/user/index.rst b/source/user/index.rst deleted file mode 100644 index 7dfca75..0000000 --- a/source/user/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -User manual -=========== - -Nothing here. Sorry, we're working on the first -version of software. diff --git a/update-translation.sh b/update-translation.sh deleted file mode 100755 index 1969359..0000000 --- a/update-translation.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env bash - -make gettext -sphinx-intl update -p build/gettext -l fr -l nl