diff --git a/README.md b/README.md index d8e014825..e1e1bdc9b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This project was generated with [Angular CLI](https://github.com/angular/angular ## 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. ## Code scaffolding diff --git a/docs/README.md b/docs/README.md index b139bd934..dd04a4138 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,7 +22,7 @@ This application uses the latest releases from Alfresco: - [Alfresco Community Edition 201707](https://www.alfresco.com/products/community/download)

-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 node.js (8.9.1 or later) installed to build it locally from source code.

The latest version of the Alfresco Content platform is required diff --git a/docs/configuration.md b/docs/configuration.md index c07b42711..bdf2ad0f0 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -111,7 +111,7 @@ By default, the application ships with the following rules already predefined: ```

-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: Upload Service.

### 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.

-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 AppConfigService documentation to get more details on Application Configuration features and API available.

diff --git a/docs/doc-list.md b/docs/doc-list.md index 49f698bac..8fe776bc7 100644 --- a/docs/doc-list.md +++ b/docs/doc-list.md @@ -84,7 +84,7 @@ actions are automatically hidden when the user does not have permission. View - 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 Preview component, where the file cannot be displayed natively in a browser a PDF rendition is obtained from the repository. Not applicable @@ -110,7 +110,7 @@ actions are automatically hidden when the user does not have permission. Copy 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; + content-node-selector component; once the copy action has completed the user is notified and can undo the action (which permanently deletes the created copies). @@ -118,7 +118,7 @@ actions are automatically hidden when the user does not have permission. Move 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; + content-node-selector 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). diff --git a/docs/images/navigation-01.png b/docs/images/navigation-01.png index 55d205fef..51fff3866 100644 Binary files a/docs/images/navigation-01.png and b/docs/images/navigation-01.png differ diff --git a/docs/images/navigation-02.png b/docs/images/navigation-02.png index 962fa9428..3069943e0 100644 Binary files a/docs/images/navigation-02.png and b/docs/images/navigation-02.png differ diff --git a/docs/images/navigation-03.png b/docs/images/navigation-03.png index a6119996b..95d7216cc 100644 Binary files a/docs/images/navigation-03.png and b/docs/images/navigation-03.png differ diff --git a/docs/navigation.md b/docs/navigation.md index e1c656b3a..4a283a272 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -61,7 +61,7 @@ To change the `title` and `label` of navigation links edit the values under `BRO ```json "APP" : { ... - BROWSE: { + "BROWSE": { "PERSONAL": { "TITLE": "Personal Files", "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. -```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: ` -

{{ title }}

+@Component({ +template: ` +

{{ title }}

` - }) - export class CustomPage { +}) +export class CustomPage { title = 'My Custom Page' - } - +} ``` Register the component in ```app.module.ts``` @@ -107,9 +105,9 @@ Register the component in ```app.module.ts``` @NgModule({ ... 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 ```json - { ..., "navigation": [ "main": [ ... ], - "secondary: [ ... ], + "secondary": [ ... ], "custom": [ { "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. -```json +```js import { CustomPage } from './components/custom-page/custom-page.component.ts'; diff --git a/docs/side-nav.md b/docs/side-nav.md index 6a5b3480d..98ac4258d 100644 --- a/docs/side-nav.md +++ b/docs/side-nav.md @@ -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). 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.