inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-3745] Fixed links in rel notes, tutorials and guide (#4179)

Browse Source
This commit is contained in:
Andy Stark
2019-01-17 17:21:23 +00:00
committed by Eugenio Romano
parent 274c4d9389
commit 74475dbd42
29 changed files with 146 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/user-guide/README.md
View File

@@ -13,7 +13,6 @@ on an item below to see the corresponding guide page.
- [Angular Material Design](angular-material-design.md)
- [Form Extensibility and Customisation](extensibility.md)
- [Internationalization in ADF](internationalization.md)
- [App extensions](app-extensions.md)
- [Theming](theming.md)
- [Transclusion](transclusion.md)
- [Typography](typography.md)

2
docs/user-guide/angular-material-design.md
View File

@@ -4,6 +4,8 @@ Title: Angular Material Design
# Angular Material Design
This page describes the Angular Material Design library and how it is used in ADF.
Google's
[Material Design](https://material.io/guidelines/material-design/introduction.html)
is an example of a _design language_, a

6
docs/user-guide/app-extensions.md
View File

@@ -45,7 +45,7 @@ a place in the app where the actual content will be supplied dynamically.
ADF provides a number of features that offer extension points or help
with extensibility in general:
- **Components**: The [Dynamic component](../extensions/dynamic.component.md) and Dynamic Tab component
- **Components**: The [Dynamic component](../extensions/dynamic.component.md) and [Dynamic Tab component](../extensions/dynamic-tab.component.md)
have no content of their own but they have an `id` property that
references a registered component extension ID. The referenced component
will be added as a child of the Dynamic component at runtime.
@@ -79,7 +79,7 @@ with extensibility in general:
## Setting up an app for extensibility
You can register component classes for use with the [Dynamic component](../extensions/dynamic.component.md)
or Dynamic Tab component using the `setComponents` method of the
or [Dynamic Tab component](../extensions/dynamic-tab.component.md) using the `setComponents` method of the
[Extension service](../extensions/extension.service.md) (see the Dynamic component page for further details
and code samples). The service also has `setAuthGuards` and
`setEvaluators` methods that behave analogously.
@@ -174,7 +174,7 @@ The `actions` array has the following structure:
```
The [Extension service](../extensions/extension.service.md) defines a `getActionById` method that returns an
`ActionRef` object corresponding to an item from this array.
[`ActionRef`](../../lib/extensions/src/lib/config/action.extensions.ts) object corresponding to an item from this array.
The `type` property refers to an action type that must be provided by the
app (eg, the "SNACKBAR_INFO" in the example presumably just shows a standard snackbar

2
docs/user-guide/extensibility.md
View File

@@ -5,6 +5,8 @@ Added: v2.0.0
# Form Extensibility and Customization
This page describes how you can customize ADF forms to your own specification.
_Note: it is assumed you are familiar with Alfresco Process Services (powered by Activiti) form definition structure._
- How components and widgets are rendered on a [`Form`](../../lib/process-services/task-list/models/form.model.ts)

14
docs/user-guide/internationalization.md
View File

@@ -7,7 +7,9 @@ Added: v2.2.0
Internationalization (abbreviated to i18n) is the process of providing UI messages
and captions in different human languages to make them easier for readers of those
languages to understand. ADF provides full support for i18n in apps. The process does
languages to understand.
ADF provides full support for i18n in apps. The process does
require some extra effort in planning and designing the UI but once implemented, it is
fairly straightforward to maintain.
@@ -236,20 +238,20 @@ preferences can only be saved by the app when it runs, they will not immediately
the app launches for the first time. The app uses the following priorities to determine
the locale language for the first launch:
1. If the `locale` property is set in `app.config.json` then this will be used.
1. If there is no `locale` property then the browser's language setting will be used instead.
1. If neither of the first two options is available then English will be used by default.
1. If the `locale` property is set in `app.config.json` then this will be used.
2. If there is no `locale` property then the browser's language setting will be used instead.
3. If neither of the first two options is available then English will be used by default.
The table below illustrates how the selection is made:
| User Preference | `locale` in `app.config.json` | Browser language | Default | Result |
| -- | -- | -- | -- | -- |
| --------------- | ----------------------------- | ---------------- | ------- | ------ |
| X | X | X | en | en |
| X | X | jp | en | jp |
| X | fr | jp | en | fr |
| it | fr | jp | en | it |
The translation service probes the browser culture first, for example `en-GB`.
The [translation service](../core/translation.service.md) probes the browser culture first, for example `en-GB`.
If the `en-GB.json` file does not exist, the service falls back to the language id: `en`.
Once the locale language is determined, it is saved to the user preferences and this saved value

6
docs/user-guide/metadata-indicators.md
View File

@@ -57,9 +57,9 @@ The component will expose a `metadata` property we can use from the outside and
```html
<adf-metadata-icons [metadata]="nodeMetadata"></adf-metadata-icons>
```
```
As you have seen earlier the DataColumn binds to `properties` property of the node, and maps the runtime value as the `value` local variable within the template.
As you have seen earlier the [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) binds to `properties` property of the node, and maps the runtime value as the `value` local variable within the template.
Next we propagate the `value` reference to the `<adf-metadata-icons>` component as `metadata` property.
```html
@@ -142,4 +142,4 @@ export class MetadataIconsComponent {
<!-- {% endraw %} -->
You can use this idea to build more complex indication experience based on the actual metadata state.
You can use this idea to build more complex indication experience based on the actual metadata state.

2
docs/user-guide/theming.md
View File

@@ -5,6 +5,8 @@ Added: v2.0.0
# Theming an ADF app
**Theming** is the process of adding your own color scheme to add style to an existing design.
The [Material Design](https://material.io/guidelines/material-design/introduction.html)
specification doesn't specify a single color scheme. Instead it uses the concept
of color **themes** to allow designers some flexibility in their choice of colors.

4
docs/user-guide/transclusion.md
View File

@@ -6,7 +6,9 @@ Added: v2.6.0
# Transclusion
Several components in ADF make use of **transclusion**, which is the technique
of incorporating user-supplied content in the body of a standard component. In
of incorporating user-supplied content in the body of a standard component.
In
most cases, this is used to make small customizations (for example, the various
list components let you supply custom content to show when the list is empty).
However, there are also a few "containers" whose entire content is set by the user

4
docs/user-guide/typography.md
View File

@@ -5,9 +5,7 @@ Added: v2.0.0
# ADF Typography
## What is typography?
Typography configuration lets you change the style of the text in your ADF app
Typography configuration lets you change the style of the text in your ADF app.
## Customization