Skip to content

Commit

Permalink
Update asset path
Browse files Browse the repository at this point in the history
  • Loading branch information
Jakob Jünger committed Dec 17, 2024
1 parent 7ed4a00 commit 01835bf
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/backend/controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,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](/docs/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:

Expand All @@ -192,7 +192,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](/docs/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:

Expand Down
4 changes: 2 additions & 2 deletions docs/backend/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,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)](/docs/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:
Expand Down Expand Up @@ -66,7 +66,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)](/docs/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:

Expand Down
2 changes: 1 addition & 1 deletion docs/backend/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,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](/docs/assets/img/classes-views.png){: width="55%"}
![View class hierarchy](assets/img/classes-views.png){: width="55%"}


## Rendering HTML for the Browser
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The data model supports research databases ranging from epistolary editions to s
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.

![Epigraf use cases](/docs/assets/img/epigraf-use-cases.png)
![Epigraf use cases](assets/img/epigraf-use-cases.png)

*Note about the development status:* Epigraf has a history.
You will find archeological layers and legacy code from former development epochs
Expand All @@ -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.

![Edit with Epigraf](/docs/assets/img/edit-with-epigraf_playground~394.png)
![Edit with Epigraf](assets/img/edit-with-epigraf_playground~394.png)

# Getting Started

Expand Down Expand Up @@ -75,7 +75,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](/docs/assets/img/epigraf-architecture.png){:width="90%"}
![Epigraf architecture](assets/img/epigraf-architecture.png){:width="90%"}

# Directory structure

Expand Down

0 comments on commit 01835bf

Please sign in to comment.