Factsheet
| Resource reviewed | |
|---|---|
| Title | Custom Oxygen Frameworks |
| Editors | SyncRo Soft SRL |
| URI | https://www.oxygenxml.com/doc/versions/26.0/ug-editor/topics/authoring_customization.html |
| Publication Date | ~2012-2024 |
| Date of last access | 31.01.2024 |
| Reviewer | |
|---|---|
| Name |  Bunselmeier, Jennifer |
| Affiliation | University of Wuppertal |
| Place | Wuppertal |
| bunselmeier@uni-wuppertal.de | |
| Reviewer | |
|---|---|
| Name | Krottmaier, Sina |
| Affiliation | University of Graz |
| Place | Graz |
| sina.krottmaier@uni-graz.at | |
| General information | ||
|---|---|---|
| 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. | What type of software is it? | Software tool |
| 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 | On which platform runs the tool? | Another application |
| Purpose | For what purpose was the tool developed? | developed to accomplish a general task |
| Funding | Which is the financial model of the tool? | Behind a paywall |
| Maturity | What is the development stage of the tool? | Release |
| Methods and implementation | ||
| Programming Language | Which programming languages and technologies are used? | Java, XSLT, Other: CSS, XQuery |
| Reuse | Does the tool reuse portions of other existing software? |  |
| Input format | Which input formats are supported? | .xml, .xml/tei |
| Output format | Which output formats are supported? | .xml, .xml/tei, .html |
| Encoding | Which character encoding formats are supported? | utf-8, Other: Unicode, US-ASCII, etc. |
| Encoding preprocessing | Is a pre-processing conversion included? | |
| Dependencies | Does the documentation list dependencies on other software, libraries or hardware? | Yes, Oxygen XML Editor |
| 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)? | |
| Documentation and support | ||
| Documentation | Is documentation and/or a manual available? (tool website, wiki, blog, documentation, or tutorial) |  |
| Documentation format | Which format has the documentation? | .html, .pdf, Other: Documentation on Website |
| Documentation parts | Which of the following sections does the documentation contain? | ‘Getting Started’ section (installation and configuration), Step-by-step instructions, API documentation (if relevant) |
| Documentation language | In what languages is the documentation available? | English |
| Support | Is there a method to get active support from the developer(s) or from the community? | |
| From of support | Which form of support is offered? | Forum, Other: Video Tutorials, Technical Support Form, FAQs |
| Issue tracker | Is it possible to post bugs or issue using issue tracker mechanisms? | |
| Usability and sustainability | ||
| Build and install | Grade how straightforward it is to build or install the tool on a supported platform: | straightforward |
| Tests | Is there a test suite, covering the core functionality in order to check that the tool has been correctly built or installed? | |
| Portability and interoperability | On which platforms can the tool/software be deployed? | Linux/BSD/Unix, Mac OS X, Windows |
| Devices | On which devices can the tool/software be deployed? | Desktop, Laptop |
| Browsers | If the tool is web-based: On which browsers can the tool/software be deployed? | Not applicable (if not web-based for example) |
| Plugins | If the tool is web-based: Does the tool rely on browser plugins? |  |
| API | Is there an API for the tool? | |
| Code | Is the source code open? | |
| License | Under what license is the tool released? | No explicit license / all rights reserved |
| Credits | Does the software make adequate acknowledgement and credit to the project contributors? | |
| Registered | Is the tool/software registered in a software repository? | |
| Possible contribution | If yes, can you contribute to the software development via the repository/development platform? | |
| Analysability, extensibility, reusability of the code | ||
| Analysability | Can the code be analyzed easily (is it structured, commented, following standards)? | Unknown |
| Extensibility | Can the code be extended easily (because there are contribution mechanisms, attribution for changes and backward compatibility)? | |
| Reusability | Can the code be reused easily in other contexts (because there are appropriate interfaces and/or a modular architecture)? | |
| Security and privacy | Does the software provide sufficient information about the treatment of the data entered by the users? | |
| Supportability and maintenance | Is there information available whether the tool will be supported currently and in the future? | |
| Citability | Does the tool supply citation guidelines (e.g. using the Citation File Format)? | |
| User interaction, GUI and visualization | ||
| User profile | What kind of users are expected? | Humanities researcher, Digital humanist |
| User interaction | What kind of user interactions are expected? | Text editing, Image editing |
| User Interface | What kind of interface does the tool provide? (cf. Catalogue 4.2 and 0.1.1) | Graphical User Interface (GUI) |
| Visualization | Does the tool provide a particular visualizations (in terms of analysis) of the input and/or the output data? | |
| User empowerment | Is the user allowed to customize the functioning of the tool and the output configuration? | |
| Accessibility | Does the tool provide particular features for improving accessibility, allowing „people with the widest range of characteristics and capabilities” to use it? | |
| Personnel | |
|---|---|
| Editors | SyncRo Soft SRL |
| Programmers | SyncRo Soft SRL |
| Designers | SyncRo Soft SRL |
