## La collaboration devrait s'articuler autour de la prochaine version de MaX. ##
### Objectifs ###
## Getting started
Fournir un environnement applicatif permettant l'affichage et la lecture de sources structurées en XML dans un environnement web.
Cet outil — moteur d'affichage XML — se composera :
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
- d'un cœur applicatif : @todo
- de modules : @todo
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
### Exigences fonctionnelles ###
## Add your files
L'outil doit :
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
- proposer des modules d'affichage pour les vocabulaires TEI et EAD ;
- faciliter la modification des comportements par défaut ;
- permettre l'intégration de nouvelles fonctionnalités sans modification du coeur applicatif ;
- proposer une solution de statification/pétrifications des contenus générés.
-[ ] [Set up project integrations](https://git.unicaen.fr/pdn-certic/max-v2/-/settings/integrations)
## Collaborate with your team
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- permettre la modification des comportements via les languages XQuery et XSL ;
- proposer un fonctionnement simplifié avec stockage des sources sur le système de fichier ;
- permettre un fonctionnement avancé avec utilisation d'une base de données XML BaseX ;
- proposer un code source facilitant l'utilisation d'autres systèmes de stockage des sources (SGBD par exemple) ;
- minimiser les dépendances logicielles ;
- proposer la solution la plus légère et écologique possible.
Use the built-in continuous integration in GitLab.
### Pistes ###
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
On s'inspire de Francium (makefile et le moins de technologies mobilisées possibles). On ajoute simplement un appel, ou des appels, saxon pour la transformation du corpus XML en HTML. L'appel aux XSLs devra être clarifié, mais il dépendra des modules installés et appelés. Il sera probablement indispensable de disposer d'un ou deux scénarios de transformations de base un peu "câblés" : un pour les données encodées en TEI et un pour les données encodées en EAD.
***
Pas de solution de stockage par défaut : ce sont des fichiers stockés sur le système de fichiers qui seront transformés en HTML.
# Editing this README
Il faudra que l'utilisateur exprime sa volonté d'utiliser une solution de stockage (BaseX ou SGBDR (PGSQL probablement?)) en intervenant dans le fichier de configuration directement. Cette solution permet de fixer le coût d'entrée technique : si l'utilisateur ne sait pas intervenir dans un script `sh`, pas la peine d'y mettre le nez plus avant… il devra se contenter d'utiliser la version de base du moteur qui devra proposer un résultat HTML minimal exploitable (façon TEIPublisher).
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
La modification du comportement des transformations (et des requêtes XQuery le cas échéant) se fera *via* un simple mécanisme de renommage des fichiers avec un suffixe, ou un préfixe, qui sera pris en charge préférentiellement dès qu'il existera (ie : tohtml_custom.xsl sera utilisé à la place de tohtml.xsl).
## Suggestions for a good README
L'ogranisation sera basée sur des modules. Les utilisateurs devront pouvoir ajouter des modules facilement. Certains modules seront "certifiés" par l'équipe de développement de MaX, garantissant ainsi leurs bon fonctionnement.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Intégration d'Heimdall (à discuter précisément avec Régis).
## Name
Choose a self-explaining name for your project.
Intégration de DTS. C'est une expérimentation à laquelle nous nous sommes engagée dans le cadre de Biblissima+. Lors des dernières journées du cluster 5b, il apparaît que DTS (dont une POC est développée en XQquery dans BaseX) pourrait être une solution élégante et efficace pour permettre de renvoyer côté données l'accès aux fragments (introduction, chapitre, section, etc.). En effet, en s'appuyant sur un élément TEI dédié (spécialement ajouté pour DTS) il est possible de faire l'association entre un type de partie de texte et un XPath directement dans une instance XML. Voir la définition de l'élément [citeStructure](https://tei-c.org/release/doc/tei-p5-doc/en/html/ref-citeStructure.html)
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
MaX embarquera :
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
- saxon ;
- BaseX ;
- serveur web (pour permettre l'affichage des pages HTML dans le cadre d'une utilisation de base). De cette manière le comportement du moteur sera toujours le même, quelle que soit la solution de stockage retenue
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Proposition d'organisation des fichiers (avec probablement plein de problèmes à discuter…) :
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
```
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
.
├── app
├── content
├── data
├── modules
│ ├── actes
│ ├── dts
│ ├── ead
│ ├── heimdall
│ ├── inventaires
│ ├── pdf
│ └── tei
└── themes
├── css
├── js
└── templates
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
