[ADF-1549] Improved formatting for doc index (#2365)

* [ADF-1549] Added undoc stoplist feature

* [ADF-1549] Better grouping of items in doc index

* [ADF-1549] Added undoc stoplist feature

* [ADF-1549] Better grouping of items in doc index
This commit is contained in:
Andy Stark
2017-09-21 17:58:43 +01:00
committed by Eugenio Romano
parent 2d6c8f92f0
commit 417071db01
3 changed files with 418 additions and 349 deletions

View File

@@ -2,8 +2,8 @@
Below is an index of the documentation for each component library. The [User Guide](#user-guide) Below is an index of the documentation for each component library. The [User Guide](#user-guide)
section discusses particular techniques in depth. The other sections are references for the ADF section discusses particular techniques in depth. The other sections are references for the ADF
components. Items listed as **Documented** have descriptive documentation. For the **Undocumented** items, components. Items marked with an asterisk (*) do not currently have documentation - the link leads
the links lead to the appropriate code source file. to the appropriate source file.
## Contents ## Contents
@@ -41,25 +41,28 @@ the links lead to the appropriate code source file.
Contains the Analytics component and other related items. See the library's Contains the Analytics component and other related items. See the library's
[README file](ng2-components/ng2-activiti-analytics/README.md) [README file](ng2-components/ng2-activiti-analytics/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-activiti-analytics start --> <!-- ng2-activiti-analytics start -->
**Documented**
### Components
- [Analytics generator component](docs/analytics-generator.component.md) - [Analytics generator component](docs/analytics-generator.component.md)
- [Analytics report list component](docs/analytics-report-list.component.md) - [Analytics report list component](docs/analytics-report-list.component.md)
- [Analytics component](docs/analytics.component.md) - [Analytics component](docs/analytics.component.md)
- [*Analytics report heat map component](ng2-components/ng2-activiti-analytics/src/components/analytics-report-heat-map.component.ts)
- [*Analytics report parameters component](ng2-components/ng2-activiti-analytics/src/components/analytics-report-parameters.component.ts)
- [*Widget component](ng2-components/ng2-activiti-analytics/src/components/widgets/widget.component.ts)
**Undocumented** ### Services
- [Analytics report heat map component](ng2-components/ng2-activiti-analytics/src/components/analytics-report-heat-map.component.ts) - [*Analytics service](ng2-components/ng2-activiti-analytics/src/services/analytics.service.ts)
- [Analytics report parameters component](ng2-components/ng2-activiti-analytics/src/components/analytics-report-parameters.component.ts)
- [Checkbox widget](ng2-components/ng2-activiti-analytics/src/components/widgets/checkbox/checkbox.widget.ts) ### Widgets
- [Date range widget](ng2-components/ng2-activiti-analytics/src/components/widgets/date-range/date-range.widget.ts)
- [Dropdown widget](ng2-components/ng2-activiti-analytics/src/components/widgets/dropdown/dropdown.widget.ts) - [*Checkbox widget](ng2-components/ng2-activiti-analytics/src/components/widgets/checkbox/checkbox.widget.ts)
- [Duration widget](ng2-components/ng2-activiti-analytics/src/components/widgets/duration/duration.widget.ts) - [*Date range widget](ng2-components/ng2-activiti-analytics/src/components/widgets/date-range/date-range.widget.ts)
- [Number widget](ng2-components/ng2-activiti-analytics/src/components/widgets/number/number.widget.ts) - [*Dropdown widget](ng2-components/ng2-activiti-analytics/src/components/widgets/dropdown/dropdown.widget.ts)
- [Widget component](ng2-components/ng2-activiti-analytics/src/components/widgets/widget.component.ts) - [*Duration widget](ng2-components/ng2-activiti-analytics/src/components/widgets/duration/duration.widget.ts)
- [Analytics service](ng2-components/ng2-activiti-analytics/src/services/analytics.service.ts) - [*Number widget](ng2-components/ng2-activiti-analytics/src/components/widgets/number/number.widget.ts)
<!-- ng2-activiti-analytics end --> <!-- ng2-activiti-analytics end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -69,98 +72,95 @@ for more information about installing and using the source code.
Contains the Diagram component and other related items. See the library's Contains the Diagram component and other related items. See the library's
[README file](ng2-components/ng2-activiti-diagrams/README.md) [README file](ng2-components/ng2-activiti-diagrams/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-activiti-diagrams start --> <!-- ng2-activiti-diagrams start -->
**Documented**
### Components
- [Diagram component](docs/diagram.component.md) - [Diagram component](docs/diagram.component.md)
- [*Diagram alfresco publish task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-alfresco-publish-task.component.ts)
- [*Diagram box publish task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-box-publish-task.component.ts)
- [*Diagram business rule task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-business-rule-task.component.ts)
- [*Diagram camel task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-camel-task.component.ts)
- [*Diagram container service task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-container-service-task.component.ts)
- [*Diagram google drive publish task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-google-drive-publish-task.component.ts)
- [*Diagram manual task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-manual-task.component.ts)
- [*Diagram mule task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-mule-task.component.ts)
- [*Diagram receive task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-receive-task.component.ts)
- [*Diagram rest call task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-rest-call-task.component.ts)
- [*Diagram script task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-script-task.component.ts)
- [*Diagram send task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-send-task.component.ts)
- [*Diagram service task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-service-task.component.ts)
- [*Diagram task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-task.component.ts)
- [*Diagram user task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-user-task.component.ts)
- [*Diagram boundary event component](ng2-components/ng2-activiti-diagrams/src/components/boundary-events/diagram-boundary-event.component.ts)
- [*Diagram throw event component](ng2-components/ng2-activiti-diagrams/src/components/boundary-events/diagram-throw-event.component.ts)
- [*Diagram sequence flow component](ng2-components/ng2-activiti-diagrams/src/components/diagram-sequence-flow.component.ts)
- [*Diagram end event component](ng2-components/ng2-activiti-diagrams/src/components/events/diagram-end-event.component.ts)
- [*Diagram event component](ng2-components/ng2-activiti-diagrams/src/components/events/diagram-event.component.ts)
- [*Diagram start event component](ng2-components/ng2-activiti-diagrams/src/components/events/diagram-start-event.component.ts)
- [*Diagram event gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-event-gateway.component.ts)
- [*Diagram exclusive gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-exclusive-gateway.component.ts)
- [*Diagram gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-gateway.component.ts)
- [*Diagram inclusive gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-inclusive-gateway.component.ts)
- [*Diagram parallel gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-parallel-gateway.component.ts)
- [*Diagram container icon event component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-container-icon-event.component.ts)
- [*Diagram icon alfresco publish task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-alfresco-publish-task.component.ts)
- [*Diagram icon box publish task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-box-publish-task.component.ts)
- [*Diagram icon business rule task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-business-rule-task.component.ts)
- [*Diagram icon camel task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-camel-task.component.ts)
- [*Diagram icon error component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-error.component.ts)
- [*Diagram icon google drive publish task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-google-drive-publish-task.component.ts)
- [*Diagram icon manual task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-manual-task.component.ts)
- [*Diagram icon message component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-message.component.ts)
- [*Diagram icon mule task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-mule-task.component.ts)
- [*Diagram icon receive task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-receive-task.component.ts)
- [*Diagram icon rest call task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-rest-call-task.component.ts)
- [*Diagram icon script task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-script-task.component.ts)
- [*Diagram icon send task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-send-task.component.ts)
- [*Diagram icon service task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-service-task.component.ts)
- [*Diagram icon signal component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-signal.component.ts)
- [*Diagram icon timer component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-timer.component.ts)
- [*Diagram icon user task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-user-task.component.ts)
- [*Diagram intermediate catching event component](ng2-components/ng2-activiti-diagrams/src/components/intermediate-catching-events/diagram-intermediate-catching-event.component.ts)
- [*Raphael icon alfresco publish component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-alfresco-publish.component.ts)
- [*Raphael icon box publish component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-box-publish.component.ts)
- [*Raphael icon business rule component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-business-rule.component.ts)
- [*Raphael icon camel component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-camel.component.ts)
- [*Raphael icon error component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-error.component.ts)
- [*Raphael icon google drive publish component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-google-drive-publish.component.ts)
- [*Raphael icon manual component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-manual.component.ts)
- [*Raphael icon message component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-message.component.ts)
- [*Raphael icon mule component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-mule.component.ts)
- [*Raphael icon receive component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-receive.component.ts)
- [*Raphael icon rest call component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-rest-call.component.ts)
- [*Raphael icon script component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-script.component.ts)
- [*Raphael icon send component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-send.component.ts)
- [*Raphael icon service component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-service.component.ts)
- [*Raphael icon signal component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-signal.component.ts)
- [*Raphael icon timer component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-timer.component.ts)
- [*Raphael icon user component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-user.component.ts)
- [*Raphael circle component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-circle.component.ts)
- [*Raphael cross component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-cross.component.ts)
- [*Raphael flow arrow component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-flow-arrow.component.ts)
- [*Raphael multiline text component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-multiline-text.component.ts)
- [*Raphael pentagon component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-pentagon.component.ts)
- [*Raphael plus component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-plus.component.ts)
- [*Raphael rect component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-rect.component.ts)
- [*Raphael rhombus component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-rhombus.component.ts)
- [*Raphael text component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-text.component.ts)
- [*Diagram event subprocess component](ng2-components/ng2-activiti-diagrams/src/components/structural/diagram-event-subprocess.component.ts)
- [*Diagram subprocess component](ng2-components/ng2-activiti-diagrams/src/components/structural/diagram-subprocess.component.ts)
- [*Diagram lane component](ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-lane.component.ts)
- [*Diagram lanes component](ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-lanes.component.ts)
- [*Diagram pool component](ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-pool.component.ts)
- [*Diagram pools component](ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-pools.component.ts)
- [*Diagram tooltip component](ng2-components/ng2-activiti-diagrams/src/components/tooltip/diagram-tooltip.component.ts)
**Undocumented** ### Services
- [Diagram alfresco publish task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-alfresco-publish-task.component.ts) - [*Raphael service](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael.service.ts)
- [Diagram box publish task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-box-publish-task.component.ts) - [*Diagram color service](ng2-components/ng2-activiti-diagrams/src/services/diagram-color.service.ts)
- [Diagram business rule task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-business-rule-task.component.ts) - [*Diagrams service](ng2-components/ng2-activiti-diagrams/src/services/diagrams.service.ts)
- [Diagram camel task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-camel-task.component.ts)
- [Diagram container service task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-container-service-task.component.ts)
- [Diagram google drive publish task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-google-drive-publish-task.component.ts)
- [Diagram manual task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-manual-task.component.ts)
- [Diagram mule task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-mule-task.component.ts)
- [Diagram receive task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-receive-task.component.ts)
- [Diagram rest call task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-rest-call-task.component.ts)
- [Diagram script task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-script-task.component.ts)
- [Diagram send task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-send-task.component.ts)
- [Diagram service task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-service-task.component.ts)
- [Diagram task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-task.component.ts)
- [Diagram user task component](ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-user-task.component.ts)
- [Diagram boundary event component](ng2-components/ng2-activiti-diagrams/src/components/boundary-events/diagram-boundary-event.component.ts)
- [Diagram throw event component](ng2-components/ng2-activiti-diagrams/src/components/boundary-events/diagram-throw-event.component.ts)
- [Diagram sequence flow component](ng2-components/ng2-activiti-diagrams/src/components/diagram-sequence-flow.component.ts)
- [Diagram end event component](ng2-components/ng2-activiti-diagrams/src/components/events/diagram-end-event.component.ts)
- [Diagram event component](ng2-components/ng2-activiti-diagrams/src/components/events/diagram-event.component.ts)
- [Diagram start event component](ng2-components/ng2-activiti-diagrams/src/components/events/diagram-start-event.component.ts)
- [Diagram event gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-event-gateway.component.ts)
- [Diagram exclusive gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-exclusive-gateway.component.ts)
- [Diagram gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-gateway.component.ts)
- [Diagram inclusive gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-inclusive-gateway.component.ts)
- [Diagram parallel gateway component](ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-parallel-gateway.component.ts)
- [Diagram container icon event component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-container-icon-event.component.ts)
- [Diagram icon alfresco publish task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-alfresco-publish-task.component.ts)
- [Diagram icon box publish task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-box-publish-task.component.ts)
- [Diagram icon business rule task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-business-rule-task.component.ts)
- [Diagram icon camel task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-camel-task.component.ts)
- [Diagram icon error component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-error.component.ts)
- [Diagram icon google drive publish task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-google-drive-publish-task.component.ts)
- [Diagram icon manual task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-manual-task.component.ts)
- [Diagram icon message component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-message.component.ts)
- [Diagram icon mule task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-mule-task.component.ts)
- [Diagram icon receive task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-receive-task.component.ts)
- [Diagram icon rest call task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-rest-call-task.component.ts)
- [Diagram icon script task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-script-task.component.ts)
- [Diagram icon send task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-send-task.component.ts)
- [Diagram icon service task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-service-task.component.ts)
- [Diagram icon signal component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-signal.component.ts)
- [Diagram icon timer component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-timer.component.ts)
- [Diagram icon user task component](ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-user-task.component.ts)
- [Diagram intermediate catching event component](ng2-components/ng2-activiti-diagrams/src/components/intermediate-catching-events/diagram-intermediate-catching-event.component.ts)
- [Raphael icon alfresco publish component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-alfresco-publish.component.ts)
- [Raphael icon box publish component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-box-publish.component.ts)
- [Raphael icon business rule component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-business-rule.component.ts)
- [Raphael icon camel component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-camel.component.ts)
- [Raphael icon error component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-error.component.ts)
- [Raphael icon google drive publish component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-google-drive-publish.component.ts)
- [Raphael icon manual component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-manual.component.ts)
- [Raphael icon message component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-message.component.ts)
- [Raphael icon mule component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-mule.component.ts)
- [Raphael icon receive component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-receive.component.ts)
- [Raphael icon rest call component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-rest-call.component.ts)
- [Raphael icon script component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-script.component.ts)
- [Raphael icon send component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-send.component.ts)
- [Raphael icon service component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-service.component.ts)
- [Raphael icon signal component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-signal.component.ts)
- [Raphael icon timer component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-timer.component.ts)
- [Raphael icon user component](ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-user.component.ts)
- [Raphael circle component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-circle.component.ts)
- [Raphael cross component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-cross.component.ts)
- [Raphael flow arrow component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-flow-arrow.component.ts)
- [Raphael multiline text component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-multiline-text.component.ts)
- [Raphael pentagon component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-pentagon.component.ts)
- [Raphael plus component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-plus.component.ts)
- [Raphael rect component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-rect.component.ts)
- [Raphael rhombus component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-rhombus.component.ts)
- [Raphael text component](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-text.component.ts)
- [Raphael service](ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael.service.ts)
- [Diagram event subprocess component](ng2-components/ng2-activiti-diagrams/src/components/structural/diagram-event-subprocess.component.ts)
- [Diagram subprocess component](ng2-components/ng2-activiti-diagrams/src/components/structural/diagram-subprocess.component.ts)
- [Diagram lane component](ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-lane.component.ts)
- [Diagram lanes component](ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-lanes.component.ts)
- [Diagram pool component](ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-pool.component.ts)
- [Diagram pools component](ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-pools.component.ts)
- [Diagram tooltip component](ng2-components/ng2-activiti-diagrams/src/components/tooltip/diagram-tooltip.component.ts)
- [Chart model](ng2-components/ng2-activiti-diagrams/src/models/chart.model.ts)
- [Diagram model](ng2-components/ng2-activiti-diagrams/src/models/diagram.model.ts)
- [Report model](ng2-components/ng2-activiti-diagrams/src/models/report.model.ts)
- [Diagram color service](ng2-components/ng2-activiti-diagrams/src/services/diagram-color.service.ts)
- [Diagrams service](ng2-components/ng2-activiti-diagrams/src/services/diagrams.service.ts)
<!-- ng2-activiti-diagrams end --> <!-- ng2-activiti-diagrams end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -170,64 +170,49 @@ for more information about installing and using the source code.
Contains the Form component and other related items. See the library's Contains the Form component and other related items. See the library's
[README file](ng2-components/ng2-activiti-form/README.md) [README file](ng2-components/ng2-activiti-form/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-activiti-form start --> <!-- ng2-activiti-form start -->
**Documented**
### Components
- [Form list component](docs/form-list.component.md) - [Form list component](docs/form-list.component.md)
- [Form component](docs/form.component.md) - [Form component](docs/form.component.md)
- [Content widget](docs/content.widget.md) - [*Form field component](ng2-components/ng2-activiti-form/src/components/form-field/form-field.component.ts)
- [*Start form component](ng2-components/ng2-activiti-form/src/components/start-form.component.ts)
- [*Error component](ng2-components/ng2-activiti-form/src/components/widgets/error/error.component.ts)
- [*Text mask component](ng2-components/ng2-activiti-form/src/components/widgets/text/text-mask.component.ts)
- [*Widget component](ng2-components/ng2-activiti-form/src/components/widgets/widget.component.ts)
### Services
- [Form service](docs/form.service.md) - [Form service](docs/form.service.md)
- [*Activiti alfresco service](ng2-components/ng2-activiti-form/src/services/activiti-alfresco.service.ts)
- [*Form rendering service](ng2-components/ng2-activiti-form/src/services/form-rendering.service.ts)
- [*Node service](ng2-components/ng2-activiti-form/src/services/node.service.ts)
- [*Widget visibility service](ng2-components/ng2-activiti-form/src/services/widget-visibility.service.ts)
**Undocumented** ### Widgets
- [Form field component](ng2-components/ng2-activiti-form/src/components/form-field/form-field.component.ts) - [Content widget](docs/content.widget.md)
- [Start form component](ng2-components/ng2-activiti-form/src/components/start-form.component.ts) - [*Amount widget](ng2-components/ng2-activiti-form/src/components/widgets/amount/amount.widget.ts)
- [Amount widget](ng2-components/ng2-activiti-form/src/components/widgets/amount/amount.widget.ts) - [*Attach widget](ng2-components/ng2-activiti-form/src/components/widgets/attach/attach.widget.ts)
- [Attach widget](ng2-components/ng2-activiti-form/src/components/widgets/attach/attach.widget.ts) - [*Checkbox widget](ng2-components/ng2-activiti-form/src/components/widgets/checkbox/checkbox.widget.ts)
- [Checkbox widget](ng2-components/ng2-activiti-form/src/components/widgets/checkbox/checkbox.widget.ts) - [*Container widget](ng2-components/ng2-activiti-form/src/components/widgets/container/container.widget.ts)
- [Container widget](ng2-components/ng2-activiti-form/src/components/widgets/container/container.widget.model.ts) - [*Date widget](ng2-components/ng2-activiti-form/src/components/widgets/date/date.widget.ts)
- [Container widget](ng2-components/ng2-activiti-form/src/components/widgets/container/container.widget.ts) - [*Display text widget](ng2-components/ng2-activiti-form/src/components/widgets/display-text/display-text.widget.ts)
- [Container column model](ng2-components/ng2-activiti-form/src/components/widgets/core/container-column.model.ts) - [*Document widget](ng2-components/ng2-activiti-form/src/components/widgets/document/document.widget.ts)
- [Container model](ng2-components/ng2-activiti-form/src/components/widgets/core/container.model.ts) - [*Dropdown widget](ng2-components/ng2-activiti-form/src/components/widgets/dropdown/dropdown.widget.ts)
- [Content link model](ng2-components/ng2-activiti-form/src/components/widgets/core/content-link.model.ts) - [*Dynamic table widget](ng2-components/ng2-activiti-form/src/components/widgets/dynamic-table/dynamic-table.widget.ts)
- [Form field model](ng2-components/ng2-activiti-form/src/components/widgets/core/form-field.model.ts) - [*Functional group widget](ng2-components/ng2-activiti-form/src/components/widgets/functional-group/functional-group.widget.ts)
- [Form outcome event model](ng2-components/ng2-activiti-form/src/components/widgets/core/form-outcome-event.model.ts) - [*Hyperlink widget](ng2-components/ng2-activiti-form/src/components/widgets/hyperlink/hyperlink.widget.ts)
- [Form outcome model](ng2-components/ng2-activiti-form/src/components/widgets/core/form-outcome.model.ts) - [*Multiline text widget](ng2-components/ng2-activiti-form/src/components/widgets/multiline-text/multiline-text.widget.ts)
- [Form widget model](ng2-components/ng2-activiti-form/src/components/widgets/core/form-widget.model.ts) - [*Number widget](ng2-components/ng2-activiti-form/src/components/widgets/number/number.widget.ts)
- [Form model](ng2-components/ng2-activiti-form/src/components/widgets/core/form.model.ts) - [*People widget](ng2-components/ng2-activiti-form/src/components/widgets/people/people.widget.ts)
- [Group user model](ng2-components/ng2-activiti-form/src/components/widgets/core/group-user.model.ts) - [*Radio buttons widget](ng2-components/ng2-activiti-form/src/components/widgets/radio-buttons/radio-buttons.widget.ts)
- [Group model](ng2-components/ng2-activiti-form/src/components/widgets/core/group.model.ts) - [*Tabs widget](ng2-components/ng2-activiti-form/src/components/widgets/tabs/tabs.widget.ts)
- [Tab model](ng2-components/ng2-activiti-form/src/components/widgets/core/tab.model.ts) - [*Text widget](ng2-components/ng2-activiti-form/src/components/widgets/text/text.widget.ts)
- [Date widget](ng2-components/ng2-activiti-form/src/components/widgets/date/date.widget.ts) - [*Typeahead widget](ng2-components/ng2-activiti-form/src/components/widgets/typeahead/typeahead.widget.ts)
- [Display text widget](ng2-components/ng2-activiti-form/src/components/widgets/display-text/display-text.widget.ts) - [*Unknown widget](ng2-components/ng2-activiti-form/src/components/widgets/unknown/unknown.widget.ts)
- [Document widget](ng2-components/ng2-activiti-form/src/components/widgets/document/document.widget.ts) - [*Upload widget](ng2-components/ng2-activiti-form/src/components/widgets/upload/upload.widget.ts)
- [Dropdown widget](ng2-components/ng2-activiti-form/src/components/widgets/dropdown/dropdown.widget.ts)
- [Dynamic table widget](ng2-components/ng2-activiti-form/src/components/widgets/dynamic-table/dynamic-table.widget.model.ts)
- [Dynamic table widget](ng2-components/ng2-activiti-form/src/components/widgets/dynamic-table/dynamic-table.widget.ts)
- [Error component](ng2-components/ng2-activiti-form/src/components/widgets/error/error.component.ts)
- [Functional group widget](ng2-components/ng2-activiti-form/src/components/widgets/functional-group/functional-group.widget.ts)
- [Hyperlink widget](ng2-components/ng2-activiti-form/src/components/widgets/hyperlink/hyperlink.widget.ts)
- [Multiline text widget](ng2-components/ng2-activiti-form/src/components/widgets/multiline-text/multiline-text.widget.ts)
- [Number widget](ng2-components/ng2-activiti-form/src/components/widgets/number/number.widget.ts)
- [People widget](ng2-components/ng2-activiti-form/src/components/widgets/people/people.widget.ts)
- [Radio buttons widget](ng2-components/ng2-activiti-form/src/components/widgets/radio-buttons/radio-buttons.widget.ts)
- [Tabs widget](ng2-components/ng2-activiti-form/src/components/widgets/tabs/tabs.widget.ts)
- [Text mask component](ng2-components/ng2-activiti-form/src/components/widgets/text/text-mask.component.ts)
- [Text widget](ng2-components/ng2-activiti-form/src/components/widgets/text/text.widget.ts)
- [Typeahead widget](ng2-components/ng2-activiti-form/src/components/widgets/typeahead/typeahead.widget.ts)
- [Unknown widget](ng2-components/ng2-activiti-form/src/components/widgets/unknown/unknown.widget.ts)
- [Upload widget](ng2-components/ng2-activiti-form/src/components/widgets/upload/upload.widget.ts)
- [Widget component](ng2-components/ng2-activiti-form/src/components/widgets/widget.component.ts)
- [Form definition model](ng2-components/ng2-activiti-form/src/models/form-definition.model.ts)
- [Node metadata model](ng2-components/ng2-activiti-form/src/models/node-metadata.model.ts)
- [Task process variable model](ng2-components/ng2-activiti-form/src/models/task-process-variable.model.ts)
- [Widget visibility model](ng2-components/ng2-activiti-form/src/models/widget-visibility.model.ts)
- [Activiti alfresco service](ng2-components/ng2-activiti-form/src/services/activiti-alfresco.service.ts)
- [Ecm model service](ng2-components/ng2-activiti-form/src/services/ecm-model.service.ts)
- [Form rendering service](ng2-components/ng2-activiti-form/src/services/form-rendering.service.ts)
- [Node service](ng2-components/ng2-activiti-form/src/services/node.service.ts)
- [Widget visibility service](ng2-components/ng2-activiti-form/src/services/widget-visibility.service.ts)
<!-- ng2-activiti-form end --> <!-- ng2-activiti-form end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -239,11 +224,11 @@ Contains the Processlist component and other related items. See the library's
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-activiti-processlist start --> <!-- ng2-activiti-processlist start -->
**Documented**
### Components
- [Create process attachment component](docs/create-process-attachment.component.md) - [Create process attachment component](docs/create-process-attachment.component.md)
- [Process attachment list component](docs/process-attachment-list.component.md) - [Process attachment list component](docs/process-attachment-list.component.md)
- [Process audit directive](docs/process-audit.directive.md)
- [Process comments component](docs/process-comments.component.md) - [Process comments component](docs/process-comments.component.md)
- [Process filters component](docs/process-filters.component.md) - [Process filters component](docs/process-filters.component.md)
- [Process instance details component](docs/process-instance-details.component.md) - [Process instance details component](docs/process-instance-details.component.md)
@@ -252,15 +237,14 @@ for more information about installing and using the source code.
- [Processlist component](docs/processlist.component.md) - [Processlist component](docs/processlist.component.md)
- [Start process component](docs/start-process.component.md) - [Start process component](docs/start-process.component.md)
**Undocumented** ### Directives
- [Filter process model](ng2-components/ng2-activiti-processlist/src/models/filter-process.model.ts) - [Process audit directive](docs/process-audit.directive.md)
- [Process definition model](ng2-components/ng2-activiti-processlist/src/models/process-definition.model.ts)
- [Process instance filter model](ng2-components/ng2-activiti-processlist/src/models/process-instance-filter.model.ts) ### Services
- [Process instance variable model](ng2-components/ng2-activiti-processlist/src/models/process-instance-variable.model.ts)
- [Process instance model](ng2-components/ng2-activiti-processlist/src/models/process-instance.model.ts) - [*Process upload service](ng2-components/ng2-activiti-processlist/src/services/process-upload.service.ts)
- [Process upload service](ng2-components/ng2-activiti-processlist/src/services/process-upload.service.ts) - [*Process service](ng2-components/ng2-activiti-processlist/src/services/process.service.ts)
- [Process service](ng2-components/ng2-activiti-processlist/src/services/process.service.ts)
<!-- ng2-activiti-processlist end --> <!-- ng2-activiti-processlist end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -270,9 +254,9 @@ for more information about installing and using the source code.
Contains the Tasklist component and other related items. See the library's Contains the Tasklist component and other related items. See the library's
[README file](ng2-components/ng2-activiti-tasklist/README.md) [README file](ng2-components/ng2-activiti-tasklist/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-activiti-tasklist start --> <!-- ng2-activiti-tasklist start -->
**Documented**
### Components
- [Apps list component](docs/apps-list.component.md) - [Apps list component](docs/apps-list.component.md)
- [Checklist component](docs/checklist.component.md) - [Checklist component](docs/checklist.component.md)
@@ -282,29 +266,27 @@ for more information about installing and using the source code.
- [People component](docs/people.component.md) - [People component](docs/people.component.md)
- [Start task component](docs/start-task.component.md) - [Start task component](docs/start-task.component.md)
- [Task attachment list component](docs/task-attachment-list.component.md) - [Task attachment list component](docs/task-attachment-list.component.md)
- [Task audit directive](docs/task-audit.directive.md)
- [Task details component](docs/task-details.component.md) - [Task details component](docs/task-details.component.md)
- [Task filters component](docs/task-filters.component.md) - [Task filters component](docs/task-filters.component.md)
- [Task header component](docs/task-header.component.md) - [Task header component](docs/task-header.component.md)
- [Tasklist component](docs/tasklist.component.md) - [Tasklist component](docs/tasklist.component.md)
- [*Comment list component](ng2-components/ng2-activiti-tasklist/src/components/comment-list.component.ts)
- [*People list component](ng2-components/ng2-activiti-tasklist/src/components/people-list.component.ts)
### Directives
- [Task audit directive](docs/task-audit.directive.md)
- [*No task detail template directive](ng2-components/ng2-activiti-tasklist/src/components/no-task-detail-template.directive.ts)
### Models
- [Task details model](docs/task-details.model.md) - [Task details model](docs/task-details.model.md)
**Undocumented** ### Services
- [Comment list component](ng2-components/ng2-activiti-tasklist/src/components/comment-list.component.ts) - [*People service](ng2-components/ng2-activiti-tasklist/src/services/people.service.ts)
- [No task detail template directive](ng2-components/ng2-activiti-tasklist/src/components/no-task-detail-template.directive.ts) - [*Process upload service](ng2-components/ng2-activiti-tasklist/src/services/process-upload.service.ts)
- [People list component](ng2-components/ng2-activiti-tasklist/src/components/people-list.component.ts) - [*Tasklist service](ng2-components/ng2-activiti-tasklist/src/services/tasklist.service.ts)
- [Comment model](ng2-components/ng2-activiti-tasklist/src/models/comment.model.ts)
- [Filter model](ng2-components/ng2-activiti-tasklist/src/models/filter.model.ts)
- [Form model](ng2-components/ng2-activiti-tasklist/src/models/form.model.ts)
- [Icon model](ng2-components/ng2-activiti-tasklist/src/models/icon.model.ts)
- [Start task model](ng2-components/ng2-activiti-tasklist/src/models/start-task.model.ts)
- [Task list model](ng2-components/ng2-activiti-tasklist/src/models/task-list.model.ts)
- [User event model](ng2-components/ng2-activiti-tasklist/src/models/user-event.model.ts)
- [User model](ng2-components/ng2-activiti-tasklist/src/models/user.model.ts)
- [People service](ng2-components/ng2-activiti-tasklist/src/services/people.service.ts)
- [Process upload service](ng2-components/ng2-activiti-tasklist/src/services/process-upload.service.ts)
- [Tasklist service](ng2-components/ng2-activiti-tasklist/src/services/tasklist.service.ts)
<!-- ng2-activiti-tasklist end --> <!-- ng2-activiti-tasklist end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -314,20 +296,40 @@ for more information about installing and using the source code.
Contains a variety of components, directives and other classes used throughout ADF. See the library's Contains a variety of components, directives and other classes used throughout ADF. See the library's
[README file](ng2-components/ng2-alfresco-core/README.md) [README file](ng2-components/ng2-alfresco-core/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-core start --> <!-- ng2-alfresco-core start -->
**Documented**
### Components
- [Accordion component](docs/accordion.component.md) - [Accordion component](docs/accordion.component.md)
- [Context menu directive](docs/context-menu.directive.md)
- [Data column component](docs/data-column.component.md) - [Data column component](docs/data-column.component.md)
- [Pagination component](docs/pagination.component.md) - [Pagination component](docs/pagination.component.md)
- [Toolbar divider component](docs/toolbar-divider.component.md) - [Toolbar divider component](docs/toolbar-divider.component.md)
- [Toolbar title component](docs/toolbar-title.component.md) - [Toolbar title component](docs/toolbar-title.component.md)
- [Toolbar component](docs/toolbar.component.md) - [Toolbar component](docs/toolbar.component.md)
- [Card view component](docs/card-view.component.md) - [Card view component](docs/card-view.component.md)
- [*Accordion group component](ng2-components/ng2-alfresco-core/src/components/collapsable/accordion-group.component.ts)
- [*Context menu holder component](ng2-components/ng2-alfresco-core/src/components/context-menu/context-menu-holder.component.ts)
- [*Data column list component](ng2-components/ng2-alfresco-core/src/components/data-column/data-column-list.component.ts)
- [*Info drawer layout component](ng2-components/ng2-alfresco-core/src/components/info-drawer/info-drawer-layout.component.ts)
- [*Info drawer component](ng2-components/ng2-alfresco-core/src/components/info-drawer/info-drawer.component.ts)
- [*Card view dateitem component](ng2-components/ng2-alfresco-core/src/components/view/card-view-dateitem.component.ts)
- [*Card view item dispatcher component](ng2-components/ng2-alfresco-core/src/components/view/card-view-item-dispatcher.component.ts)
- [*Card view mapitem component](ng2-components/ng2-alfresco-core/src/components/view/card-view-mapitem.component.ts)
- [*Card view textitem component](ng2-components/ng2-alfresco-core/src/components/view/card-view-textitem.component.ts)
### Directives
- [Context menu directive](docs/context-menu.directive.md)
- [Node permission directive](docs/node-permission.directive.md) - [Node permission directive](docs/node-permission.directive.md)
- [Upload directive](docs/upload.directive.md) - [Upload directive](docs/upload.directive.md)
- [*Mdl menu directive](ng2-components/ng2-alfresco-core/src/components/material/mdl-menu.directive.ts)
- [*Mdl textfield directive](ng2-components/ng2-alfresco-core/src/components/material/mdl-textfield.directive.ts)
- [*Mdl upgrade element directive](ng2-components/ng2-alfresco-core/src/components/material/mdl-upgrade-element.directive.ts)
- [*Card view content proxy directive](ng2-components/ng2-alfresco-core/src/components/view/card-view-content-proxy.directive.ts)
- [*Highlight directive](ng2-components/ng2-alfresco-core/src/directives/highlight.directive.ts)
### Services
- [Alfresco api service](docs/alfresco-api.service.md) - [Alfresco api service](docs/alfresco-api.service.md)
- [App config service](docs/app-config.service.md) - [App config service](docs/app-config.service.md)
- [Authentication service](docs/authentication.service.md) - [Authentication service](docs/authentication.service.md)
@@ -336,54 +338,29 @@ for more information about installing and using the source code.
- [Translation service](docs/translation.service.md) - [Translation service](docs/translation.service.md)
- [Upload service](docs/upload.service.md) - [Upload service](docs/upload.service.md)
- [User preferences service](docs/user-preferences.service.md) - [User preferences service](docs/user-preferences.service.md)
- [*Context menu service](ng2-components/ng2-alfresco-core/src/components/context-menu/context-menu.service.ts)
**Undocumented** - [*Alfresco content service](ng2-components/ng2-alfresco-core/src/services/alfresco-content.service.ts)
- [*Alfresco settings service](ng2-components/ng2-alfresco-core/src/services/alfresco-settings.service.ts)
- [Accordion group component](ng2-components/ng2-alfresco-core/src/components/collapsable/accordion-group.component.ts) - [*Auth guard bpm service](ng2-components/ng2-alfresco-core/src/services/auth-guard-bpm.service.ts)
- [Context menu holder component](ng2-components/ng2-alfresco-core/src/components/context-menu/context-menu-holder.component.ts) - [*Auth guard ecm service](ng2-components/ng2-alfresco-core/src/services/auth-guard-ecm.service.ts)
- [Context menu service](ng2-components/ng2-alfresco-core/src/components/context-menu/context-menu.service.ts) - [*Auth guard service](ng2-components/ng2-alfresco-core/src/services/auth-guard.service.ts)
- [Data column list component](ng2-components/ng2-alfresco-core/src/components/data-column/data-column-list.component.ts) - [*Card view update service](ng2-components/ng2-alfresco-core/src/services/card-view-update.service.ts)
- [Info drawer layout component](ng2-components/ng2-alfresco-core/src/components/info-drawer/info-drawer-layout.component.ts) - [*Content service](ng2-components/ng2-alfresco-core/src/services/content.service.ts)
- [Info drawer component](ng2-components/ng2-alfresco-core/src/components/info-drawer/info-drawer.component.ts) - [*Cookie service](ng2-components/ng2-alfresco-core/src/services/cookie.service.ts)
- [Mdl menu directive](ng2-components/ng2-alfresco-core/src/components/material/mdl-menu.directive.ts) - [*Deleted nodes api service](ng2-components/ng2-alfresco-core/src/services/deleted-nodes-api.service.ts)
- [Mdl textfield directive](ng2-components/ng2-alfresco-core/src/components/material/mdl-textfield.directive.ts) - [*Discovery api service](ng2-components/ng2-alfresco-core/src/services/discovery-api.service.ts)
- [Mdl upgrade element directive](ng2-components/ng2-alfresco-core/src/components/material/mdl-upgrade-element.directive.ts) - [*Favorites api service](ng2-components/ng2-alfresco-core/src/services/favorites-api.service.ts)
- [Card view content proxy directive](ng2-components/ng2-alfresco-core/src/components/view/card-view-content-proxy.directive.ts) - [*Highlight transform service](ng2-components/ng2-alfresco-core/src/services/highlight-transform.service.ts)
- [Card view dateitem component](ng2-components/ng2-alfresco-core/src/components/view/card-view-dateitem.component.ts) - [*Log service](ng2-components/ng2-alfresco-core/src/services/log.service.ts)
- [Card view item dispatcher component](ng2-components/ng2-alfresco-core/src/components/view/card-view-item-dispatcher.component.ts) - [*Nodes api service](ng2-components/ng2-alfresco-core/src/services/nodes-api.service.ts)
- [Card view mapitem component](ng2-components/ng2-alfresco-core/src/components/view/card-view-mapitem.component.ts) - [*People api service](ng2-components/ng2-alfresco-core/src/services/people-api.service.ts)
- [Card view textitem component](ng2-components/ng2-alfresco-core/src/components/view/card-view-textitem.component.ts) - [*Search api service](ng2-components/ng2-alfresco-core/src/services/search-api.service.ts)
- [Highlight directive](ng2-components/ng2-alfresco-core/src/directives/highlight.directive.ts) - [*Search service](ng2-components/ng2-alfresco-core/src/services/search.service.ts)
- [Card view baseitem model](ng2-components/ng2-alfresco-core/src/models/card-view-baseitem.model.ts) - [*Shared links api service](ng2-components/ng2-alfresco-core/src/services/shared-links-api.service.ts)
- [Card view dateitem model](ng2-components/ng2-alfresco-core/src/models/card-view-dateitem.model.ts) - [*Sites api service](ng2-components/ng2-alfresco-core/src/services/sites-api.service.ts)
- [Card view mapitem model](ng2-components/ng2-alfresco-core/src/models/card-view-mapitem.model.ts) - [*Storage service](ng2-components/ng2-alfresco-core/src/services/storage.service.ts)
- [Card view textitem model](ng2-components/ng2-alfresco-core/src/models/card-view-textitem.model.ts) - [*Thumbnail service](ng2-components/ng2-alfresco-core/src/services/thumbnail.service.ts)
- [Component model](ng2-components/ng2-alfresco-core/src/models/component.model.ts) - [*Translate loader service](ng2-components/ng2-alfresco-core/src/services/translate-loader.service.ts)
- [File model](ng2-components/ng2-alfresco-core/src/models/file.model.ts)
- [Product version model](ng2-components/ng2-alfresco-core/src/models/product-version.model.ts)
- [Site model](ng2-components/ng2-alfresco-core/src/models/site.model.ts)
- [Alfresco content service](ng2-components/ng2-alfresco-core/src/services/alfresco-content.service.ts)
- [Alfresco settings service](ng2-components/ng2-alfresco-core/src/services/alfresco-settings.service.ts)
- [Auth guard bpm service](ng2-components/ng2-alfresco-core/src/services/auth-guard-bpm.service.ts)
- [Auth guard ecm service](ng2-components/ng2-alfresco-core/src/services/auth-guard-ecm.service.ts)
- [Auth guard service](ng2-components/ng2-alfresco-core/src/services/auth-guard.service.ts)
- [Card view update service](ng2-components/ng2-alfresco-core/src/services/card-view-update.service.ts)
- [Content service](ng2-components/ng2-alfresco-core/src/services/content.service.ts)
- [Cookie service](ng2-components/ng2-alfresco-core/src/services/cookie.service.ts)
- [Deleted nodes api service](ng2-components/ng2-alfresco-core/src/services/deleted-nodes-api.service.ts)
- [Discovery api service](ng2-components/ng2-alfresco-core/src/services/discovery-api.service.ts)
- [Favorites api service](ng2-components/ng2-alfresco-core/src/services/favorites-api.service.ts)
- [Highlight transform service](ng2-components/ng2-alfresco-core/src/services/highlight-transform.service.ts)
- [Log service](ng2-components/ng2-alfresco-core/src/services/log.service.ts)
- [Nodes api service](ng2-components/ng2-alfresco-core/src/services/nodes-api.service.ts)
- [People api service](ng2-components/ng2-alfresco-core/src/services/people-api.service.ts)
- [Search api service](ng2-components/ng2-alfresco-core/src/services/search-api.service.ts)
- [Search service](ng2-components/ng2-alfresco-core/src/services/search.service.ts)
- [Shared links api service](ng2-components/ng2-alfresco-core/src/services/shared-links-api.service.ts)
- [Sites api service](ng2-components/ng2-alfresco-core/src/services/sites-api.service.ts)
- [Storage service](ng2-components/ng2-alfresco-core/src/services/storage.service.ts)
- [Thumbnail service](ng2-components/ng2-alfresco-core/src/services/thumbnail.service.ts)
- [Translate loader service](ng2-components/ng2-alfresco-core/src/services/translate-loader.service.ts)
<!-- ng2-alfresco-core end --> <!-- ng2-alfresco-core end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -393,21 +370,21 @@ for more information about installing and using the source code.
Contains the Datatable component and other related items. See the library's Contains the Datatable component and other related items. See the library's
[README file](ng2-components/ng2-alfresco-datatable/README.md) [README file](ng2-components/ng2-alfresco-datatable/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-datatable start --> <!-- ng2-alfresco-datatable start -->
**Documented**
### Components
- [Datatable component](docs/datatable.component.md) - [Datatable component](docs/datatable.component.md)
- [*Datatable cell component](ng2-components/ng2-alfresco-datatable/src/components/datatable/datatable-cell.component.ts)
- [*Date cell component](ng2-components/ng2-alfresco-datatable/src/components/datatable/date-cell.component.ts)
- [*Empty list component](ng2-components/ng2-alfresco-datatable/src/components/datatable/empty-list.component.ts)
- [*Filesize cell component](ng2-components/ng2-alfresco-datatable/src/components/datatable/filesize-cell.component.ts)
- [*Location cell component](ng2-components/ng2-alfresco-datatable/src/components/datatable/location-cell.component.ts)
**Undocumented** ### Directives
- [Datatable cell component](ng2-components/ng2-alfresco-datatable/src/components/datatable/datatable-cell.component.ts) - [*Loading template directive](ng2-components/ng2-alfresco-datatable/src/directives/loading-template.directive.ts)
- [Date cell component](ng2-components/ng2-alfresco-datatable/src/components/datatable/date-cell.component.ts) - [*No content template directive](ng2-components/ng2-alfresco-datatable/src/directives/no-content-template.directive.ts)
- [Empty list component](ng2-components/ng2-alfresco-datatable/src/components/datatable/empty-list.component.ts)
- [Filesize cell component](ng2-components/ng2-alfresco-datatable/src/components/datatable/filesize-cell.component.ts)
- [Location cell component](ng2-components/ng2-alfresco-datatable/src/components/datatable/location-cell.component.ts)
- [Loading template directive](ng2-components/ng2-alfresco-datatable/src/directives/loading-template.directive.ts)
- [No content template directive](ng2-components/ng2-alfresco-datatable/src/directives/no-content-template.directive.ts)
<!-- ng2-alfresco-datatable end --> <!-- ng2-alfresco-datatable end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -417,31 +394,30 @@ for more information about installing and using the source code.
Contains the Document List component and other related items. See the library's Contains the Document List component and other related items. See the library's
[README file](ng2-components/ng2-alfresco-documentlist/README.md) [README file](ng2-components/ng2-alfresco-documentlist/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-documentlist start --> <!-- ng2-alfresco-documentlist start -->
**Documented**
### Components
- [Breadcrumb component](docs/breadcrumb.component.md) - [Breadcrumb component](docs/breadcrumb.component.md)
- [Document list component](docs/document-list.component.md) - [Document list component](docs/document-list.component.md)
- [Sites dropdown component](docs/sites-dropdown.component.md) - [Sites dropdown component](docs/sites-dropdown.component.md)
- [*Dropdown breadcrumb component](ng2-components/ng2-alfresco-documentlist/src/components/breadcrumb/dropdown-breadcrumb.component.ts)
- [*Content action list component](ng2-components/ng2-alfresco-documentlist/src/components/content-action/content-action-list.component.ts)
- [*Content action component](ng2-components/ng2-alfresco-documentlist/src/components/content-action/content-action.component.ts)
- [*Content column list component](ng2-components/ng2-alfresco-documentlist/src/components/content-column/content-column-list.component.ts)
- [*Content column component](ng2-components/ng2-alfresco-documentlist/src/components/content-column/content-column.component.ts)
- [*Content node selector component](ng2-components/ng2-alfresco-documentlist/src/components/content-node-selector/content-node-selector.component.ts)
**Undocumented** ### Directives
- [Dropdown breadcrumb component](ng2-components/ng2-alfresco-documentlist/src/components/breadcrumb/dropdown-breadcrumb.component.ts) - [*Empty folder content directive](ng2-components/ng2-alfresco-documentlist/src/components/empty-folder/empty-folder-content.directive.ts)
- [Content action list component](ng2-components/ng2-alfresco-documentlist/src/components/content-action/content-action-list.component.ts)
- [Content action component](ng2-components/ng2-alfresco-documentlist/src/components/content-action/content-action.component.ts) ### Services
- [Content column list component](ng2-components/ng2-alfresco-documentlist/src/components/content-column/content-column-list.component.ts)
- [Content column component](ng2-components/ng2-alfresco-documentlist/src/components/content-column/content-column.component.ts) - [*Document actions service](ng2-components/ng2-alfresco-documentlist/src/services/document-actions.service.ts)
- [Content node selector component](ng2-components/ng2-alfresco-documentlist/src/components/content-node-selector/content-node-selector.component.ts) - [*Document list service](ng2-components/ng2-alfresco-documentlist/src/services/document-list.service.ts)
- [Empty folder content directive](ng2-components/ng2-alfresco-documentlist/src/components/empty-folder/empty-folder-content.directive.ts) - [*Folder actions service](ng2-components/ng2-alfresco-documentlist/src/services/folder-actions.service.ts)
- [Content action model](ng2-components/ng2-alfresco-documentlist/src/models/content-action.model.ts) - [*Node actions service](ng2-components/ng2-alfresco-documentlist/src/services/node-actions.service.ts)
- [Document library model](ng2-components/ng2-alfresco-documentlist/src/models/document-library.model.ts)
- [Permissions style model](ng2-components/ng2-alfresco-documentlist/src/models/permissions-style.model.ts)
- [Permissions model](ng2-components/ng2-alfresco-documentlist/src/models/permissions.model.ts)
- [Document actions service](ng2-components/ng2-alfresco-documentlist/src/services/document-actions.service.ts)
- [Document list service](ng2-components/ng2-alfresco-documentlist/src/services/document-list.service.ts)
- [Folder actions service](ng2-components/ng2-alfresco-documentlist/src/services/folder-actions.service.ts)
- [Node actions service](ng2-components/ng2-alfresco-documentlist/src/services/node-actions.service.ts)
<!-- ng2-alfresco-documentlist end --> <!-- ng2-alfresco-documentlist end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -451,17 +427,16 @@ for more information about installing and using the source code.
Contains the Login component and other related items. See the library's Contains the Login component and other related items. See the library's
[README file](ng2-components/ng2-alfresco-login/README.md) [README file](ng2-components/ng2-alfresco-login/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-login start --> <!-- ng2-alfresco-login start -->
**Documented**
### Components
- [Login component](docs/login.component.md) - [Login component](docs/login.component.md)
**Undocumented** ### Directives
- [Login footer directive](ng2-components/ng2-alfresco-login/src/directives/login-footer.directive.ts) - [*Login footer directive](ng2-components/ng2-alfresco-login/src/directives/login-footer.directive.ts)
- [Login header directive](ng2-components/ng2-alfresco-login/src/directives/login-header.directive.ts) - [*Login header directive](ng2-components/ng2-alfresco-login/src/directives/login-header.directive.ts)
- [Form submit event model](ng2-components/ng2-alfresco-login/src/models/form-submit-event.model.ts)
<!-- ng2-alfresco-login end --> <!-- ng2-alfresco-login end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -471,16 +446,13 @@ for more information about installing and using the source code.
Contains the Search component and other related items. See the library's Contains the Search component and other related items. See the library's
[README file](ng2-components/ng2-alfresco-search/README.md) [README file](ng2-components/ng2-alfresco-search/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-search start --> <!-- ng2-alfresco-search start -->
**Documented**
### Components
- [Search control component](docs/search-control.component.md) - [Search control component](docs/search-control.component.md)
- [Search component](docs/search.component.md) - [Search component](docs/search.component.md)
- [*Search autocomplete component](ng2-components/ng2-alfresco-search/src/components/search-autocomplete.component.ts)
**Undocumented**
- [Search autocomplete component](ng2-components/ng2-alfresco-search/src/components/search-autocomplete.component.ts)
<!-- ng2-alfresco-search end --> <!-- ng2-alfresco-search end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -490,16 +462,16 @@ for more information about installing and using the source code.
Contains components for adding likes and ratings to items. See the library's Contains components for adding likes and ratings to items. See the library's
[README file](ng2-components/ng2-alfresco-social/README.md) [README file](ng2-components/ng2-alfresco-social/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-social start --> <!-- ng2-alfresco-social start -->
**Documented**
### Components
- [Like component](docs/like.component.md) - [Like component](docs/like.component.md)
- [Rating component](docs/rating.component.md) - [Rating component](docs/rating.component.md)
**Undocumented** ### Services
- [Rating service](ng2-components/ng2-alfresco-social/src/services/rating.service.ts) - [*Rating service](ng2-components/ng2-alfresco-social/src/services/rating.service.ts)
<!-- ng2-alfresco-social end --> <!-- ng2-alfresco-social end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -509,17 +481,17 @@ for more information about installing and using the source code.
Contains components for adding tags to documents. See the library's Contains components for adding tags to documents. See the library's
[README file](ng2-components/ng2-alfresco-tag/README.md) [README file](ng2-components/ng2-alfresco-tag/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-tag start --> <!-- ng2-alfresco-tag start -->
**Documented**
### Components
- [Tag actions component](docs/tag-actions.component.md) - [Tag actions component](docs/tag-actions.component.md)
- [Tag list component](docs/tag-list.component.md) - [Tag list component](docs/tag-list.component.md)
- [Tag node list component](docs/tag-node-list.component.md) - [Tag node list component](docs/tag-node-list.component.md)
**Undocumented** ### Services
- [Tag service](ng2-components/ng2-alfresco-tag/src/services/tag.service.ts) - [*Tag service](ng2-components/ng2-alfresco-tag/src/services/tag.service.ts)
<!-- ng2-alfresco-tag end --> <!-- ng2-alfresco-tag end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -529,20 +501,19 @@ for more information about installing and using the source code.
Contains components for uploading files to Content Services. See the library's Contains components for uploading files to Content Services. See the library's
[README file](ng2-components/ng2-alfresco-upload/README.md) [README file](ng2-components/ng2-alfresco-upload/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-upload start --> <!-- ng2-alfresco-upload start -->
**Documented**
### Components
- [File uploading dialog component](docs/file-uploading-dialog.component.md) - [File uploading dialog component](docs/file-uploading-dialog.component.md)
- [Upload button component](docs/upload-button.component.md) - [Upload button component](docs/upload-button.component.md)
- [Upload drag area component](docs/upload-drag-area.component.md) - [Upload drag area component](docs/upload-drag-area.component.md)
- [*File uploading list row component](ng2-components/ng2-alfresco-upload/src/components/file-uploading-list-row.component.ts)
- [*File uploading list component](ng2-components/ng2-alfresco-upload/src/components/file-uploading-list.component.ts)
**Undocumented** ### Directives
- [File uploading list row component](ng2-components/ng2-alfresco-upload/src/components/file-uploading-list-row.component.ts) - [*File draggable directive](ng2-components/ng2-alfresco-upload/src/directives/file-draggable.directive.ts)
- [File uploading list component](ng2-components/ng2-alfresco-upload/src/components/file-uploading-list.component.ts)
- [File draggable directive](ng2-components/ng2-alfresco-upload/src/directives/file-draggable.directive.ts)
- [Permissions model](ng2-components/ng2-alfresco-upload/src/models/permissions.model.ts)
<!-- ng2-alfresco-upload end --> <!-- ng2-alfresco-upload end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -552,19 +523,16 @@ for more information about installing and using the source code.
Contains the User Info component and other related items. See the library's Contains the User Info component and other related items. See the library's
[README file](ng2-components/ng2-alfresco-userinfo/README.md) [README file](ng2-components/ng2-alfresco-userinfo/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-userinfo start --> <!-- ng2-alfresco-userinfo start -->
**Documented**
### Components
- [User info component](docs/user-info.component.md) - [User info component](docs/user-info.component.md)
**Undocumented** ### Services
- [Bpm user model](ng2-components/ng2-alfresco-userinfo/src/models/bpm-user.model.ts) - [*Bpm user service](ng2-components/ng2-alfresco-userinfo/src/services/bpm-user.service.ts)
- [Ecm company model](ng2-components/ng2-alfresco-userinfo/src/models/ecm-company.model.ts) - [*Ecm user service](ng2-components/ng2-alfresco-userinfo/src/services/ecm-user.service.ts)
- [Ecm user model](ng2-components/ng2-alfresco-userinfo/src/models/ecm-user.model.ts)
- [Bpm user service](ng2-components/ng2-alfresco-userinfo/src/services/bpm-user.service.ts)
- [Ecm user service](ng2-components/ng2-alfresco-userinfo/src/services/ecm-user.service.ts)
<!-- ng2-alfresco-userinfo end --> <!-- ng2-alfresco-userinfo end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -574,23 +542,26 @@ for more information about installing and using the source code.
Contains the Viewer component and other related items. See the library's Contains the Viewer component and other related items. See the library's
[README file](ng2-components/ng2-alfresco-viewer/README.md) [README file](ng2-components/ng2-alfresco-viewer/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-viewer start --> <!-- ng2-alfresco-viewer start -->
**Documented**
### Components
- [Viewer component](docs/viewer.component.md) - [Viewer component](docs/viewer.component.md)
- [*ImgViewer component](ng2-components/ng2-alfresco-viewer/src/components/imgViewer.component.ts)
- [*MediaPlayer component](ng2-components/ng2-alfresco-viewer/src/components/mediaPlayer.component.ts)
- [*NotSupportedFormat component](ng2-components/ng2-alfresco-viewer/src/components/notSupportedFormat.component.ts)
- [*PdfViewer component](ng2-components/ng2-alfresco-viewer/src/components/pdfViewer.component.ts)
- [*TxtViewer component](ng2-components/ng2-alfresco-viewer/src/components/txtViewer.component.ts)
- [*Pdf view component](ng2-components/ng2-alfresco-viewer/src/components/viewer-dialog/pdf-view/pdf-view.component.ts)
- [*Viewer dialog component](ng2-components/ng2-alfresco-viewer/src/components/viewer-dialog/viewer-dialog.component.ts)
**Undocumented** ### Directives
- [ImgViewer component](ng2-components/ng2-alfresco-viewer/src/components/imgViewer.component.ts) - [*Extension viewer directive](ng2-components/ng2-alfresco-viewer/src/directives/extension-viewer.directive.ts)
- [MediaPlayer component](ng2-components/ng2-alfresco-viewer/src/components/mediaPlayer.component.ts)
- [NotSupportedFormat component](ng2-components/ng2-alfresco-viewer/src/components/notSupportedFormat.component.ts) ### Services
- [PdfViewer component](ng2-components/ng2-alfresco-viewer/src/components/pdfViewer.component.ts)
- [TxtViewer component](ng2-components/ng2-alfresco-viewer/src/components/txtViewer.component.ts) - [*Viewer service](ng2-components/ng2-alfresco-viewer/src/services/viewer.service.ts)
- [Pdf view component](ng2-components/ng2-alfresco-viewer/src/components/viewer-dialog/pdf-view/pdf-view.component.ts)
- [Viewer dialog component](ng2-components/ng2-alfresco-viewer/src/components/viewer-dialog/viewer-dialog.component.ts)
- [Extension viewer directive](ng2-components/ng2-alfresco-viewer/src/directives/extension-viewer.directive.ts)
- [Viewer service](ng2-components/ng2-alfresco-viewer/src/services/viewer.service.ts)
<!-- ng2-alfresco-viewer end --> <!-- ng2-alfresco-viewer end -->
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@@ -600,9 +571,9 @@ for more information about installing and using the source code.
Contains the Webscript component. See the library's Contains the Webscript component. See the library's
[README file](ng2-components/ng2-alfresco-webscript/README.md) [README file](ng2-components/ng2-alfresco-webscript/README.md)
for more information about installing and using the source code. for more information about installing and using the source code.
<!-- ng2-alfresco-webscript start --> <!-- ng2-alfresco-webscript start -->
**Documented**
### Components
- [Webscript component](docs/webscript.component.md) - [Webscript component](docs/webscript.component.md)
<!-- ng2-alfresco-webscript end --> <!-- ng2-alfresco-webscript end -->

1
docs/undocStoplist.json Normal file
View File

@@ -0,0 +1 @@
[ "model" ]

View File

@@ -3,31 +3,84 @@ var path = require('path');
var angFilenameRegex = /([a-zA-Z0-9\-]+)\.((component)|(directive)|(model)|(service)|(widget))\.ts/; var angFilenameRegex = /([a-zA-Z0-9\-]+)\.((component)|(directive)|(model)|(service)|(widget))\.ts/;
var indexFileName = '../docIndex.md'; var indexFileName = path.resolve('..', 'docIndex.md');
var summaryFileName = path.resolve('..', 'docs', 'summary.json'); var summaryFileName = path.resolve('..', 'docs', 'summary.json');
var undocStoplistFileName = path.resolve('..', 'docs', 'undocStoplist.json');
function searchFolderRecursive(folderPath) { // Search source folders for .ts files to discover all components, directives, etc,
var items = fs.readdirSync(path.resolve(folderPath)); // that are in the supplied library.
function searchLibraryRecursive(libData, folderPath) {
var items = fs.readdirSync(folderPath);
for (var i = 0; i < items.length; i++) { for (var i = 0; i < items.length; i++) {
var itemPath = path.resolve(folderPath, items[i]); var itemPath = path.resolve(folderPath, items[i]);
var info = fs.statSync(itemPath); var info = fs.statSync(itemPath);
if (info.isFile() && (items[i].match(angFilenameRegex))) { if (info.isFile() && (items[i].match(angFilenameRegex))) {
var nameNoSuffix = path.basename(items[i], '.ts');//items[i].substring(0, items[i].length - 4); var nameNoSuffix = path.basename(items[i], '.ts');
var itemCategory = nameNoSuffix.split('.')[1];
if(nameNoSuffix in docDict) { if(nameNoSuffix in docDict) {
itemsWithDocs.push(itemPath); switch (itemCategory) {
} else { case "component":
itemsWithoutDocs.push(itemPath); libData.componentsWithDocs.push(itemPath);
break;
case "directive":
libData.directivesWithDocs.push(itemPath);
break;
case "model":
libData.modelsWithDocs.push(itemPath);
break;
case "service":
libData.servicesWithDocs.push(itemPath);
break;
case "widget":
libData.widgetsWithDocs.push(itemPath);
break;
default:
break;
}
} else if (!rejectItemViaStoplist(undocStoplist, items[i])) {
switch (itemCategory) {
case "component":
libData.componentsWithoutDocs.push(itemPath);
break;
case "directive":
libData.directivesWithoutDocs.push(itemPath);
break;
case "model":
libData.modelsWithoutDocs.push(itemPath);
break;
case "service":
libData.servicesWithoutDocs.push(itemPath);
break;
case "widget":
libData.widgetsWithoutDocs.push(itemPath);
break;
default:
break;
}
} }
} else if (info.isDirectory()) { } else if (info.isDirectory()) {
searchFolderRecursive(itemPath); searchLibraryRecursive(libData, itemPath);
} }
} }
} }
// Get a list of all items that have a file in the docs folder.
function getDocFolderItems(docFolderPath) { function getDocFolderItems(docFolderPath) {
var result = {}; var result = {};
var items = fs.readdirSync(path.resolve(docFolderPath)); var items = fs.readdirSync(path.resolve(docFolderPath));
@@ -42,12 +95,15 @@ function getDocFolderItems(docFolderPath) {
return result; return result;
} }
// Convert an Angular-style name (eg, "card-view") into one with correct spaces and uppercase (eg, "Card View").
function tidyName(name) { function tidyName(name) {
var result = name.replace(/-/g, " "); var result = name.replace(/-/g, " ");
result = result.substr(0, 1).toUpperCase() + result.substr(1); result = result.substr(0, 1).toUpperCase() + result.substr(1);
return result; return result;
} }
// Generate the Markdown index for the files from the guide summary.
function makeSummaryIndex() { function makeSummaryIndex() {
var summaryJson = fs.readFileSync(summaryFileName, 'utf8'); var summaryJson = fs.readFileSync(summaryFileName, 'utf8');
var summary = JSON.parse(summaryJson); var summary = JSON.parse(summaryJson);
@@ -63,6 +119,63 @@ function makeSummaryIndex() {
} }
// Create a stoplist of regular expressions.
function makeStoplist(slFilePath) {
var listExpressions = JSON.parse(fs.readFileSync(slFilePath, 'utf8'));
var result = [];
for (var i = 0; i < listExpressions.length; i++) {
result.push(new RegExp(listExpressions[i]));
}
return result;
}
// Check if an item is covered by the stoplist and reject it if so.
function rejectItemViaStoplist(stoplist, itemName) {
for (var i = 0; i < stoplist.length; i++) {
if (stoplist[i].test(itemName)) {
return true;
}
}
return false;
}
function buildIndexSection(name, documented, undocumented) {
var listItems = [];
if ((documented.length > 0) || (undocumented.length > 0)) {
listItems.push('\n### ' + name + '\n');
}
for (var i = 0; i < documented.length; i++) {
var libFilePath = documented[i];
var libFileName = path.basename(libFilePath, '.ts');
var nameSections = libFileName.split('.');
var visibleName = tidyName(nameSections[0]) + ' ' + nameSections[1];
var mdListItem = '- [' + visibleName + '](docs/' + libFileName + '.md)';
listItems.push(mdListItem);
}
for (var i = 0; i < undocumented.length; i++) {
var libFilePath = undocumented[i].replace(/\\/g, '/');
var libFileName = path.basename(libFilePath, '.ts');
var nameSections = libFileName.split('.');
var visibleName = tidyName(nameSections[0]) + ' ' + nameSections[1];
var relPath = libFilePath.substr(libFilePath.indexOf('/ng2-') + 1);
var mdListItem = '- [*' + visibleName + '](' + relPath + ')';
listItems.push(mdListItem);
}
return listItems;
}
var undocStoplist = makeStoplist(undocStoplistFileName);
var docDict = getDocFolderItems(path.resolve('..', 'docs')); var docDict = getDocFolderItems(path.resolve('..', 'docs'));
var rootItems = fs.readdirSync(path.resolve('.')); var rootItems = fs.readdirSync(path.resolve('.'));
@@ -74,50 +187,34 @@ for (var i = 0; i < rootItems.length; i++) {
var info = fs.statSync(itemPath); var info = fs.statSync(itemPath);
if (info.isDirectory() && rootItems[i].match(/ng2-/)) { if (info.isDirectory() && rootItems[i].match(/ng2-/)) {
libs[rootItems[i]] =[ [], [] ]; libs[rootItems[i]] = {
var itemsWithDocs = libs[rootItems[i]][0]; componentsWithDocs: [], componentsWithoutDocs: [],
var itemsWithoutDocs = libs[rootItems[i]][1]; directivesWithDocs: [], directivesWithoutDocs: [],
searchFolderRecursive(path.resolve(itemPath, 'src')); modelsWithDocs: [], modelsWithoutDocs: [],
servicesWithDocs: [], servicesWithoutDocs: [],
widgetsWithDocs: [], widgetsWithoutDocs: [],
};
//var itemsWithDocs = libs[rootItems[i]].componentsWithDocs;
//var itemsWithoutDocs = libs[rootItems[i]].componentsWithoutDocs;
searchLibraryRecursive(libs[rootItems[i]], path.resolve(itemPath, 'src'));
} }
} }
var indexFileText = fs.readFileSync(indexFileName, 'utf8'); var indexFileText = fs.readFileSync(indexFileName, 'utf8');
var libNames = Object.keys(libs); var libNames = Object.keys(libs);
for (var i = 0; i < libNames.length; i++) { for (var i = 0; i < libNames.length; i++) {
var listItems = [];
var libName = libNames[i]; var libName = libNames[i];
var libData = libs[libName]; var libData = libs[libName];
if (libData[0].length > 0) { var listItems = buildIndexSection('Components', libData.componentsWithDocs, libData.componentsWithoutDocs);
listItems.push('**Documented**\n'); listItems = listItems.concat(buildIndexSection('Directives', libData.directivesWithDocs, libData.directivesWithoutDocs));
listItems = listItems.concat(buildIndexSection('Models', libData.modelsWithDocs, libData.modelsWithoutDocs));
for (var j = 0; j < libData[0].length; j++) { listItems = listItems.concat(buildIndexSection('Services', libData.servicesWithDocs, libData.servicesWithoutDocs));
var libFilePath = libData[0][j]; listItems = listItems.concat(buildIndexSection('Widgets', libData.widgetsWithDocs, libData.widgetsWithoutDocs));
var libFileName = path.basename(libFilePath, '.ts');
var nameSections = libFileName.split('.');
var visibleName = tidyName(nameSections[0]) + ' ' + nameSections[1];
var mdListItem = '- [' + visibleName + '](docs/' + libFileName + '.md)';
listItems.push(mdListItem);
}
}
if (libData[1].length > 0) {
listItems.push('\n**Undocumented**\n');
for (var j = 0; j < libData[1].length; j++) {
var libFilePath = libData[1][j].replace(/\\/g, '/');
var libFileName = path.basename(libFilePath, '.ts');
var nameSections = libFileName.split('.');
var visibleName = tidyName(nameSections[0]) + ' ' + nameSections[1];
var relPath = libFilePath.substr(libFilePath.indexOf('/ng2-') + 1);
var mdListItem = '- [' + visibleName + '](' + relPath + ')';
listItems.push(mdListItem);
}
}
var libText = listItems.join('\n'); var libText = listItems.join('\n');
var libStartMarker = '<!-- ' + libName + ' start -->'; var libStartMarker = '<!-- ' + libName + ' start -->';