mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-1453] Restructure README.md files (#2272)
* ADF-1453: Restructured Activiti Diagrams readme * [ADF-1453] Fixed README indexing script to handle linefeeds and Windows paths * [ADF-1453] Including changes to readme indexing script
This commit is contained in:
Andy Stark
Mario Romano
@@ -26,18 +26,73 @@
|
||||
|
||||
### Components
|
||||
|
||||
<!-- CORE START--><!-- CORE END-->
|
||||
<!-- CORE START-->
|
||||
- [adf-accordion](ng2-alfresco-core/README.md)
|
||||
- [adf-accordion-group](ng2-alfresco-core/README.md)
|
||||
- [adf-card-view](ng2-alfresco-core/README.md)
|
||||
- [adf-card-view-textitem](ng2-alfresco-core/README.md)
|
||||
- [adf-card-view-mapitem](ng2-alfresco-core/README.md)
|
||||
- [adf-card-view-dateitem](ng2-alfresco-core/README.md)
|
||||
- [adf-card-view-item-dispatcher](ng2-alfresco-core/README.md)
|
||||
- [adf-toolbar](ng2-alfresco-core/README.md)
|
||||
- [adf-toolbar-title](ng2-alfresco-core/README.md)
|
||||
- [adf-toolbar-divider](ng2-alfresco-core/README.md)
|
||||
- [adf-pagination](ng2-alfresco-core/README.md)
|
||||
- [adf-context-menu-holder](ng2-alfresco-core/README.md)
|
||||
- [adf-info-drawer-layout](ng2-alfresco-core/README.md)
|
||||
- [adf-info-drawer-tab](ng2-alfresco-core/README.md)
|
||||
- [adf-download-zip-dialog](ng2-alfresco-core/README.md)
|
||||
- [adf-create-folder-dialog](ng2-alfresco-core/README.md)<!-- CORE END-->
|
||||
<!-- CORE END-->
|
||||
|
||||
### Directives
|
||||
|
||||
<!-- CORE DIRECTIVE START--><!-- CORE DIRECTIVE END-->
|
||||
<!-- CORE DIRECTIVE START-->
|
||||
- [adf-card-view-content-proxy](ng2-alfresco-core/README.md)
|
||||
- [adf-context-menu](ng2-alfresco-core/README.md)
|
||||
- [adf-mdl-menu](ng2-alfresco-core/README.md)
|
||||
- [adf-mdl-textfield](ng2-alfresco-core/README.md)
|
||||
- [adf-upload](ng2-alfresco-core/README.md)
|
||||
- [adf-node-permission](ng2-alfresco-core/README.md)
|
||||
- [adf-highlight](ng2-alfresco-core/README.md)<!-- CORE DIRECTIVE END-->
|
||||
|
||||
## Content service
|
||||
|
||||
### Components
|
||||
|
||||
<!-- CONTENT START--><!-- CONTENT END-->
|
||||
<!-- CONTENT START-->
|
||||
- [adf-webscript-get](ng2-alfresco-webscript/README.md)
|
||||
- [adf-file-uploading-dialog](ng2-alfresco-upload/README.md)
|
||||
- [adf-file-uploading-list](ng2-alfresco-upload/README.md)
|
||||
- [adf-upload-drag-area](ng2-alfresco-upload/README.md)
|
||||
- [adf-upload-button](ng2-alfresco-upload/README.md)
|
||||
- [adf-file-uploading-list-row](ng2-alfresco-upload/README.md)
|
||||
- [adf-userinfo](ng2-alfresco-userinfo/README.md)
|
||||
- [adf-login](ng2-alfresco-login/README.md)
|
||||
- [adf-location-cell](ng2-alfresco-datatable/README.md)
|
||||
- [adf-empty-list](ng2-alfresco-datatable/README.md)
|
||||
- [adf-datatable](ng2-alfresco-datatable/README.md)
|
||||
- [adf-tag-node-list](ng2-alfresco-tag/README.md)
|
||||
- [adf-tag-list](ng2-alfresco-tag/README.md)
|
||||
- [adf-search](ng2-alfresco-search/README.md)
|
||||
- [adf-tag-node-actions-list](ng2-alfresco-tag/README.md)
|
||||
- [adf-search-control](ng2-alfresco-search/README.md)
|
||||
- [adf-search-autocomplete](ng2-alfresco-search/README.md)
|
||||
- [adf-datatable-cell](ng2-alfresco-datatable/README.md)
|
||||
- [adf-viewer-dialog](ng2-alfresco-viewer/README.md)
|
||||
- [adf-txt-viewer](ng2-alfresco-viewer/README.md)
|
||||
- [adf-pdf-viewer](ng2-alfresco-viewer/README.md)
|
||||
- [adf-not-supported-format](ng2-alfresco-viewer/README.md)
|
||||
- [adf-media-player](ng2-alfresco-viewer/README.md)
|
||||
- [adf-viewer](ng2-alfresco-viewer/README.md)
|
||||
- [adf-img-viewer](ng2-alfresco-viewer/README.md)
|
||||
- [adf-rating](ng2-alfresco-social/README.md)
|
||||
- [adf-like](ng2-alfresco-social/README.md)
|
||||
- [adf-sites-dropdown](ng2-alfresco-documentlist/README.md)
|
||||
- [adf-content-node-selector](ng2-alfresco-documentlist/README.md)
|
||||
- [adf-dropdown-breadcrumb](ng2-alfresco-documentlist/README.md)
|
||||
- [adf-breadcrumb](ng2-alfresco-documentlist/README.md)
|
||||
- [adf-document-list](ng2-alfresco-documentlist/README.md)<!-- CONTENT END-->
|
||||
<!-- CONTENT END-->
|
||||
|
||||
<!-- CONTENT DIRECTIVE START--><!-- CONTENT DIRECTIVE END-->
|
||||
@@ -46,14 +101,109 @@
|
||||
|
||||
### components
|
||||
|
||||
<!-- BUSINESS START--><!-- BUSINESS END-->
|
||||
<!-- BUSINESS START-->
|
||||
- [adf-diagram-publish-task](ng2-activiti-diagrams/README.md)
|
||||
- [adf-text-editor](ng2-activiti-form/README.md)
|
||||
- [adf-dropdown-editor](ng2-activiti-form/README.md)
|
||||
- [adf-date-editor](ng2-activiti-form/README.md)
|
||||
- [adf-boolean-editor](ng2-activiti-form/README.md)
|
||||
- [adf-unknown-widget](ng2-activiti-form/README.md)
|
||||
- [adf-date-range-widget](ng2-activiti-analytics/README.md)
|
||||
- [adf-diagram-sequence-flow](ng2-activiti-diagrams/README.md)
|
||||
- [adf-diagram](ng2-activiti-diagrams/README.md)
|
||||
- [adf-tasklist](ng2-activiti-tasklist/README.md)
|
||||
- [adf-process-instance-details](ng2-activiti-processlist/README.md)
|
||||
- [adf-start-process](ng2-activiti-processlist/README.md)
|
||||
- [adf-process-instance-list](ng2-activiti-processlist/README.md)
|
||||
- [adf-process-instance-tasks](ng2-activiti-processlist/README.md)
|
||||
- [adf-process-instance-variables](ng2-activiti-processlist/README.md)
|
||||
- [adf-process-instance-header](ng2-activiti-processlist/README.md)
|
||||
- [adf-process-instance-filters](ng2-activiti-processlist/README.md)
|
||||
- [adf-process-instance-comments](ng2-activiti-processlist/README.md)
|
||||
- [adf-process-attachment-list](ng2-activiti-processlist/README.md)
|
||||
- [adf-create-process-attachment](ng2-activiti-processlist/README.md)
|
||||
- [adf-task-header](ng2-activiti-tasklist/README.md)
|
||||
- [adf-filters](ng2-activiti-tasklist/README.md)
|
||||
- [adf-task-attachment-list](ng2-activiti-tasklist/README.md)
|
||||
- [adf-people](ng2-activiti-tasklist/README.md)
|
||||
- [adf-task-details](ng2-activiti-tasklist/README.md)
|
||||
- [adf-start-task](ng2-activiti-tasklist/README.md)
|
||||
- [adf-people-list](ng2-activiti-tasklist/README.md)
|
||||
- [adf-people-search](ng2-activiti-tasklist/README.md)
|
||||
- [adf-create-task-attachment](ng2-activiti-tasklist/README.md)
|
||||
- [adf-comments](ng2-activiti-tasklist/README.md)
|
||||
- [adf-comment-list](ng2-activiti-tasklist/README.md)
|
||||
- [adf-checklist](ng2-activiti-tasklist/README.md)
|
||||
- [adf-apps](ng2-activiti-tasklist/README.md)
|
||||
- [adf-content](ng2-activiti-form/README.md)
|
||||
- [adf-form-field](ng2-activiti-form/README.md)
|
||||
- [adf-start-form](ng2-activiti-form/README.md)
|
||||
- [adf-form](ng2-activiti-form/README.md)
|
||||
- [adf-form-list](ng2-activiti-form/README.md)
|
||||
- [adf-analytics](ng2-activiti-analytics/README.md)
|
||||
- [adf-analytics-report-parameters](ng2-activiti-analytics/README.md)
|
||||
- [adf-analytics-report-list](ng2-activiti-analytics/README.md)
|
||||
- [adf-analytics-report-heat-map](ng2-activiti-analytics/README.md)
|
||||
- [adf-analytics-generator](ng2-activiti-analytics/README.md)<!-- BUSINESS END-->
|
||||
<!-- BUSINESS END-->
|
||||
|
||||
<!-- BUSINESS DIRECTIVE START--><!-- BUSINESS DIRECTIVE END-->
|
||||
|
||||
## Services
|
||||
|
||||
<!-- SERVICES START--><!-- SERVICES END-->
|
||||
<!-- SERVICES START-->
|
||||
- [DiagramsService](ng2-activiti-diagrams/src/services/diagrams.service.ts)
|
||||
- [DiagramColorService](ng2-activiti-diagrams/src/services/diagram-color.service.ts)
|
||||
- [ContextMenuService](ng2-alfresco-core/src/components/context-menu/context-menu.service.ts)
|
||||
- [RaphaelService](ng2-activiti-diagrams/src/components/raphael/raphael.service.ts)
|
||||
- [TagService](ng2-alfresco-tag/src/services/tag.service.ts)
|
||||
- [EcmUserService](ng2-alfresco-userinfo/src/services/ecm-user.service.ts)
|
||||
- [BpmUserService](ng2-alfresco-userinfo/src/services/bpm-user.service.ts)
|
||||
- [ProcessUploadService](ng2-activiti-processlist/src/services/process-upload.service.ts)
|
||||
- [ProcessService](ng2-activiti-processlist/src/services/process.service.ts)
|
||||
- [ProcessUploadService](ng2-activiti-tasklist/src/services/process-upload.service.ts)
|
||||
- [TaskListService](ng2-activiti-tasklist/src/services/tasklist.service.ts)
|
||||
- [PeopleService](ng2-activiti-tasklist/src/services/people.service.ts)
|
||||
- [WidgetVisibilityService](ng2-activiti-form/src/services/widget-visibility.service.ts)
|
||||
- [NodeService](ng2-activiti-form/src/services/node.service.ts)
|
||||
- [FormService](ng2-activiti-form/src/services/form.service.ts)
|
||||
- [FormRenderingService](ng2-activiti-form/src/services/form-rendering.service.ts)
|
||||
- [ActivitiContentService](ng2-activiti-form/src/services/activiti-content-service.ts)
|
||||
- [ActivitiAlfrescoContentService](ng2-activiti-form/src/services/activiti-alfresco.service.ts)
|
||||
- [EcmModelService](ng2-activiti-form/src/services/ecm-model.service.ts)
|
||||
- [RenderingQueueService](ng2-alfresco-viewer/src/services/rendering-queue.services.ts)
|
||||
- [ViewerService](ng2-alfresco-viewer/src/services/viewer.service.ts)
|
||||
- [AnalyticsService](ng2-activiti-analytics/src/services/analytics.service.ts)
|
||||
- [RatingService](ng2-alfresco-social/src/services/rating.service.ts)
|
||||
- [FolderActionsService](ng2-alfresco-documentlist/src/services/folder-actions.service.ts)
|
||||
- [NodeActionsService](ng2-alfresco-documentlist/src/services/node-actions.service.ts)
|
||||
- [DocumentListService](ng2-alfresco-documentlist/src/services/document-list.service.ts)
|
||||
- [DocumentActionsService](ng2-alfresco-documentlist/src/services/document-actions.service.ts)
|
||||
- [UploadService](ng2-alfresco-core/src/services/upload.service.ts)
|
||||
- [CardViewUpdateService](ng2-alfresco-core/src/services/card-view-update.service.ts)
|
||||
- [SitesApiService](ng2-alfresco-core/src/services/sites-api.service.ts)
|
||||
- [SharedLinksApiService](ng2-alfresco-core/src/services/shared-links-api.service.ts)
|
||||
- [SearchService](ng2-alfresco-core/src/services/search.service.ts)
|
||||
- [SearchApiService](ng2-alfresco-core/src/services/search-api.service.ts)
|
||||
- [PeopleApiService](ng2-alfresco-core/src/services/people-api.service.ts)
|
||||
- [FavoritesApiService](ng2-alfresco-core/src/services/favorites-api.service.ts)
|
||||
- [NodesApiService](ng2-alfresco-core/src/services/nodes-api.service.ts)
|
||||
- [TranslationService](ng2-alfresco-core/src/services/translation.service.ts)
|
||||
- [DiscoveryApiService](ng2-alfresco-core/src/services/discovery-api.service.ts)
|
||||
- [DeletedNodesApiService](ng2-alfresco-core/src/services/deleted-nodes-api.service.ts)
|
||||
- [UserPreferencesService](ng2-alfresco-core/src/services/user-preferences.service.ts)
|
||||
- [ThumbnailService](ng2-alfresco-core/src/services/thumbnail.service.ts)
|
||||
- [StorageService](ng2-alfresco-core/src/services/storage.service.ts)
|
||||
- [RenditionsService](ng2-alfresco-core/src/services/renditions.service.ts)
|
||||
- [NotificationService](ng2-alfresco-core/src/services/notification.service.ts)
|
||||
- [AlfrescoSettingsService](ng2-alfresco-core/src/services/alfresco-settings.service.ts)
|
||||
- [LogService](ng2-alfresco-core/src/services/log.service.ts)
|
||||
- [CookieService](ng2-alfresco-core/src/services/cookie.service.ts)
|
||||
- [ContentService](ng2-alfresco-core/src/services/content.service.ts)
|
||||
- [AuthenticationService](ng2-alfresco-core/src/services/authentication.service.ts)
|
||||
- [AlfrescoContentService](ng2-alfresco-core/src/services/alfresco-content.service.ts)
|
||||
- [AppConfigService](ng2-alfresco-core/src/services/app-config.service.ts)
|
||||
- [AlfrescoApiService](ng2-alfresco-core/src/services/alfresco-api.service.ts)<!-- SERVICES END-->
|
||||
|
||||
You can browse all the components at the following address:
|
||||
|
||||
|
||||
@@ -47,7 +47,7 @@ function eraseContentList() {
|
||||
function generateListComponent(currentFileContent, webpackInstance) {
|
||||
if (!isFileEmpty(currentFileContent)) {
|
||||
|
||||
var componentReg = /(@Component)(\s?)\((\s?){(\s?)((.|\n)*)}(\s?)\)/gm;
|
||||
var componentReg = /(@Component)(\s?)\((\s?){(\s?)((.|[\n\r])*)}(\s?)\)/gm;
|
||||
var componentSection = componentReg.exec(currentFileContent);
|
||||
|
||||
if (componentSection) {
|
||||
@@ -56,10 +56,10 @@ function generateListComponent(currentFileContent, webpackInstance) {
|
||||
var selector = selectorReg.exec(componentSection[0]);
|
||||
|
||||
if (selector) {
|
||||
var removeRoot = webpackInstance.resourcePath.substr(webpackInstance.resourcePath.indexOf('/ng2-components') + 16, webpackInstance.resourcePath.length);
|
||||
var rawPath = webpackInstance.resourcePath.replace(/\\/g, "/");
|
||||
var removeRoot = rawPath.substr(rawPath.indexOf('/ng2-components') + 16, rawPath.length);
|
||||
var url = removeRoot.substr(0, removeRoot.indexOf('src')) + 'README.md';
|
||||
|
||||
|
||||
var link = '- [' + selector[0] + '](' + url + ')';
|
||||
|
||||
if (webpackInstance.resourcePath.match('ng2-alfresco-core')) {
|
||||
@@ -74,7 +74,7 @@ function generateListComponent(currentFileContent, webpackInstance) {
|
||||
|
||||
|
||||
|
||||
var directiveReg = /(@Directive)(\s?)\((\s?){(\s?)((.|\n)*)}(\s?)\)/gm;
|
||||
var directiveReg = /(@Directive)(\s?)\((\s?){(\s?)((.|[\r\n])*)}(\s?)\)/gm;
|
||||
var directiveSection = directiveReg.exec(currentFileContent);
|
||||
|
||||
if (directiveSection) {
|
||||
@@ -83,7 +83,9 @@ function generateListComponent(currentFileContent, webpackInstance) {
|
||||
|
||||
if (selector) {
|
||||
var selector = selector[0].replace("selector: '[", "").replace("']", '').replace("]", '').replace("selector: '", "").replace("'", '');
|
||||
var removeRoot = webpackInstance.resourcePath.substr(webpackInstance.resourcePath.indexOf('/ng2-components') + 16, webpackInstance.resourcePath.length);
|
||||
|
||||
var rawPath = webpackInstance.resourcePath.replace(/\\/g, "/");
|
||||
var removeRoot = rawPath.substr(rawPath.indexOf('/ng2-components') + 16, rawPath.length);
|
||||
var url = removeRoot.substr(0, removeRoot.indexOf('src')) + 'README.md';
|
||||
|
||||
var link = '- [' + selector + '](' + url + ')';
|
||||
@@ -109,7 +111,7 @@ function generateListComponent(currentFileContent, webpackInstance) {
|
||||
function generateListservices(currentFileContent, webpackInstance) {
|
||||
if (!isFileEmpty(currentFileContent)) {
|
||||
|
||||
var servicesReg = /(@Injectable\(\))(([a-zA-Z ]|\n)*)/gm;
|
||||
var servicesReg = /(@Injectable\(\))(([a-zA-Z ]|[\r\n])*)/gm;
|
||||
var servicesSection = servicesReg.exec(currentFileContent);
|
||||
|
||||
if (servicesSection) {
|
||||
@@ -118,7 +120,8 @@ function generateListservices(currentFileContent, webpackInstance) {
|
||||
var selector = selectorReg.exec(servicesSection[0]);
|
||||
|
||||
if (selector) {
|
||||
var url = webpackInstance.resourcePath.substr(webpackInstance.resourcePath.indexOf('/ng2-components') + 16, webpackInstance.resourcePath.length);
|
||||
var rawPath = webpackInstance.resourcePath.replace(/\\/g, "/");
|
||||
var url = rawPath.substr(rawPath.indexOf('/ng2-components') + 16, rawPath.length);
|
||||
|
||||
var link = '- [' + selector[0] + '](' + url + ')';
|
||||
|
||||
@@ -150,4 +153,3 @@ module.exports = function (input, map) {
|
||||
}
|
||||
callback(null, input, map);
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user