From 613b30bdb829d3969ec6f720259be274d1f5fc31 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Fri, 26 Jan 2018 11:19:30 +0000 Subject: [PATCH] [ADF-2201] Fixed broken links (#2890) --- docs/README.md | 1 + docs/authentication.service.md | 2 +- docs/card-view.component.md | 132 ++++++++++++------------ docs/file-uploading-dialog.component.md | 2 +- docs/form-field.model.md | 2 +- docs/search-control.component.md | 3 +- docs/search.component.md | 2 +- docs/task-details.model.md | 10 +- docs/task-header.component.md | 6 +- 9 files changed, 87 insertions(+), 73 deletions(-) diff --git a/docs/README.md b/docs/README.md index addfc509c0..eae8aa1192 100644 --- a/docs/README.md +++ b/docs/README.md @@ -273,6 +273,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Filter model](filter.model.md) | Contains classes related to filters in Process Services. | [Source](../lib/process-services/task-list/models/filter.model.ts) | +| [Task details model](task-details.model.md) | Information about a task. | [Source](../lib/process-services/task-list/models/task-details.model.ts) | ## Services diff --git a/docs/authentication.service.md b/docs/authentication.service.md index b0cdc3ee1e..8c81d3f59b 100644 --- a/docs/authentication.service.md +++ b/docs/authentication.service.md @@ -33,4 +33,4 @@ export class AppComponent { ## Details -The authentication service is used inside the [login component](../ng2-components/ng2-alfresco-login/README.md) and is possible to find there an example of how to use it. +The authentication service is used inside the [login component](login.component.md) and is possible to find there an example of how to use it. diff --git a/docs/card-view.component.md b/docs/card-view.component.md index 04c78b180e..c333533cc3 100644 --- a/docs/card-view.component.md +++ b/docs/card-view.component.md @@ -8,19 +8,19 @@ Displays a configurable property list renderer. -- [Basic Usage](#basic-usage) - * [Properties](#properties) -- [Details](#details) - * [Editing](#editing) - * [Defining properties](#defining-properties) - + [Card Text Item](#card-text-item) - + [Card Map Item](#card-map-item) - + [Card Date Item](#card-date-item) - * [Defining your custom card Item](#defining-your-custom-card-item) - + [1. Define the model for the custom type](#1-define-the-model-for-the-custom-type) - + [2. Define the component for the custom type](#2-define-the-component-for-the-custom-type) - + [3. Add you custom component to your module's entryComponents list](#3-add-you-custom-component-to-your-modules-entrycomponents-list) -- [See also](#see-also) +- [Basic Usage](#basic-usage) + - [Properties](#properties) +- [Details](#details) + - [Editing](#editing) + - [Defining properties](#defining-properties) + - [Card Text Item](#card-text-item) + - [Card Map Item](#card-map-item) + - [Card Date Item](#card-date-item) + - [Defining your custom card Item](#defining-your-custom-card-item) + - [1. Define the model for the custom type](#1-define-the-model-for-the-custom-type) + - [2. Define the component for the custom type](#2-define-the-component-for-the-custom-type) + - [3. Add you custom component to your module's entryComponents list](#3-add-you-custom-component-to-your-modules-entrycomponents-list) +- [See also](#see-also) @@ -33,14 +33,13 @@ Displays a configurable property list renderer. [properties]="[{label: 'My Label', value: 'My value'}]" [editable]="false"> - ``` ### Properties | Name | Type | Default | Description | -| --- | --- | --- | --- | -| properties | [CardViewItem](#cardviewitem)[] | - | (**required**) The custom view to render | +| ---- | ---- | ------- | ----------- | +| properties | [CardViewItem](#defining-properties)\[] | - | (**required**) The custom view to render | | editable | boolean | - | If the component editable or not | | displayEmpty | boolean | true | Whether to show empty properties in non-editable mode | @@ -51,8 +50,9 @@ You define the property list, the CardViewComponent does the rest. Each property ### Editing The card view can optionally allow its properties to be edited. You can control the editing of the properties in two level. -- **global level** - *via the editable parameter of the card-view.component* -- **property level** - *in each property via the editable attribute* + +- **global level** - _via the editable parameter of the card-view.component_ +- **property level** - _in each property via the editable attribute_ If you set the global editable parameter to false, no properties can be edited regardless of what is set inside the property. @@ -78,13 +78,13 @@ export interface CardViewItem { At the moment these are the models supported: -- **CardViewTextItemModel** - *for text items* -- **CardViewMapItemModel** - *for map items* -- **CardViewDateItemModel** - *for date items* -- **CardViewDatetimeItemModel** - *for datetime items* -- **CardViewBoolItemModel** - *for bool items (checkbox)* -- **CardViewIntItemModel** - *for integers items* -- **CardViewFloatItemModel** - *for float items* +- **CardViewTextItemModel** - _for text items_ +- **CardViewMapItemModel** - _for map items_ +- **CardViewDateItemModel** - _for date items_ +- **CardViewDatetimeItemModel** - _for datetime items_ +- **CardViewBoolItemModel** - _for bool items (checkbox)_ +- **CardViewIntItemModel** - _for integers items_ +- **CardViewFloatItemModel** - _for float items_ Each of them extends the abstract CardViewBaseItemModel class to add some custom functionality to the basic behaviour. @@ -151,16 +151,16 @@ const textItemProperty = new CardViewTextItemModel(options); ``` | Name | Type | Default | Description | -| --- | --- | --- | --- | -| label* | string | --- | The label to render | -| value* | any | --- | The original value | -| key* | string | --- | the key of the property. Have an important role when editing the property. | +| ---- | ---- | ------- | ----------- | +| label\* | string | --- | The label to render | +| value\* | any | --- | The original value | +| key\* | string | --- | the key of the property. Have an important role when editing the property. | | default | any | --- | The default value to render in case the value is empty | -| displayValue* | string | --- | The value to render | +| displayValue\* | string | --- | The value to render | | editable | boolean | false | Whether the property editable or not | | clickable | boolean | false | Whether the property clickable or not | | multiline | string | false | Single or multiline text | -| pipes | CardViewTextItemPipeProperty[] | [] | Pipes to be applied on the displayValue | +| pipes | CardViewTextItemPipeProperty\[] | \[] | Pipes to be applied on the displayValue | ##### Using pipes in Card Text Item @@ -190,12 +190,12 @@ const mapItemProperty = new CardViewMapItemModel(options); ``` | Name | Type | Default | Description | -| --- | --- | --- | --- | -| label* | string | --- | The label to render | -| value* | Map | --- | A map that contains the key value pairs | -| key* | string | --- | the key of the property. | +| ---- | ---- | ------- | ----------- | +| label\* | string | --- | The label to render | +| value\* | Map | --- | A map that contains the key value pairs | +| key\* | string | --- | the key of the property. | | default | any | --- | The default value to render in case the value is empty | -| displayValue* | string | --- | The value to render | +| displayValue\* | string | --- | The value to render | | clickable | boolean | false | Whether the property clickable or not | #### Card Date Item @@ -207,12 +207,12 @@ const dateItemProperty = new CardViewDateItemModel(options); ``` | Name | Type | Default | Description | -| --- | --- | --- | --- | -| label* | string | --- | The label to render | -| value* | any | --- | The original value | -| key* | string | --- | the key of the property. | +| ---- | ---- | ------- | ----------- | +| label\* | string | --- | The label to render | +| value\* | any | --- | The original value | +| key\* | string | --- | the key of the property. | | default | any | --- | The default value to render in case the value is empty | -| displayValue* | any | --- | The value to render | +| displayValue\* | any | --- | The value to render | | editable | boolean | false | Whether the property editable or not | | format | boolean | "MMM DD YYYY" | any format that momentjs accepts | @@ -225,12 +225,12 @@ const datetimeItemProperty = new CardViewDatetimeItemModel(options); ``` | Name | Type | Default | Description | -| --- | --- | --- | --- | -| label* | string | --- | The label to render | -| value* | any | --- | The original value | -| key* | string | --- | the key of the property. | +| ---- | ---- | ------- | ----------- | +| label\* | string | --- | The label to render | +| value\* | any | --- | The original value | +| key\* | string | --- | the key of the property. | | default | any | any | The default value to render in case the value is empty | -| displayValue* | string | --- | The value to render | +| displayValue\* | string | --- | The value to render | | editable | boolean | false | Whether the property editable or not | | format | boolean | "MMM DD YYYY HH:mm" | any format that momentjs accepts | @@ -243,12 +243,12 @@ const boolItemProperty = new CardViewBoolItemModel(options); ``` | Name | Type | Default | Description | -| --- | --- | --- | --- | -| label* | string | --- | The label to render | -| value* | boolean | --- | The original value | -| key* | string | --- | the key of the property. | +| ---- | ---- | ------- | ----------- | +| label\* | string | --- | The label to render | +| value\* | boolean | --- | The original value | +| key\* | string | --- | the key of the property. | | default | boolean | false | The default value to render in case the value is empty | -| displayValue* | boolean | --- | The value to render | +| displayValue\* | boolean | --- | The value to render | | editable | boolean | false | Whether the property editable or not | #### Card Int Item @@ -260,12 +260,12 @@ const intItemProperty = new CardViewIntItemModel(options); ``` | Name | Type | Default | Description | -| --- | --- | --- | --- | -| label* | string | --- | The label to render | -| value* | integer | --- | The original value | -| key* | string | --- | the key of the property. | +| ---- | ---- | ------- | ----------- | +| label\* | string | --- | The label to render | +| value\* | integer | --- | The original value | +| key\* | string | --- | the key of the property. | | default | integer | --- | The default value to render in case the value is empty | -| displayValue* | integer | --- | The value to render | +| displayValue\* | integer | --- | The value to render | | editable | boolean | false | Whether the property editable or not | #### Card Float Item @@ -277,12 +277,12 @@ const floatItemProperty = new CardViewFloatItemModel(options); ``` | Name | Type | Default | Description | -| --- | --- | --- | --- | -| label* | string | --- | The label to render | -| value* | float | --- | The original value | -| key* | string | --- | the key of the property. | +| ---- | ---- | ------- | ----------- | +| label\* | string | --- | The label to render | +| value\* | float | --- | The original value | +| key\* | string | --- | the key of the property. | | default | float | --- | The default value to render in case the value is empty | -| displayValue* | float | --- | The value to render | +| displayValue\* | float | --- | The value to render | | editable | boolean | false | Whether the property editable or not | ### Defining your custom card Item @@ -294,7 +294,7 @@ Let's consider you want to have a **stardate** type to display Captain Picard's #### 1. Define the Model for the custom type Your model has to extend the **CardViewBaseItemModel** and implement the **CardViewItem** and **DynamicComponentModel** interface. -*(You can check how the CardViewTextItemModel is implemented for further guidance.)* +_(You can check how the CardViewTextItemModel is implemented for further guidance.)_ ```js import { CardViewBaseItemModel, CardViewItem, DynamicComponentModel } from '@alfresco/adf-core'; @@ -339,8 +339,8 @@ export class CardViewStarDateItemComponent { ... } } - ``` + To make your component editable, you can have a look on either the CardViewTextItemComponent' or on the CardViewDateItemComponent's source. #### 3. Add you custom component to your module's entryComponents list @@ -383,8 +383,10 @@ export class SomeParentComponent { ``` + + ## See also -- [Card view update service](card-view-update.service.md) - \ No newline at end of file +- [Card view update service](card-view-update.service.md) + diff --git a/docs/file-uploading-dialog.component.md b/docs/file-uploading-dialog.component.md index 2d8b073d59..26f549b6a2 100644 --- a/docs/file-uploading-dialog.component.md +++ b/docs/file-uploading-dialog.component.md @@ -18,7 +18,7 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are This component should be used in combination with the [Upload Button component](upload-button.component.md) or the -[Drag Area component](drag-area.component.md). +[Upload Drag Area component](upload-drag-area.component.md). ## See also diff --git a/docs/form-field.model.md b/docs/form-field.model.md index 66210ae06e..785de085fe 100644 --- a/docs/form-field.model.md +++ b/docs/form-field.model.md @@ -43,7 +43,7 @@ Contains the value and metadata for a field of an [ADF Form](form.component.md). | fields | FormFieldModel\[] | \[] | Fields contained within a container field | | columns | ContainerColumnModel\[] | \[] | Column definitions for a container field | | emptyOption | FormFieldOption | | Dropdown menu item to use when no option is chosen | -| validationSummary | string | | Error/information message added during field validation (see [FormFieldValidator](FormFieldValidator) interface) | +| validationSummary | string | | Error/information message added during field validation (see [FormFieldValidator](FormFieldValidator.md) interface) | ## Details diff --git a/docs/search-control.component.md b/docs/search-control.component.md index 13ae9a1ad8..fa492e3adb 100644 --- a/docs/search-control.component.md +++ b/docs/search-control.component.md @@ -25,8 +25,7 @@ Displays a input text which shows find-as-you-type suggestions. | expandable | boolean | true | Whether to use an expanding search control, if false then a regular input is used. | | liveSearchEnabled | boolean | true | Whether find-as-you-type suggestions should be offered for matching content items. Set to false to disable. | | liveSearchMaxResults | number | 5 | Maximum number of results to show in the live search. | -| customQueryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](./search.component.md#querybody)| - +| customQueryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](search-configuration.interface.md) | ### Events diff --git a/docs/search.component.md b/docs/search.component.md index 0efcdcedbf..e7b8f6b709 100644 --- a/docs/search.component.md +++ b/docs/search.component.md @@ -19,7 +19,7 @@ Searches items for supplied search terms. | maxResults | number | 20 | Maximum number of results to show in the search. | | skipResults | number | 0 | Number of results to skip from the results pagination. | | displayWith | function | | Function that maps an option's value to its display value in the trigger | -| queryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](./search.component.md#custom-search-configuration) | +| queryBody | [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution [here](search-configuration.interface.md) | ### Events diff --git a/docs/task-details.model.md b/docs/task-details.model.md index 9e3928a6e1..99f5addb01 100644 --- a/docs/task-details.model.md +++ b/docs/task-details.model.md @@ -1,4 +1,8 @@ -# TaskDetailsModel +# Task Details model + +Information about a task. + +## Details ```json { @@ -9,3 +13,7 @@ "description": "string" } ``` + +## See Also + +- [Task header component](task-header.component.md) diff --git a/docs/task-header.component.md b/docs/task-header.component.md index 6f01d3279c..c85607fc73 100644 --- a/docs/task-header.component.md +++ b/docs/task-header.component.md @@ -16,7 +16,7 @@ Shows all the information related to a task. | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | -| taskDetails | [TaskDetailsModel](#taskdetailsmodel) | | (**required**) The task details related to the task. | +| taskDetails | [TaskDetailsModel](task-details.model.md) | | (**required**) Details related to the task. | | formName | string | | The name of the form. | ### Events @@ -29,3 +29,7 @@ Shows all the information related to a task. ## Details The purpose of the component is to populate the local variable called `properties` (array of CardViewModel), with all the information that we want to display. + +## See also + +- [Task Details model](task-details.model.md)