inteligr8/alfresco-content-app
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-content-app.git synced 2025-07-24 17:31:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ACA-2157] Fixed structure, markup and links (#904)

Browse Source 
* [ACA-2157] Added brief description and updated links

* [ACA-2157] Fixed broken image URL
This commit is contained in:
Andy Stark
2019-01-23 07:45:31 +00:00
committed by Denys Vuika
parent a12c60337d
commit a46e16c28a
26 changed files with 106 additions and 219 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/extending/extension-format.md
View File

@@ -25,11 +25,9 @@ The format is represented by a JSON file with the structure similar to the follo
## Schema
You can find the JSON schema at the project root folder: [extension.schema.json](https://github.com/Alfresco/alfresco-content-app/blob/master/extension.schema.json).
You can find the JSON schema at the project root folder: [extension.schema.json](../../extension.schema.json).
<p class="tip">
The Schema allows you to validate extension files, provides code completion and documentation hints.
</p>
**Tip:** The Schema allows you to validate extension files, provides code completion and documentation hints.
```json
{
@@ -54,10 +52,8 @@ The order of declaration defines the order of loading.
}
```
<p class="warning">
All extension files are merged together at runtime.
**Note:** All extension files are merged together at runtime.
This allows plugins to overwrite the code from the main application or to alter other plugins.
</p>
## Startup behavior
@@ -69,10 +65,8 @@ For the sake of speed the files are loaded in parallel, however once everything
After all the external files are fetched, the `Loader` sorts them, removes the metadata properties and stacks the resulting JSON objects on top of each other.
<p class="tip">
Any top-level property name that starts with the `$` symbol is considered metadata and does not participate in the merge process.
**Tip:** Any top-level property name that starts with the `$` symbol is considered metadata and does not participate in the merge process.
That allows a plugin to carry extra information for maintenance and visualisation purposes, for example: `$name`, `$version`, `$description`, `$license`, etc.
</p>
### Merging properties
@@ -112,10 +106,8 @@ Final result:
Note that as a result we have two unique properties `plugin1.key` and `plugin2.key`,
and also a `plugin1.text` that was first defined in the `Plugin 1`, but then overwritten by the `Plugin 2`.
<p class="tip">
JSON merging is a very powerful concept as it gives you the ability to alter any base application settings,
**Tip:** JSON merging is a very powerful concept as it gives you the ability to alter any base application settings,
or toggle features in other plugins without rebuilding the application or corresponding plugin libraries.
</p>
### Merging objects
@@ -216,9 +208,7 @@ You can find more details in the [Disabling Content](/extending/extension-format
The extension `Loader` provides a special support for merging Arrays.
By default, two collections will be merged into a single array unless objects have `id` properties.
<p class="tip">
If array contains two objects with the same `id` property, the objects will be merged rather than appended.
</p>
**Tip:** If the array contains two objects with the same `id` property, the objects will be merged rather than appended.
Before: Plugin 1