diff --git a/docs/README.md b/docs/README.md index a31ce17d76..82bfdeeca2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -141,7 +141,7 @@ for more information about installing and using the source code. | [Discovery api service](core/discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/services/discovery-api.service.ts) | | [Favorites api service](core/favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/services/favorites-api.service.ts) | | [Highlight transform service](core/highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/services/highlight-transform.service.ts) | -| [Log service](process-services/log.service.md) | Provide a log functionality for your ADF application. | [Source](../lib/core/services/log.service.ts) | +| [Log service](core/log.service.md) | Provide a log functionality for your ADF application. | [Source](../lib/core/services/log.service.ts) | | [Nodes api service](core/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) | | [Notification service](core/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/services/notification.service.ts) | | [Page title service](core/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | @@ -226,7 +226,7 @@ for more information about installing and using the source code. | [Folder create directive](content-services/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) | | [Folder edit directive](content-services/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) | | [Inherited button directive](content-services/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/permission-manager/components/inherited-button.directive.ts) | -| [File draggable directive](core/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a `div`. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) | +| [File draggable directive](content-services/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a `div`. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) | ## Models diff --git a/docs/core/file-draggable.directive.md b/docs/content-services/file-draggable.directive.md similarity index 100% rename from docs/core/file-draggable.directive.md rename to docs/content-services/file-draggable.directive.md diff --git a/docs/core/apps-process.service.md b/docs/core/apps-process.service.md index f49e981fcf..003335362a 100644 --- a/docs/core/apps-process.service.md +++ b/docs/core/apps-process.service.md @@ -28,7 +28,8 @@ Gets details of the Process Services apps that are deployed for the user. This service can be used to access the Process Services apps that are available to the current user. You can find more information about the -returned `AppDefinitionRepresentation` class in the [Filter model page](filter.model.md) +returned `AppDefinitionRepresentation` class in the +[Filter model page](../process-services/filter.model.md) and in the [Process Services Apps API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppsApi.md#getAppDefinitions). The methods of this service make use of the @@ -37,4 +38,4 @@ method, also from the Apps API. ## See also -- [Filter model](filter.model.md) +- [Filter model](../process-services/filter.model.md) diff --git a/docs/process-services/log.service.md b/docs/core/log.service.md similarity index 100% rename from docs/process-services/log.service.md rename to docs/core/log.service.md diff --git a/docs/process-services/filter.model.md b/docs/process-services/filter.model.md index 10232fbaa0..cdcd1afed7 100644 --- a/docs/process-services/filter.model.md +++ b/docs/process-services/filter.model.md @@ -70,4 +70,4 @@ class TaskQueryRequestRepresentationModel implements TaskQueryRequestRepresentat - [Process filters component](process-filters.component.md) - [Task filters component](task-filters.component.md) -- [Apps process service](apps-process.service.md) +- [Apps process service](../core/apps-process.service.md) diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md index 08451e154b..cbe939d9b1 100644 --- a/docs/tutorials/README.md +++ b/docs/tutorials/README.md @@ -15,6 +15,6 @@ The tutorials are graded as follows: | Name | Level | Abstract | | -- | -- | -- | | [**Preparing the development environment**](preparing-environment.md) | Beginner | In this content is shared all the prerequisites valid for all the tutorials and descriptions of the entire documentation. This content contains the development environment description, along with the details of the suggested versions for each tools, library or module. | -| [**Adding a new component**](new-component.md) | Beginner | By definition a _component_ controls a patch of screen called a view. As an example, individual components define and control menus, tabs, forms, buttons and every simple or complex portion of layout of an application. In this tutorial you will learn how to create a component using [Angular CLI](https://cli.angular.io/). After the creation you will learn how to add it to an existing application. | -| [**Adding a new view**](new-view.md) | Beginner | Every application developed in Angular is a single page application where the concepts of _view_ and _routing_ play a key role in the user experience. Being a single page application, the navigation between the different layouts (called _views_) is enabled through the _routing_. In this tutorial you will learn how to create a new view into your application and how to have access to it using a defined endpoint. | +| [**Adding a new component**](new-component.md) | | By definition a _component_ controls a patch of screen called a view. As an example, individual components define and control menus, tabs, forms, buttons and every simple or complex portion of layout of an application. In this tutorial you will learn how to create a component using [Angular CLI](https://cli.angular.io/). After the creation you will learn how to add it to an existing application. | +| [**Adding a new component**](new-view.md) | Beginner | By definition a _component_ controls a patch of screen called a view. As an example, individual components define and control menus, tabs, forms, buttons and every simple or complex portion of layout of an application. In this tutorial you will learn how to create a component using [Angular CLI](https://cli.angular.io/). After the creation you will learn how to add it to an existing application. | | [**Using components**](using-components.md) | Beginner | There are three different ways to use, extend and configure an ADF component: configuration properties, event listeners, content projection / HTML extensions. In this tutorial you are going to see a practical example for each approach. As an example, the Login component will be used. | diff --git a/docs/tutorials/using-conponents.md b/docs/tutorials/using-components.md similarity index 95% rename from docs/tutorials/using-conponents.md rename to docs/tutorials/using-components.md index a523d80a18..98008a133a 100644 --- a/docs/tutorials/using-conponents.md +++ b/docs/tutorials/using-components.md @@ -2,13 +2,14 @@ Level: Beginner --- # Using components + +There are three different ways to use, extend and configure an ADF component: configuration properties, event listeners, content projection / HTML extensions. In this tutorial you are going to see a practical example for each approach. As an example, the Login component will be used. + The best option you should consider when you plan to use an ADF component and want to learn the details of its usage, is always to check the documentation for the component you are looking to use. More in general, there are three different ways to use, extend and configure an ADF component: 1. Configuration properties. 2. Event listeners. 3. Content projection / HTML extensions. -In this tutorial you are going to see a practical example for each approach. As an example, the [Login component](https://alfresco.github.io/adf-component-catalog/components/LoginComponent.html) will be used. - ## Configuration properties Angular components can easily be configured via properties in the HTML template. In this example we will act on the "Remember me" check and "Need Help?" + "Register" links in the footer of the Login component. diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 2744ffc5c0..64ca65aab2 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -87,7 +87,7 @@ ADF version in which they were introduced. See the - [Ecm user model](core/ecm-user.model.md) - [Ecm user service](core/ecm-user.service.md) - [Favorites api service](core/favorites-api.service.md) -- [File draggable directive](core/file-draggable.directive.md) +- [File draggable directive](content-services/file-draggable.directive.md) - [File size pipe](core/file-size.pipe.md) - [File uploading dialog component](content-services/file-uploading-dialog.component.md) - [Filter model](process-services/filter.model.md) @@ -108,7 +108,7 @@ ADF version in which they were introduced. See the - [Info drawer component](core/info-drawer.component.md) - [Language menu component](core/language-menu.component.md) - [Like component](content-services/like.component.md) -- [Log service](process-services/log.service.md) +- [Log service](core/log.service.md) - [Login component](core/login.component.md) - [Logout directive](core/logout.directive.md) - [Mime type icon pipe](core/mime-type-icon.pipe.md)