diff --git a/README.md b/README.md index fa7a8f1..1e88c2f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Epigraf logo +Epigraf logo # Epigraf @@ -6,20 +6,19 @@ Epigraf is a research platform for collecting, annotating, linking and publishin The data model supports research databases ranging from epistolary editions to social media corpora. Epigraf is currently used primarily for editing epigraphic data - inscriptions in connection with the objects to which they are attached. It includes a publication system for various document formats such as Word or TEI, structured JSON, XML and CSV data, and triples in TTL, JSON-LD and RDF/XML. - See the [user documentation](https://epigraf.inschriften.net/help) and the [developer documentation](https://digicademy.github.io/epigraf/) for further information. -Want to try it out? Contact us for a test account on one of our machines. - -*Note about the development status:* Epigraf has a history. +Epigraf has a history. You will find archeological layers and legacy code from former development epochs when visiting the code base and documentation. Some of them are well preserved, others are deteriorating. In any case, they provide fertile soil for future development. Look out for the flowers that are in bloom and help nurture the garden. -![Epigraf use cases](assets/img/epigraf-use-cases.png) +**Want to try it out?** Contact us for a test account on one of our machines. + +![Epigraf use cases](docs/assets/img/epigraf-use-cases.png) ## How to run Epigraf diff --git a/docs/assets/img/documentation_frontend.png b/docs/assets/img/documentation_frontend.png deleted file mode 100755 index 846d9f5..0000000 Binary files a/docs/assets/img/documentation_frontend.png and /dev/null differ diff --git a/docs/assets/img/edit-with-epigraf_playground~394.png b/docs/assets/img/edit-with-epigraf_playground~394.png deleted file mode 100755 index 96bd937..0000000 Binary files a/docs/assets/img/edit-with-epigraf_playground~394.png and /dev/null differ diff --git a/docs/assets/img/edit-with-epigraf_stage~61.png b/docs/assets/img/edit-with-epigraf_stage~61.png deleted file mode 100644 index eac32a2..0000000 Binary files a/docs/assets/img/edit-with-epigraf_stage~61.png and /dev/null differ diff --git a/docs/assets/img/epigraf-architecture-ii.png b/docs/assets/img/epigraf-architecture-ii.png deleted file mode 100755 index c0ea5f6..0000000 Binary files a/docs/assets/img/epigraf-architecture-ii.png and /dev/null differ diff --git a/docs/assets/img/epigraf-controller-class-hierarchy.png b/docs/assets/img/epigraf-controller-class-hierarchy.png deleted file mode 100755 index 61fd994..0000000 Binary files a/docs/assets/img/epigraf-controller-class-hierarchy.png and /dev/null differ diff --git a/docs/assets/img/epigraf-model-class-hierarchy-app.png b/docs/assets/img/epigraf-model-class-hierarchy-app.png deleted file mode 100755 index 438a91e..0000000 Binary files a/docs/assets/img/epigraf-model-class-hierarchy-app.png and /dev/null differ diff --git a/docs/assets/img/epigraf-model-class-hierarchy.png b/docs/assets/img/epigraf-model-class-hierarchy.png deleted file mode 100755 index dae462d..0000000 Binary files a/docs/assets/img/epigraf-model-class-hierarchy.png and /dev/null differ diff --git a/docs/assets/img/epigraf-mvc-class-hierarchy-en.png b/docs/assets/img/epigraf-mvc-class-hierarchy-en.png deleted file mode 100755 index b0457dc..0000000 Binary files a/docs/assets/img/epigraf-mvc-class-hierarchy-en.png and /dev/null differ diff --git a/docs/assets/img/epigraf-view-class-hierarchy.png b/docs/assets/img/epigraf-view-class-hierarchy.png deleted file mode 100755 index cd5016c..0000000 Binary files a/docs/assets/img/epigraf-view-class-hierarchy.png and /dev/null differ diff --git a/docs/backend/controller.md b/docs/backend/controller.md index d0ae9d5..8255b5a 100644 --- a/docs/backend/controller.md +++ b/docs/backend/controller.md @@ -170,7 +170,7 @@ User settings in Epigraf are either stored in the user record or in the session. All controllers extend the `AppController` class (`src/Controller/AppController.php`) which is derived from the base `Controller` class provided by the CakePHP framework. -![Application controller class hierarchy](assets/img/classes-controller-app.png){:width="55%"} +![Application controller class hierarchy](/assets/img/classes-controller-app.png){:width="55%"} On the application level, controllers serve the following purposes: @@ -189,7 +189,7 @@ The Epi plugin implements an own `Epi\AppController` class (`plugins/Epi/Control derived from the global AppController, adding functionality for project database handling. All project database controllers within the Epi plugin extend this class. -![Epi plugin controller class hierarchy](assets/img/classes-controller-epi.png){:width="60%"} +![Epi plugin controller class hierarchy](/assets/img/classes-controller-epi.png){:width="60%"} They Epi plugin controllers serve the following purposes: diff --git a/docs/backend/model.md b/docs/backend/model.md index ca7c61e..a4cf1e1 100644 --- a/docs/backend/model.md +++ b/docs/backend/model.md @@ -30,7 +30,7 @@ All Tables are derived from `src/Model/Table/BaseTable.php` and all Entities fro Common methods in the table classes are `findHasParams()` and `findContainFields()` which are used by the controllers to filter and retrieve data from the database based on query parameters. -![Model class hierarchy (App)](assets/img/classes-model-app.png){:width="60%"} +![Model class hierarchy (App)](/assets/img/classes-model-app.png){:width="60%"} There are some pecularities in the models. You may need to read the section about project database models to understand the full picture: @@ -64,7 +64,7 @@ Tables classes are usually derived from `plugins/Epi/src/Model/Table/BaseTable.p and entity classes from `plugins/Epi/src/Model/Entity/BaseEntity.php`. Both project database level base classes extend the corresponding application's base classes. -![Model class hierarchy (Epi)](assets/img/classes-model-epi.png){:width="80%"} +![Model class hierarchy (Epi)](/assets/img/classes-model-epi.png){:width="80%"} Some special cases have to be considered: diff --git a/docs/backend/view.md b/docs/backend/view.md index 318b1a3..78c9926 100644 --- a/docs/backend/view.md +++ b/docs/backend/view.md @@ -13,7 +13,7 @@ different view classes are used. The ApiView based classes are also used in the export pipelines to generate TEI-documents and other structured data formats. -![View class hierarchy](assets/img/classes-views.png){: width="55%"} +![View class hierarchy](/assets/img/classes-views.png){: width="55%"} ## Rendering HTML for the Browser diff --git a/docs/database/datamodel.md b/docs/database/datamodel.md index 1577e82..39776b5 100644 --- a/docs/database/datamodel.md +++ b/docs/database/datamodel.md @@ -44,7 +44,7 @@ The project databases include the following tables: See the user help for further information about the available fields in each table. -![Graphic illustration of the data model](../assets/img/epigraf-data-model.png) +![Graphic illustration of the data model](..//assets/img/epigraf-data-model.png) ## Domain Model Configuration diff --git a/docs/frontend/index.md b/docs/frontend/index.md index ade2db3..59b9d65 100644 --- a/docs/frontend/index.md +++ b/docs/frontend/index.md @@ -12,4 +12,4 @@ For interactive trees, tables and other widgets, Epigraf implements an own EpiWi Bundling JavaScript files, CSS files, language resources and images is done using Webpack. All bundles can be generated at once by calling `npm run build`. -![Edit with Epigraf](assets/img/epigraf-editor.png) +![Edit with Epigraf](/assets/img/epigraf-editor.png) diff --git a/docs/frontend/widgets.md b/docs/frontend/widgets.md index 74e682c..386b42f 100644 --- a/docs/frontend/widgets.md +++ b/docs/frontend/widgets.md @@ -31,7 +31,7 @@ The base classes of the framework are defined in `htdocs/js/base.js`: A document consists of several parts such as sections, footnotes and notes. Document classes hold together the different parts and manage the interaction between them. -![Inheritance hierarchy](assets/img/classes-widget-basemodel.png){:width="24%"} +![Inheritance hierarchy](/assets/img/classes-widget-basemodel.png){:width="24%"} ### The Widget Life Cycle @@ -127,7 +127,7 @@ Frames are HTML elements attached to derivates of the `BaseFrame` class that han - `TabFrame`: Responsible for tab sheets within in sidebars. - `PopupWindow`: Responsible for popups and dialogs. -![Inheritance hierarchy](assets/img/classes-widget-baseframe.png){:width="32%"} +![Inheritance hierarchy](/assets/img/classes-widget-baseframe.png){:width="32%"} The frame classes handle dynamic content loading and trigger the respective widget lifecycle methods: - `loadElement()` displays a DOM element already constructed on the page. @@ -215,7 +215,7 @@ Both are descendants of the `BaseForm` class supporting features for saving data - Handle form validation and the form submission lifecycle. - Emit events for other widgets reacting to content updates. -![Inheritance hierarchy](assets/img/classes-widget-basedocumentmodel.png){:width="70%"} +![Inheritance hierarchy](/assets/img/classes-widget-basedocumentmodel.png){:width="70%"} The `EntityWidget` is used for simple entities, usually displayed in a vertical table. It inherits all methods and properties from the base from widget diff --git a/docs/index.md b/docs/index.md index 96232ce..d478729 100644 --- a/docs/index.md +++ b/docs/index.md @@ -28,7 +28,7 @@ Some of them are well preserved, others are deteriorating. In any case, they provide fertile soil for future development. Look out for the flowers that are in bloom and help nurture the garden. -![Epigraf use cases](assets/img/epigraf-use-cases.png) +![Epigraf use cases](/assets/img/epigraf-use-cases.png) # Getting Started @@ -77,7 +77,7 @@ MariaDB and the file system is used to store [data](/docs/database). There is on user accounts and application-wide data. For the research data, multiple project databases are created. Frontend and database content is cached using Redis. If no Redis server is available, the cache is stored in the file system. -![Epigraf architecture](assets/img/epigraf-architecture.png){:width="90%"} +![Epigraf architecture](/assets/img/epigraf-architecture.png){:width="90%"} # Directory structure