[ADF-3801] Added source linking tool and updated content services docs (#4037)

* [ADF-3801] Added source linking tool

* [ADF-3801] Added source links to doc files
This commit is contained in:
Andy Stark 2018-11-30 11:59:36 +00:00 committed by Eugenio Romano
parent 164abecc06
commit 4b68c98007
63 changed files with 142 additions and 61 deletions

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13 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. Displays a dialog to search for people or groups to add to the current node permissions.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14 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. Searches for people or groups to add to the current node permissions.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19 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. Searches for people or groups to add to the current node permissions.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-08 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. Indicates the current position within a navigation hierarchy.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20 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. Adds options to a Document List actions menu for a particular content type.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-08-07 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. Displays and edits metadata related to a node.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-08-07 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. Displays and edits metadata related to a node.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14 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. Displays and manages dialogs for selecting content to open, copy or upload.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19 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. Opens a Content Node Selector in its own dialog window.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-04-18 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. Allows a user to select items from a Content Services repository.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-09-13 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. Creates and manages public shared links for files.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-16 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. Manages Document List information that is specific to a user.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13 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). Implements the document menu actions for the [Document List component](../content-services/document-list.component.md).

View File

@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active 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. Defines classes for use with the Content Services node API.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-12 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. Displays the documents from a repository.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-09-13 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). Implements node operations used by the [Document List component](../content-services/document-list.component.md).

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-08 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. Indicates the current position within a navigation hierarchy using a dropdown menu.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-04-10 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`. Provides drag-and-drop features for an element such as a `div`.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20 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. Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13 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). Implements the folder menu actions for the [Document List component](../content-services/document-list.component.md).

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20 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. Creates folders.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-04-10 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. Allows folders to be edited.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20 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. Update the current node by adding/removing the inherited permissions.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14 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. Allows a user to add "likes" to an item.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20 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. Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20 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. Locks a node.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-09-13 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. Displays dialogs to let the user set node permissions.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14 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. Manages role permissions for content nodes.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20 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. Shows node permissions as a table.

View File

@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active 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. Sets custom CSS styles for rows of a Document List according to the item's permissions.

View File

@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active 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. Allows a user to add ratings to an item.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-05-04 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. Manages ratings for items in Content Services.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-11 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). Implements a checklist widget for the [Search Filter component](../content-services/search-filter.component.md).

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-09-14 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". Displays search criteria as a set of "chips".

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14 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. Displays a input text that shows find-as-you-type suggestions.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-11 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). Implements a date range widget for the [Search Filter component](../content-services/search-filter.component.md).

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-12 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. Represents a main container component for custom search and faceted search settings.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-12 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). Registers widgets for use with the [Search Filter component](../content-services/search-filter.component.md).

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-11 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). Implements a number range widget for the [Search Filter component](../content-services/search-filter.component.md).

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-12 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. Stores information from all the custom search and faceted search widgets, compiles and runs the final search query.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-08-10 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). Implements a radio button list widget for the [Search Filter component](../content-services/search-filter.component.md).

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-11 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). Implements a numeric slider widget for the [Search Filter component](../content-services/search-filter.component.md).

View File

@ -4,7 +4,7 @@ Added: v2.3.0
Status: Active 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: Provides an ability to select one of the predefined sorting definitions for search results:

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-11 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). Implements a text input widget for the [Search Filter component](../content-services/search-filter.component.md).

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-12 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. Specifies required properties for [Search filter component](../content-services/search-filter.component.md) widgets.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-04-13 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. Searches items for supplied search terms.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19 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. Displays a dropdown menu to show and interact with the sites of the current user.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19 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. Shows available actions for tags.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14 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. Shows tags for an item.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19 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. Shows tags for a node.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13 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. Manages tags in Content Services.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19 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. Shows the folder and subfolders of a node as a tree view.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-09-13 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. Activates a file upload.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-09-13 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. Adds a drag and drop area to upload files to ACS.

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2018-03-23 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. Activates a file version upload.

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2018-05-08 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). Displays the version history of a node in a [Version Manager component](../content-services/version-manager.component.md).

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2018-04-13 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. Displays the version history of a node with the ability to upload a new version.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14 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. Provides access to Webscript features.

View File

@ -175,6 +175,7 @@
"tslint": "5.9.1", "tslint": "5.9.1",
"typedoc": "^0.11.1", "typedoc": "^0.11.1",
"typescript": "2.9.2", "typescript": "2.9.2",
"unist-util-select": "^2.0.0",
"unzip-stream": "^0.3.0", "unzip-stream": "^0.3.0",
"url-join": "^4.0.0", "url-join": "^4.0.0",
"webpack-bundle-analyzer": "^2.13.1", "webpack-bundle-analyzer": "^2.13.1",

View File

@ -43,7 +43,7 @@ function searchItemsRecursively(item) {
function interestedIn(itemKind) { function interestedIn(itemKind) {
return itemKind === 128; return (itemKind === 128) || (itemKind === 256);
} }

View File

@ -19,7 +19,7 @@
"toc" "toc"
], ],
"dev": [ "dev": [
"toc" "sourceLinker"
] ]
}, },
"statusIcons": { "statusIcons": {
@ -51,8 +51,10 @@
"UserRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserRepresentation.md" "UserRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserRepresentation.md"
}, },
"typeNameExceptions": { "typeNameExceptions": {
"content-node-share.directive": "NodeSharedDirective",
"content.widget": "ContentWidgetComponent", "content.widget": "ContentWidgetComponent",
"datatable.component": "DataTableComponent", "datatable.component": "DataTableComponent",
"document-library.model": "NodePaging",
"tasklist.service": "TaskListService", "tasklist.service": "TaskListService",
"text-mask.component": "InputMaskDirective", "text-mask.component": "InputMaskDirective",
"card-item-types.service": "CardItemTypeService", "card-item-types.service": "CardItemTypeService",
@ -60,7 +62,8 @@
"header.component": "HeaderLayoutComponent", "header.component": "HeaderLayoutComponent",
"process-list.component": "ProcessInstanceListComponent", "process-list.component": "ProcessInstanceListComponent",
"inherited-button.directive": "InheritPermissionDirective", "inherited-button.directive": "InheritPermissionDirective",
"node-share.directive": "NodeSharedDirective", "permissions-style.model": "PermissionStyleModel",
"search-widget.interface": "SearchWidget",
"sites-dropdown.component": "DropdownSitesComponent", "sites-dropdown.component": "DropdownSitesComponent",
"start-process.component": "StartProcessInstanceComponent" "start-process.component": "StartProcessInstanceComponent"
}, },

View File

@ -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;

View File

@ -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)}`;
}
});
}