Draft preview. This draft factsheet remains excluded from formal publication outputs.
Factsheet
teiCrafter: A Browser-Based TEI XML Editor with Optional LLM Support — A Self-Audit
Reviewed resource
People
Developer
- Christopher Pollin
Institution
- Digital Humanities Craft OG
Questionnaire
General information
Software type cf. Catalogue 0.1.1
What type of software is it?
Answer Software tool
Explanation
Software type
- Software tool — A “Tool” is broadly defined as a computational application to be used for accomplishing one task or a number of related tasks in the process of digital scholarly editing.
- Virtual Reseaerch Environment (VRE) — An “environment” is defined as a platform on which various tools (independent or not) are working as an integrated whole in order to perform a series of tasks or to cover the entire workflow.
Identification of the environment cf. Catalogue 1.4
On which platform runs the tool?
Answer Web browser
Explanation
Identification of the environment
- Operating system — e.g. for stand-alone applications
- Web browser — for web-based applications, web-services, and APIs
- Another application — i.e., a plugin
Purpose cf. Catalogue 1.5
For what purpose was the tool developed?
Answer developed to accomplish a general task
Methods and implementation
Programming Language cf. Catalogue 2.3
Which programming languages and technologies are used?
Answer Other: JavaScript (native ES modules), HTML, and CSS
Input format cf. Catalogue 2.4
Which input formats are supported?
Answer .xml, .xml/tei, .txt, Other: .md; JPEG and PNG page images
Encoding preprocessing
Is a pre-processing conversion included?
Answer Yes
Dependencies cf. Catalogue 3.2
Does the documentation list dependencies on other software, libraries or hardware?
Answer Yes
Dependencies installation
If yes, is the software handling the installation of dependencies during the general installation process (you don't have to install them manually before the installation)?
Answer Yes
Documentation and support
Documentation cf. Catalogue 3.4
Is documentation and/or a manual available? (tool website, wiki, blog, documentation, or tutorial)
Answer Yes
Documentation parts cf. Catalogue 3.3
Which of the following sections does the documentation contain?
Answer ‘Getting Started’ section (installation and configuration), Step-by-step instructions, Examples, Support
Documentation language cf. Catalogue 3.3
In what languages is the documentation available?
Answer English
Support cf. Catalogue 3.4
Is there a method to get active support from the developer(s) or from the community?
Answer Yes
From of support cf. Catalogue 3.4
Which form of support is offered?
Answer Other: GitHub issue tracker; security reports by email
Issue tracker cf. Catalogue 3.4
Is it possible to post bugs or issue using issue tracker mechanisms?
Answer Yes
Usability and sustainability
Build and install cf. Catalogue 3.6
Grade how straightforward it is to build or install the tool on a supported platform:
Answer straightforward
Tests cf. Catalogue 3.7
Is there a test suite, covering the core functionality in order to check that the tool has been correctly built or installed?
Answer Yes
Portability and interoperability cf. Catalogue 3.8
On which platforms can the tool/software be deployed?
Answer Not applicable (if web-based for example)
Devices cf. Catalogue 3.8
On which devices can the tool/software be deployed?
Answer Desktop, Laptop
Browsers cf. Catalogue 3.8
If the tool is web-based: On which browsers can the tool/software be deployed?
Answer Google Chrome, Other: Codex in-app Chromium browser
Plugins cf. Catalogue 3.8
If the tool is web-based: Does the tool rely on browser plugins?
Answer No
Credits cf. Catalogue 3.9
Does the software make adequate acknowledgement and credit to the project contributors?
Answer Yes
Possible contribution
If yes, can you contribute to the software development via the repository/development platform?
Answer Yes
Analysability, extensibility, reusability of the code
Analysability cf. Catalogue 3.10
Can the code be analyzed easily (is it structured, commented, following standards)?
Answer Yes
Extensibility cf. Catalogue 3.10
Can the code be extended easily (because there are contribution mechanisms, attribution for changes and backward compatibility)?
Answer Unknown
Reusability cf. Catalogue 3.10
Can the code be reused easily in other contexts (because there are appropriate interfaces and/or a modular architecture)?
Answer Yes
Security and privacy cf. Catalogue 3.11
Does the software provide sufficient information about the treatment of the data entered by the users?
Answer Yes
Supportability and maintenance cf. Catalogue 3.12
Is there information available whether the tool will be supported currently and in the future?
Answer Yes
Citability cf. Catalogue 3.13
Does the tool supply citation guidelines (e.g. using the Citation File Format)?
Answer Yes
User interaction, GUI and visualization
User profile cf. Catalogue 4.1
What kind of users are expected?
Answer Humanities researcher, Digital humanist
User interaction cf. Catalogue 4.1
What kind of user interactions are expected?
Answer Reading, Text editing, Searching, Comparing
User Interface cf. Catalogue 4.2 and 0.1.1
What kind of interface does the tool provide?
Answer Graphical User Interface (GUI)
Visualization cf. Catalogue 4.3
Does the tool provide a particular visualizations (in terms of analysis) of the input and/or the output data?
Answer No
User empowerment cf. Catalogue 4.4
Is the user allowed to customize the functioning of the tool and the output configuration?
Answer Yes
Accessibility cf. Catalogue 4.5
Does the tool provide particular features for improving accessibility, allowing „people with the widest range of characteristics and capabilities" to use it?
Answer Yes