diff --git a/docs/content-services/add-permission-dialog.component.md b/docs/content-services/add-permission-dialog.component.md index d4bb007790..fb1a8fe35c 100644 --- a/docs/content-services/add-permission-dialog.component.md +++ b/docs/content-services/add-permission-dialog.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# Add Permission Dialog Component +# [Add Permission Dialog Component](../../lib/content-services/permission-manager/components/add-permission/add-permission-dialog.component.ts "Defined in add-permission-dialog.component.ts") Displays a dialog to search for people or groups to add to the current node permissions. diff --git a/docs/content-services/add-permission-panel.component.md b/docs/content-services/add-permission-panel.component.md index edfd79bc8f..f2cb44fc0e 100644 --- a/docs/content-services/add-permission-panel.component.md +++ b/docs/content-services/add-permission-panel.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# Add Permission Panel Component +# [Add Permission Panel Component](../../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts "Defined in add-permission-panel.component.ts") Searches for people or groups to add to the current node permissions. diff --git a/docs/content-services/add-permission.component.md b/docs/content-services/add-permission.component.md index a9d9ebab12..6f38834302 100644 --- a/docs/content-services/add-permission.component.md +++ b/docs/content-services/add-permission.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# Add Permission Component +# [Add Permission Component](../../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts "Defined in add-permission.component.ts") Searches for people or groups to add to the current node permissions. diff --git a/docs/content-services/breadcrumb.component.md b/docs/content-services/breadcrumb.component.md index a8625619b2..89f89644c8 100644 --- a/docs/content-services/breadcrumb.component.md +++ b/docs/content-services/breadcrumb.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# Breadcrumb Component +# [Breadcrumb Component](../../lib/content-services/breadcrumb/breadcrumb.component.ts "Defined in breadcrumb.component.ts") Indicates the current position within a navigation hierarchy. diff --git a/docs/content-services/content-action.component.md b/docs/content-services/content-action.component.md index 995575c2f4..af1bd3abb4 100644 --- a/docs/content-services/content-action.component.md +++ b/docs/content-services/content-action.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# Content Action component +# [Content Action component](../../lib/content-services/document-list/components/content-action/content-action.component.ts "Defined in content-action.component.ts") Adds options to a Document List actions menu for a particular content type. diff --git a/docs/content-services/content-metadata-card.component.md b/docs/content-services/content-metadata-card.component.md index 513a9f14bb..c586bdf519 100644 --- a/docs/content-services/content-metadata-card.component.md +++ b/docs/content-services/content-metadata-card.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-08-07 --- -# Content Metadata Card component +# [Content Metadata Card component](../../lib/content-services/content-metadata/components/content-metadata-card/content-metadata-card.component.ts "Defined in content-metadata-card.component.ts") Displays and edits metadata related to a node. diff --git a/docs/content-services/content-metadata.component.md b/docs/content-services/content-metadata.component.md index 001e8f613e..45c998f932 100644 --- a/docs/content-services/content-metadata.component.md +++ b/docs/content-services/content-metadata.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-08-07 --- -# Content Metadata Card component +# [Content Metadata Card component](../../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts "Defined in content-metadata.component.ts") Displays and edits metadata related to a node. diff --git a/docs/content-services/content-node-dialog.service.md b/docs/content-services/content-node-dialog.service.md index 53b1da090d..8d16d26dcf 100644 --- a/docs/content-services/content-node-dialog.service.md +++ b/docs/content-services/content-node-dialog.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# Content Node Dialog service +# [Content Node Dialog service](../../lib/content-services/content-node-selector/content-node-dialog.service.ts "Defined in content-node-dialog.service.ts") Displays and manages dialogs for selecting content to open, copy or upload. diff --git a/docs/content-services/content-node-selector-panel.component.md b/docs/content-services/content-node-selector-panel.component.md index 7bc5569adc..cc68131f63 100644 --- a/docs/content-services/content-node-selector-panel.component.md +++ b/docs/content-services/content-node-selector-panel.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# Content Node Selector Panel component +# [Content Node Selector Panel component](../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts "Defined in content-node-selector-panel.component.ts") Opens a Content Node Selector in its own dialog window. diff --git a/docs/content-services/content-node-selector.component.md b/docs/content-services/content-node-selector.component.md index 252e214c32..14ed2f00fa 100644 --- a/docs/content-services/content-node-selector.component.md +++ b/docs/content-services/content-node-selector.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-04-18 --- -# Content Node Selector component +# [Content Node Selector component](../../lib/content-services/content-node-selector/content-node-selector.component.ts "Defined in content-node-selector.component.ts") Allows a user to select items from a Content Services repository. diff --git a/docs/content-services/content-node-share.directive.md b/docs/content-services/content-node-share.directive.md index 02134adc03..cc66b1bfa1 100644 --- a/docs/content-services/content-node-share.directive.md +++ b/docs/content-services/content-node-share.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-09-13 --- -# Node Public File Share Directive +# [Node Public File Share Directive](../../lib/content-services/content-node-share/content-node-share.directive.ts "Defined in content-node-share.directive.ts") Creates and manages public shared links for files. diff --git a/docs/content-services/custom-resources.service.md b/docs/content-services/custom-resources.service.md index 3e0a4bce0a..ccba6196bb 100644 --- a/docs/content-services/custom-resources.service.md +++ b/docs/content-services/custom-resources.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-16 --- -# Custom Resources service +# [Custom Resources service](../../lib/content-services/document-list/services/custom-resources.service.ts "Defined in custom-resources.service.ts") Manages Document List information that is specific to a user. diff --git a/docs/content-services/document-actions.service.md b/docs/content-services/document-actions.service.md index 3ea529c36c..e5cc35a895 100644 --- a/docs/content-services/document-actions.service.md +++ b/docs/content-services/document-actions.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# Document Actions service +# [Document Actions service](../../lib/content-services/document-list/services/document-actions.service.ts "Defined in document-actions.service.ts") Implements the document menu actions for the [Document List component](../content-services/document-list.component.md). diff --git a/docs/content-services/document-library.model.md b/docs/content-services/document-library.model.md index b7444943af..8d5807e0b9 100644 --- a/docs/content-services/document-library.model.md +++ b/docs/content-services/document-library.model.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# Document Library model +# [Document Library model](../../lib/content-services/document-list/models/document-library.model.ts "Defined in document-library.model.ts") Defines classes for use with the Content Services node API. diff --git a/docs/content-services/document-list.component.md b/docs/content-services/document-list.component.md index 71a0a51170..8f45a591fb 100644 --- a/docs/content-services/document-list.component.md +++ b/docs/content-services/document-list.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-12 --- -# Document List component +# [Document List component](../../lib/content-services/document-list/components/document-list.component.ts "Defined in document-list.component.ts") Displays the documents from a repository. diff --git a/docs/content-services/document-list.service.md b/docs/content-services/document-list.service.md index a451afb3e5..ff83f2c577 100644 --- a/docs/content-services/document-list.service.md +++ b/docs/content-services/document-list.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-09-13 --- -# Document List service +# [Document List service](../../lib/content-services/document-list/services/document-list.service.ts "Defined in document-list.service.ts") Implements node operations used by the [Document List component](../content-services/document-list.component.md). diff --git a/docs/content-services/dropdown-breadcrumb.component.md b/docs/content-services/dropdown-breadcrumb.component.md index 9436ba777a..ca7252b244 100644 --- a/docs/content-services/dropdown-breadcrumb.component.md +++ b/docs/content-services/dropdown-breadcrumb.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# Dropdown Breadcrumb Component +# [Dropdown Breadcrumb Component](../../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts "Defined in dropdown-breadcrumb.component.ts") Indicates the current position within a navigation hierarchy using a dropdown menu. diff --git a/docs/content-services/file-draggable.directive.md b/docs/content-services/file-draggable.directive.md index b4098c01db..5d16dab3ad 100644 --- a/docs/content-services/file-draggable.directive.md +++ b/docs/content-services/file-draggable.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-04-10 --- -# File Draggable directive +# [File Draggable directive](../../lib/content-services/upload/directives/file-draggable.directive.ts "Defined in file-draggable.directive.ts") Provides drag-and-drop features for an element such as a `div`. diff --git a/docs/content-services/file-uploading-dialog.component.md b/docs/content-services/file-uploading-dialog.component.md index 9ea6137877..472aeab508 100644 --- a/docs/content-services/file-uploading-dialog.component.md +++ b/docs/content-services/file-uploading-dialog.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# File Uploading Dialog Component +# [File Uploading Dialog Component](../../lib/content-services/upload/components/file-uploading-dialog.component.ts "Defined in file-uploading-dialog.component.ts") Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. diff --git a/docs/content-services/folder-actions.service.md b/docs/content-services/folder-actions.service.md index d3ae280458..086c125e8c 100644 --- a/docs/content-services/folder-actions.service.md +++ b/docs/content-services/folder-actions.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# Folder Actions service +# [Folder Actions service](../../lib/content-services/document-list/services/folder-actions.service.ts "Defined in folder-actions.service.ts") Implements the folder menu actions for the [Document List component](../content-services/document-list.component.md). diff --git a/docs/content-services/folder-create.directive.md b/docs/content-services/folder-create.directive.md index 972d5301f7..c6dcd37c99 100644 --- a/docs/content-services/folder-create.directive.md +++ b/docs/content-services/folder-create.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# Folder Create directive +# [Folder Create directive](../../lib/content-services/folder-directive/folder-create.directive.ts "Defined in folder-create.directive.ts") Creates folders. diff --git a/docs/content-services/folder-edit.directive.md b/docs/content-services/folder-edit.directive.md index f29073f95d..3824e34e9d 100644 --- a/docs/content-services/folder-edit.directive.md +++ b/docs/content-services/folder-edit.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-04-10 --- -# Folder Edit directive +# [Folder Edit directive](../../lib/content-services/folder-directive/folder-edit.directive.ts "Defined in folder-edit.directive.ts") Allows folders to be edited. diff --git a/docs/content-services/inherited-button.directive.md b/docs/content-services/inherited-button.directive.md index bd01e195c0..52b51fec0d 100644 --- a/docs/content-services/inherited-button.directive.md +++ b/docs/content-services/inherited-button.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# Inherit Permission directive +# [Inherit Permission directive](../../lib/content-services/permission-manager/components/inherited-button.directive.ts "Defined in inherited-button.directive.ts") Update the current node by adding/removing the inherited permissions. diff --git a/docs/content-services/like.component.md b/docs/content-services/like.component.md index aa8dcd2d6e..36c38bebd3 100644 --- a/docs/content-services/like.component.md +++ b/docs/content-services/like.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# Like component +# [Like component](../../lib/content-services/social/like.component.ts "Defined in like.component.ts") Allows a user to add "likes" to an item. diff --git a/docs/content-services/node-download.directive.md b/docs/content-services/node-download.directive.md index 492a458b3d..7c9a45d2d6 100644 --- a/docs/content-services/node-download.directive.md +++ b/docs/content-services/node-download.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# Node Download directive +# [Node Download directive](../../lib/content-services/directives/node-download.directive.ts "Defined in node-download.directive.ts") Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. diff --git a/docs/content-services/node-lock.directive.md b/docs/content-services/node-lock.directive.md index 59bb60ee60..187a73e2a0 100644 --- a/docs/content-services/node-lock.directive.md +++ b/docs/content-services/node-lock.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# Node Lock directive +# [Node Lock directive](../../lib/content-services/directives/node-lock.directive.ts "Defined in node-lock.directive.ts") Locks a node. diff --git a/docs/content-services/node-permission-dialog.service.md b/docs/content-services/node-permission-dialog.service.md index 378bdcad69..c0493c3536 100644 --- a/docs/content-services/node-permission-dialog.service.md +++ b/docs/content-services/node-permission-dialog.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-09-13 --- -# Node permission dialog service +# [Node permission dialog service](../../lib/content-services/permission-manager/services/node-permission-dialog.service.ts "Defined in node-permission-dialog.service.ts") Displays dialogs to let the user set node permissions. diff --git a/docs/content-services/node-permission.service.md b/docs/content-services/node-permission.service.md index 830bbec279..b2f1ba23b1 100644 --- a/docs/content-services/node-permission.service.md +++ b/docs/content-services/node-permission.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# Node Permission service +# [Node Permission service](../../lib/content-services/permission-manager/services/node-permission.service.ts "Defined in node-permission.service.ts") Manages role permissions for content nodes. diff --git a/docs/content-services/permission-list.component.md b/docs/content-services/permission-list.component.md index 74207e7eb9..b780bba185 100644 --- a/docs/content-services/permission-list.component.md +++ b/docs/content-services/permission-list.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# Permission List Component +# [Permission List Component](../../lib/content-services/permission-manager/components/permission-list/permission-list.component.ts "Defined in permission-list.component.ts") Shows node permissions as a table. diff --git a/docs/content-services/permissions-style.model.md b/docs/content-services/permissions-style.model.md index f33c754911..256b5a852b 100644 --- a/docs/content-services/permissions-style.model.md +++ b/docs/content-services/permissions-style.model.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# Permission Style model +# [Permission Style model](../../lib/content-services/document-list/models/permissions-style.model.ts "Defined in permissions-style.model.ts") Sets custom CSS styles for rows of a Document List according to the item's permissions. diff --git a/docs/content-services/rating.component.md b/docs/content-services/rating.component.md index f115c5d690..7afa78a22c 100644 --- a/docs/content-services/rating.component.md +++ b/docs/content-services/rating.component.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# Rating component +# [Rating component](../../lib/content-services/social/rating.component.ts "Defined in rating.component.ts") Allows a user to add ratings to an item. diff --git a/docs/content-services/rating.service.md b/docs/content-services/rating.service.md index 5569bd168f..041dbc247f 100644 --- a/docs/content-services/rating.service.md +++ b/docs/content-services/rating.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-05-04 --- -# Rating service +# [Rating service](../../lib/content-services/social/services/rating.service.ts "Defined in rating.service.ts") Manages ratings for items in Content Services. diff --git a/docs/content-services/search-check-list.component.md b/docs/content-services/search-check-list.component.md index 4cd04efa0c..8209949bfd 100644 --- a/docs/content-services/search-check-list.component.md +++ b/docs/content-services/search-check-list.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-11 --- -# Search check list component +# [Search check list component](../../lib/content-services/search/components/search-check-list/search-check-list.component.ts "Defined in search-check-list.component.ts") Implements a checklist widget for the [Search Filter component](../content-services/search-filter.component.md). diff --git a/docs/content-services/search-chip-list.component.md b/docs/content-services/search-chip-list.component.md index 275656b10f..170c29c523 100644 --- a/docs/content-services/search-chip-list.component.md +++ b/docs/content-services/search-chip-list.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-09-14 --- -# Search Chip List Component +# [Search Chip List Component](../../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts "Defined in search-chip-list.component.ts") Displays search criteria as a set of "chips". diff --git a/docs/content-services/search-control.component.md b/docs/content-services/search-control.component.md index 99d46476b1..95d5867f38 100644 --- a/docs/content-services/search-control.component.md +++ b/docs/content-services/search-control.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# Search control component +# [Search control component](../../lib/content-services/search/components/search-control.component.ts "Defined in search-control.component.ts") Displays a input text that shows find-as-you-type suggestions. diff --git a/docs/content-services/search-date-range.component.md b/docs/content-services/search-date-range.component.md index 2fad91c324..2ff10ac9de 100644 --- a/docs/content-services/search-date-range.component.md +++ b/docs/content-services/search-date-range.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-11 --- -# Search date range component +# [Search date range component](../../lib/content-services/search/components/search-date-range/search-date-range.component.ts "Defined in search-date-range.component.ts") Implements a date range widget for the [Search Filter component](../content-services/search-filter.component.md). diff --git a/docs/content-services/search-filter.component.md b/docs/content-services/search-filter.component.md index 907af63ce6..4f8d9a161f 100644 --- a/docs/content-services/search-filter.component.md +++ b/docs/content-services/search-filter.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-12 --- -# Search Filter component +# [Search Filter component](../../lib/content-services/search/components/search-filter/search-filter.component.ts "Defined in search-filter.component.ts") Represents a main container component for custom search and faceted search settings. diff --git a/docs/content-services/search-filter.service.md b/docs/content-services/search-filter.service.md index 9453854745..14eb035f35 100644 --- a/docs/content-services/search-filter.service.md +++ b/docs/content-services/search-filter.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-12 --- -# Search filter service +# [Search filter service](../../lib/content-services/search/components/search-filter/search-filter.service.ts "Defined in search-filter.service.ts") Registers widgets for use with the [Search Filter component](../content-services/search-filter.component.md). diff --git a/docs/content-services/search-number-range.component.md b/docs/content-services/search-number-range.component.md index b603a3053a..67855499d9 100644 --- a/docs/content-services/search-number-range.component.md +++ b/docs/content-services/search-number-range.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-11 --- -# Search number range component +# [Search number range component](../../lib/content-services/search/components/search-number-range/search-number-range.component.ts "Defined in search-number-range.component.ts") Implements a number range widget for the [Search Filter component](../content-services/search-filter.component.md). diff --git a/docs/content-services/search-query-builder.service.md b/docs/content-services/search-query-builder.service.md index 39e2d484fb..ef4e5528b2 100644 --- a/docs/content-services/search-query-builder.service.md +++ b/docs/content-services/search-query-builder.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-12 --- -# Search Query Builder service +# [Search Query Builder service](../../lib/content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts") Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. diff --git a/docs/content-services/search-radio.component.md b/docs/content-services/search-radio.component.md index a4b8a8d77d..e6ba5f6f90 100644 --- a/docs/content-services/search-radio.component.md +++ b/docs/content-services/search-radio.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-08-10 --- -# Search radio component +# [Search radio component](../../lib/content-services/search/components/search-radio/search-radio.component.ts "Defined in search-radio.component.ts") Implements a radio button list widget for the [Search Filter component](../content-services/search-filter.component.md). diff --git a/docs/content-services/search-slider.component.md b/docs/content-services/search-slider.component.md index 83f7dacb64..a46d056597 100644 --- a/docs/content-services/search-slider.component.md +++ b/docs/content-services/search-slider.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-11 --- -# Search slider component +# [Search slider component](../../lib/content-services/search/components/search-slider/search-slider.component.ts "Defined in search-slider.component.ts") Implements a numeric slider widget for the [Search Filter component](../content-services/search-filter.component.md). diff --git a/docs/content-services/search-sorting-picker.component.md b/docs/content-services/search-sorting-picker.component.md index f4b92cf7a3..345b4ab484 100644 --- a/docs/content-services/search-sorting-picker.component.md +++ b/docs/content-services/search-sorting-picker.component.md @@ -4,7 +4,7 @@ Added: v2.3.0 Status: Active --- -# Search Sorting Picker Component +# [Search Sorting Picker Component](../../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts "Defined in search-sorting-picker.component.ts") Provides an ability to select one of the predefined sorting definitions for search results: diff --git a/docs/content-services/search-text.component.md b/docs/content-services/search-text.component.md index 3c8c76d680..c21282d3a8 100644 --- a/docs/content-services/search-text.component.md +++ b/docs/content-services/search-text.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-11 --- -# Search text component +# [Search text component](../../lib/content-services/search/components/search-text/search-text.component.ts "Defined in search-text.component.ts") Implements a text input widget for the [Search Filter component](../content-services/search-filter.component.md). diff --git a/docs/content-services/search-widget.interface.md b/docs/content-services/search-widget.interface.md index 45f9d56adc..2793cc2b9c 100644 --- a/docs/content-services/search-widget.interface.md +++ b/docs/content-services/search-widget.interface.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-12 --- -# Search widget interface +# [Search widget interface](../../lib/content-services/search/search-widget.interface.ts "Defined in search-widget.interface.ts") Specifies required properties for [Search filter component](../content-services/search-filter.component.md) widgets. diff --git a/docs/content-services/search.component.md b/docs/content-services/search.component.md index 1fafee37df..d16cab5be1 100644 --- a/docs/content-services/search.component.md +++ b/docs/content-services/search.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-04-13 --- -# Search component +# [Search component](../../lib/content-services/search/components/search.component.ts "Defined in search.component.ts") Searches items for supplied search terms. diff --git a/docs/content-services/sites-dropdown.component.md b/docs/content-services/sites-dropdown.component.md index 2cc66aaf36..c97fd0682c 100644 --- a/docs/content-services/sites-dropdown.component.md +++ b/docs/content-services/sites-dropdown.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# Sites Dropdown component +# [Sites Dropdown component](../../lib/content-services/site-dropdown/sites-dropdown.component.ts "Defined in sites-dropdown.component.ts") Displays a dropdown menu to show and interact with the sites of the current user. diff --git a/docs/content-services/tag-actions.component.md b/docs/content-services/tag-actions.component.md index 95b8f05563..6cc96d3ac8 100644 --- a/docs/content-services/tag-actions.component.md +++ b/docs/content-services/tag-actions.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# Tag Node Actions List component +# [Tag Node Actions List component](../../lib/content-services/tag/tag-actions.component.ts "Defined in tag-actions.component.ts") Shows available actions for tags. diff --git a/docs/content-services/tag-list.component.md b/docs/content-services/tag-list.component.md index 02426b0455..8fdd698818 100644 --- a/docs/content-services/tag-list.component.md +++ b/docs/content-services/tag-list.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# Tag List component +# [Tag List component](../../lib/content-services/tag/tag-list.component.ts "Defined in tag-list.component.ts") Shows tags for an item. diff --git a/docs/content-services/tag-node-list.component.md b/docs/content-services/tag-node-list.component.md index 00d5c9f29e..6c52c06a14 100644 --- a/docs/content-services/tag-node-list.component.md +++ b/docs/content-services/tag-node-list.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# Tag Node List component +# [Tag Node List component](../../lib/content-services/tag/tag-node-list.component.ts "Defined in tag-node-list.component.ts") Shows tags for a node. diff --git a/docs/content-services/tag.service.md b/docs/content-services/tag.service.md index 74a3c9de69..85bbc0dcaf 100644 --- a/docs/content-services/tag.service.md +++ b/docs/content-services/tag.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# Tag service +# [Tag service](../../lib/content-services/tag/services/tag.service.ts "Defined in tag.service.ts") Manages tags in Content Services. diff --git a/docs/content-services/tree-view.component.md b/docs/content-services/tree-view.component.md index 5787f67def..246a4d5b0f 100644 --- a/docs/content-services/tree-view.component.md +++ b/docs/content-services/tree-view.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# Tree View component +# [Tree View component](../../lib/content-services/tree-view/components/tree-view.component.ts "Defined in tree-view.component.ts") Shows the folder and subfolders of a node as a tree view. diff --git a/docs/content-services/upload-button.component.md b/docs/content-services/upload-button.component.md index 1e580ae2a7..3b4642cc2c 100644 --- a/docs/content-services/upload-button.component.md +++ b/docs/content-services/upload-button.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-09-13 --- -# Upload Button Component +# [Upload Button Component](../../lib/content-services/upload/components/upload-button.component.ts "Defined in upload-button.component.ts") Activates a file upload. diff --git a/docs/content-services/upload-drag-area.component.md b/docs/content-services/upload-drag-area.component.md index 8045814c45..374ab12055 100644 --- a/docs/content-services/upload-drag-area.component.md +++ b/docs/content-services/upload-drag-area.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-09-13 --- -# Upload Drag Area Component +# [Upload Drag Area Component](../../lib/content-services/upload/components/upload-drag-area.component.ts "Defined in upload-drag-area.component.ts") Adds a drag and drop area to upload files to ACS. diff --git a/docs/content-services/upload-version-button.component.md b/docs/content-services/upload-version-button.component.md index 92f46a9855..805be23346 100644 --- a/docs/content-services/upload-version-button.component.md +++ b/docs/content-services/upload-version-button.component.md @@ -5,7 +5,7 @@ Status: Experimental Last reviewed: 2018-03-23 --- -# Upload Version Button Component (Workaround) +# [Upload Version Button Component (Workaround)](../../lib/content-services/upload/components/upload-version-button.component.ts "Defined in upload-version-button.component.ts") Activates a file version upload. diff --git a/docs/content-services/version-list.component.md b/docs/content-services/version-list.component.md index b984c313b7..52b8223e65 100644 --- a/docs/content-services/version-list.component.md +++ b/docs/content-services/version-list.component.md @@ -5,7 +5,7 @@ Status: Experimental Last reviewed: 2018-05-08 --- -# Version List component +# [Version List component](../../lib/content-services/version-manager/version-list.component.ts "Defined in version-list.component.ts") Displays the version history of a node in a [Version Manager component](../content-services/version-manager.component.md). diff --git a/docs/content-services/version-manager.component.md b/docs/content-services/version-manager.component.md index c072c3036c..60de626394 100644 --- a/docs/content-services/version-manager.component.md +++ b/docs/content-services/version-manager.component.md @@ -5,7 +5,7 @@ Status: Experimental Last reviewed: 2018-04-13 --- -# Version Manager Component +# [Version Manager Component](../../lib/content-services/version-manager/version-manager.component.ts "Defined in version-manager.component.ts") Displays the version history of a node with the ability to upload a new version. diff --git a/docs/content-services/webscript.component.md b/docs/content-services/webscript.component.md index e79b7d6b26..76833474ed 100644 --- a/docs/content-services/webscript.component.md +++ b/docs/content-services/webscript.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# Webscript component +# [Webscript component](../../lib/content-services/webscript/webscript.component.ts "Defined in webscript.component.ts") Provides access to Webscript features. diff --git a/package.json b/package.json index b8b937a82e..b63e091eee 100644 --- a/package.json +++ b/package.json @@ -175,6 +175,7 @@ "tslint": "5.9.1", "typedoc": "^0.11.1", "typescript": "2.9.2", + "unist-util-select": "^2.0.0", "unzip-stream": "^0.3.0", "url-join": "^4.0.0", "webpack-bundle-analyzer": "^2.13.1", diff --git a/tools/doc/buildYamlSourceInfo.js b/tools/doc/buildYamlSourceInfo.js index e57a06c00c..47da5d18cb 100644 --- a/tools/doc/buildYamlSourceInfo.js +++ b/tools/doc/buildYamlSourceInfo.js @@ -43,7 +43,7 @@ function searchItemsRecursively(item) { function interestedIn(itemKind) { - return itemKind === 128; + return (itemKind === 128) || (itemKind === 256); } diff --git a/tools/doc/doctool.config.json b/tools/doc/doctool.config.json index 9d0e6489de..c95d929af9 100644 --- a/tools/doc/doctool.config.json +++ b/tools/doc/doctool.config.json @@ -19,7 +19,7 @@ "toc" ], "dev": [ - "toc" + "sourceLinker" ] }, "statusIcons": { @@ -51,8 +51,10 @@ "UserRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserRepresentation.md" }, "typeNameExceptions": { + "content-node-share.directive": "NodeSharedDirective", "content.widget": "ContentWidgetComponent", "datatable.component": "DataTableComponent", + "document-library.model": "NodePaging", "tasklist.service": "TaskListService", "text-mask.component": "InputMaskDirective", "card-item-types.service": "CardItemTypeService", @@ -60,7 +62,8 @@ "header.component": "HeaderLayoutComponent", "process-list.component": "ProcessInstanceListComponent", "inherited-button.directive": "InheritPermissionDirective", - "node-share.directive": "NodeSharedDirective", + "permissions-style.model": "PermissionStyleModel", + "search-widget.interface": "SearchWidget", "sites-dropdown.component": "DropdownSitesComponent", "start-process.component": "StartProcessInstanceComponent" }, diff --git a/tools/doc/tools/sourceLinker.js b/tools/doc/tools/sourceLinker.js new file mode 100644 index 0000000000..cf28f9f320 --- /dev/null +++ b/tools/doc/tools/sourceLinker.js @@ -0,0 +1,35 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +var path = require("path"); +var unist_util_select_1 = require("unist-util-select"); +var ngHelpers = require("../ngHelpers"); +var angFilenameRegex = /([a-zA-Z0-9\-]+)\.((component)|(directive)|(interface)|(model)|(pipe)|(service)|(widget))/; +function processDocs(mdCache, aggData, errorMessages) { + var pathnames = Object.keys(mdCache); + pathnames.forEach(function (pathname) { + var fileBaseName = path.basename(pathname, '.md'); + if (!fileBaseName.match(angFilenameRegex)) { + return; + } + var tree = mdCache[pathname].mdOutTree; + var className = ngHelpers.ngNameToClassName(fileBaseName, aggData.config.typeNameExceptions); + var classInfo = aggData.classInfo[className]; + var sourcePath = classInfo ? classInfo.sourcePath : ''; + var titleHeading = unist_util_select_1.select('heading[depth=1]:first-of-type', tree); + if (titleHeading.children[0].type === "text") { + var titleText = titleHeading.children[0]; + titleHeading.children[0] = { + type: 'link', + url: "../../" + sourcePath, + title: "Defined in " + path.basename(sourcePath), + children: [titleText] + }; + } + else if (titleHeading.children[0].type === "link") { + var linkElem = titleHeading.children[0]; + linkElem.url = "../../" + sourcePath; + linkElem.title = "Defined in " + path.basename(sourcePath); + } + }); +} +exports.processDocs = processDocs; diff --git a/tools/doc/tools/sourceLinker.ts b/tools/doc/tools/sourceLinker.ts new file mode 100644 index 0000000000..aaa873a183 --- /dev/null +++ b/tools/doc/tools/sourceLinker.ts @@ -0,0 +1,42 @@ +import * as path from "path"; + +import { select } from "unist-util-select"; + +import * as ngHelpers from "../ngHelpers"; + + +const angFilenameRegex = /([a-zA-Z0-9\-]+)\.((component)|(directive)|(interface)|(model)|(pipe)|(service)|(widget))/; + + +export function processDocs(mdCache, aggData, errorMessages) { + var pathnames = Object.keys(mdCache); + + pathnames.forEach(pathname => { + let fileBaseName = path.basename(pathname, '.md'); + + if (!fileBaseName.match(angFilenameRegex)) { + return; + } + + let tree = mdCache[pathname].mdOutTree; + let className = ngHelpers.ngNameToClassName(fileBaseName, aggData.config.typeNameExceptions); + let classInfo = aggData.classInfo[className]; + let sourcePath = classInfo ? classInfo.sourcePath : ''; + let titleHeading = select('heading[depth=1]:first-of-type', tree); + + if (titleHeading.children[0].type === "text") { + let titleText = titleHeading.children[0]; + + titleHeading.children[0] = { + type: 'link', + url: `../../${sourcePath}`, + title: `Defined in ${path.basename(sourcePath)}`, + children: [titleText] + } + } else if (titleHeading.children[0].type === "link") { + let linkElem = titleHeading.children[0]; + linkElem.url = `../../${sourcePath}`; + linkElem.title = `Defined in ${path.basename(sourcePath)}`; + } + }); +} \ No newline at end of file