Sync with development (#144)

* fix navigation docs issues

* update documentation (#142)

* update documentation

changed start command
used a tags for links nested inside table and p tags, because Github did not render them correctly

* set link to navigation on side-nav.md
This commit is contained in:
Denys Vuika 2017-12-14 11:00:57 +00:00 committed by GitHub
parent f0a7bf3a75
commit 7d16f13355
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 23 additions and 27 deletions

View File

@ -6,7 +6,7 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
## Development server ## Development server
Run `ng start` for a dev server. Navigate to `http://localhost:3000/` (opens by default). Run `npm start` for a dev server. Navigate to `http://localhost:3000/` (opens by default).
The app will automatically reload if you change any of the source files. The app will automatically reload if you change any of the source files.
## Code scaffolding ## Code scaffolding

View File

@ -22,7 +22,7 @@ This application uses the latest releases from Alfresco:
- [Alfresco Community Edition 201707](https://www.alfresco.com/products/community/download) - [Alfresco Community Edition 201707](https://www.alfresco.com/products/community/download)
<p class="warning"> <p class="warning">
You also need [node.js](https://nodejs.org/en/) (8.9.1 or later) installed to build it locally from source code. You also need <a href="https://nodejs.org/en/" target="_blank">node.js</a> (8.9.1 or later) installed to build it locally from source code.
</p> </p>
The latest version of the Alfresco Content platform is required The latest version of the Alfresco Content platform is required

View File

@ -111,7 +111,7 @@ By default, the application ships with the following rules already predefined:
``` ```
<p class="tip"> <p class="tip">
You can get more details on the supported rules in the following article: [Upload Service](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/upload.service.md). You can get more details on the supported rules in the following article: <a href="https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/upload.service.md" target="_blank">Upload Service</a>.
</p> </p>
### Pagination settings ### Pagination settings
@ -137,5 +137,5 @@ You can change the default settings of the pagination that gets applied to all t
You can store any information in the application configuration file, and access it at runtime by using the `AppConfigService` service provided by ADF. You can store any information in the application configuration file, and access it at runtime by using the `AppConfigService` service provided by ADF.
<p class="tip"> <p class="tip">
Please refer to the [AppConfigService](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/app-config.service.md) documentation to get more details on Application Configuration features and API available. Please refer to the <a href="https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/app-config.service.md" target="_blank">AppConfigService</a> documentation to get more details on Application Configuration features and API available.
</p> </p>

View File

@ -84,7 +84,7 @@ actions are automatically hidden when the user does not have permission.
<tr> <tr>
<td>View</td> <td>View</td>
<td> <td>
Opens the selected file using the [Preview](https://github.com/Alfresco/alfresco-content-app/tree/development/src/app/components/preview) component, Opens the selected file using the <a href="https://github.com/Alfresco/alfresco-content-app/tree/development/src/app/components/preview" target="_blank">Preview</a> component,
where the file cannot be displayed natively in a browser a PDF rendition is obtained from the repository. where the file cannot be displayed natively in a browser a PDF rendition is obtained from the repository.
</td> </td>
<td>Not applicable</td> <td>Not applicable</td>
@ -110,7 +110,7 @@ actions are automatically hidden when the user does not have permission.
<td>Copy</td> <td>Copy</td>
<td colspan="2"> <td colspan="2">
Files and folders can be copied to another location in the content repository using the Files and folders can be copied to another location in the content repository using the
[content-node-selector](https://alfresco.github.io/adf-component-catalog/components/ContentNodeSelectorComponent.html) component; <a href="https://alfresco.github.io/adf-component-catalog/components/ContentNodeSelectorComponent.html" target="_blank">content-node-selector</a> component;
once the copy action has completed the user is notified and can undo the action (which permanently deletes the created copies). once the copy action has completed the user is notified and can undo the action (which permanently deletes the created copies).
</td> </td>
</tr> </tr>
@ -118,7 +118,7 @@ actions are automatically hidden when the user does not have permission.
<td>Move</td> <td>Move</td>
<td colspan="2"> <td colspan="2">
Files and folders can be moved to another location in the content repository using the Files and folders can be moved to another location in the content repository using the
[content-node-selector](https://alfresco.github.io/adf-component-catalog/components/ContentNodeSelectorComponent.html) component; <a href="https://alfresco.github.io/adf-component-catalog/components/ContentNodeSelectorComponent.html" target="_blank">content-node-selector</a> component;
once the move action has completed the user is notified and can undo the action (which moves the items back to the original location). once the move action has completed the user is notified and can undo the action (which moves the items back to the original location).
</td> </td>
</tr> </tr>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

@ -61,7 +61,7 @@ To change the `title` and `label` of navigation links edit the values under `BRO
```json ```json
"APP" : { "APP" : {
... ...
BROWSE: { "BROWSE": {
"PERSONAL": { "PERSONAL": {
"TITLE": "Personal Files", "TITLE": "Personal Files",
"SIDENAV_LINK": { "SIDENAV_LINK": {
@ -80,21 +80,19 @@ For more information about internationalization see [Internationalization (i18n)
To add custom navigation link for the application, first we need to create a component. To add custom navigation link for the application, first we need to create a component.
```src/app/components/custom-page/custom-page.component.ts``` `src/app/components/custom-page/custom-page.component.ts`
```javascript ```js
import { Component } from '@angular/core';
import { Component } from '@angular/core'; @Component({
template: `
@Component({
template: `
<h4>{{ title }}</h4> <h4>{{ title }}</h4>
` `
}) })
export class CustomPage { export class CustomPage {
title = 'My Custom Page' title = 'My Custom Page'
} }
``` ```
Register the component in ```app.module.ts``` Register the component in ```app.module.ts```
@ -109,7 +107,7 @@ Register the component in ```app.module.ts```
declarations: [ declarations: [
..., ...,
CustomPage CustomPage
] ],
... ...
}) })
@ -118,12 +116,11 @@ Register the component in ```app.module.ts```
In the `app.config.json` define a link entry which will point to the custom page In the `app.config.json` define a link entry which will point to the custom page
```json ```json
{ {
..., ...,
"navigation": [ "navigation": [
"main": [ ... ], "main": [ ... ],
"secondary: [ ... ], "secondary": [ ... ],
"custom": [ "custom": [
{ {
"icon": "work", "icon": "work",
@ -141,7 +138,7 @@ In the `app.config.json` define a link entry which will point to the custom page
Map the `/custom-route` in `app.routes.ts` as a child of `LayoutComponent` definition. Map the `/custom-route` in `app.routes.ts` as a child of `LayoutComponent` definition.
```json ```js
import { CustomPage } from './components/custom-page/custom-page.component.ts'; import { CustomPage } from './components/custom-page/custom-page.component.ts';

View File

@ -24,5 +24,4 @@ and uploads can be canceled which will stop uploads in progress or permanently d
The navigation links are configurable via the [app.config.json](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app.config.json). The navigation links are configurable via the [app.config.json](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app.config.json).
Default configuration creates two sections. Default configuration creates two sections.
See [How to work with the side navigation](/) for more information about configuring the side navigation. See [Navigation](/navigation) for more information about configuring the side navigation.