diff options
author | Aaron Seigo <aseigo@kde.org> | 2015-12-31 19:00:03 +0100 |
---|---|---|
committer | Aaron Seigo <aseigo@kde.org> | 2015-12-31 19:00:03 +0100 |
commit | a19884338f0cecb2c98215ddef54e3be09bf258b (patch) | |
tree | 2f53a85d043c7b92effe06329a178b1ed1705c8a /docs/design.md | |
parent | 085a2f27086fc22ea984d7c57587d4d9de52c1c5 (diff) | |
download | kube-a19884338f0cecb2c98215ddef54e3be09bf258b.tar.gz kube-a19884338f0cecb2c98215ddef54e3be09bf258b.zip |
use Kube in the docs
Diffstat (limited to 'docs/design.md')
-rw-r--r-- | docs/design.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/design.md b/docs/design.md index 5d6d0754..122d83b6 100644 --- a/docs/design.md +++ b/docs/design.md | |||
@@ -1,7 +1,7 @@ | |||
1 | # Architecture / Design | 1 | # Architecture / Design |
2 | 2 | ||
3 | ## Overview | 3 | ## Overview |
4 | Kontact Quick is supposed to be a small and concise codebase that is easy to modify and evolve. | 4 | Kube is supposed to be a small and concise codebase that is easy to modify and evolve. |
5 | 5 | ||
6 | It's following a reactive model, where in one direction we have controllers generating modifications, and in the other direction models updating themselves on changes. | 6 | It's following a reactive model, where in one direction we have controllers generating modifications, and in the other direction models updating themselves on changes. |
7 | 7 | ||
@@ -23,7 +23,7 @@ The overall architecture is split into three layers; Ui, Domain Logic and Infras | |||
23 | 23 | ||
24 | The UI Layer consists of views (mostly written in QML), view-models (models that are view specific and potentially implement user interaction details), and the glue code to use various controllers from the interface. Different UI layers may exist for different form factors. | 24 | The UI Layer consists of views (mostly written in QML), view-models (models that are view specific and potentially implement user interaction details), and the glue code to use various controllers from the interface. Different UI layers may exist for different form factors. |
25 | 25 | ||
26 | The domain logic layer holds the application state. It povides models to access data and controllers to act upon it. The domain logic is by definition Kontact Quick specific and not sharable with other applications, as it needs to be taylored exactly according to the requirements of Kontact Quick. | 26 | The domain logic layer holds the application state. It povides models to access data and controllers to act upon it. The domain logic is by definition Kube specific and not sharable with other applications, as it needs to be taylored exactly according to the requirements of Kube. |
27 | 27 | ||
28 | The infrastructure layer provides: | 28 | The infrastructure layer provides: |
29 | 29 | ||
@@ -142,9 +142,9 @@ Probably requires access to identities in some way. | |||
142 | * KMime | 142 | * KMime |
143 | 143 | ||
144 | ## Interaction with external applications | 144 | ## Interaction with external applications |
145 | External applications, like the KDE calendar plasmoid, should be able to load parts of Kontact Quick when available. It should for instance be possible to load the Event editor as embeddable QML component, that is fully functional. That way it becomes very easy for third parties to provide extra functionality if Kontact Quick is installed, without having to reimplement the Domain Logic (as is the case if only data access is provided through akonadi). | 145 | External applications, like the KDE calendar plasmoid, should be able to load parts of Kube when available. It should for instance be possible to load the Event editor as embeddable QML component, that is fully functional. That way it becomes very easy for third parties to provide extra functionality if Kube is installed, without having to reimplement the Domain Logic (as is the case if only data access is provided through akonadi). |
146 | 146 | ||
147 | The same mechanism should probably be used by Kontact Quick itself to ensure loose coupling and allow mashups with various content types. | 147 | The same mechanism should probably be used by Kube itself to ensure loose coupling and allow mashups with various content types. |
148 | 148 | ||
149 | Note: We'll probably want a component-viewer application to easily load and test individual components (similar to plasmoidviewer). | 149 | Note: We'll probably want a component-viewer application to easily load and test individual components (similar to plasmoidviewer). |
150 | 150 | ||