diff --git a/docs/en/Modules/cms-kit/Blog-System.md b/docs/en/Modules/Cms-Kit/Blog-System.md similarity index 100% rename from docs/en/Modules/cms-kit/Blog-System.md rename to docs/en/Modules/Cms-Kit/Blog-System.md diff --git a/docs/en/Modules/cms-kit/Comment-System.md b/docs/en/Modules/Cms-Kit/Comment-System.md similarity index 100% rename from docs/en/Modules/cms-kit/Comment-System.md rename to docs/en/Modules/Cms-Kit/Comment-System.md diff --git a/docs/en/Modules/Cms-Kit.md b/docs/en/Modules/Cms-Kit/Index.md similarity index 63% rename from docs/en/Modules/Cms-Kit.md rename to docs/en/Modules/Cms-Kit/Index.md index 59fa6ce15c..e3a2ef94c3 100644 --- a/docs/en/Modules/Cms-Kit.md +++ b/docs/en/Modules/Cms-Kit/Index.md @@ -6,20 +6,20 @@ This module provides CMS (Content Management System) capabilities for your appli The following features are currently available: -* Provides a [**page**](cms-kit/Pages.md) management system to manage dynamic pages with dynamic URLs. -* Provides a [**blog**](cms-kit/Blog-System.md) system to create publish blog posts with multiple blog support. -* Provides a [**tagging**](cms-kit/Tag-Management.md) system to tag any kind of resource, like a blog post. -* Provides a [**comment**](cms-kit/Comment-System.md) system to add comments feature to any kind of resource, like blog post or a product review page. -* Provides a [**reaction**](cms-kit/Reaction-System.md) system to add reactions (smileys) feature to any kind of resource, like a blog post or a comment. -* Provides a [**rating**](cms-kit/Rating-System.md) system to add rating feature to any kind of resource. +* Provides a [**page**](Pages.md) management system to manage dynamic pages with dynamic URLs. +* Provides a [**blog**](Blog-System.md) system to create publish blog posts with multiple blog support. +* Provides a [**tagging**](Tag-Management.md) system to tag any kind of resource, like a blog post. +* Provides a [**comment**](Comment-System.md) system to add comments feature to any kind of resource, like blog post or a product review page. +* Provides a [**reaction**](Reaction-System.md) system to add reactions (smileys) feature to any kind of resource, like a blog post or a comment. +* Provides a [**rating**](Rating-System.md) system to add rating feature to any kind of resource. Click to a feature to understand and learn how to use it. -All features are individually usable. If you disable a feature, it completely disappears from your application, even from the database tables, by the help of the [Global Features](../Global-Features.md) system. +All features are individually usable. If you disable a feature, it completely disappears from your application, even from the database tables, by the help of the [Global Features](../../Global-Features.md) system. ## How to Install -[ABP CLI](../CLI.md) allows installing a module to a solution using the `add-module` command. You can install the CMS Kit module in a command-line terminal with the following command: +[ABP CLI](../../CLI.md) allows installing a module to a solution using the `add-module` command. You can install the CMS Kit module in a command-line terminal with the following command: ```bash abp add-module Volo.CmsKit @@ -33,7 +33,7 @@ GlobalFeatureManager.Instance.Modules.CmsKit(cmsKit => }); ``` -Instead of enabling all, you may prefer to enable the features one by one. The following example enables only the [tags](cms-kit/Tag-Management.md) and [comments](cms-kit/Comment-System.md) features: +Instead of enabling all, you may prefer to enable the features one by one. The following example enables only the [tags](Tag-Management.md) and [comments](Comment-System.md) features: ````csharp GlobalFeatureManager.Instance.Modules.CmsKit(cmsKit => @@ -49,7 +49,7 @@ GlobalFeatureManager.Instance.Modules.CmsKit(cmsKit => This module follows the [module development best practices guide](https://docs.abp.io/en/abp/latest/Best-Practices/Index) and consists of several NuGet and NPM packages. See the guide if you want to understand the packages and relations between them. -CMS kit packages are designed for various usage scenarios. When you visit the [CMS kit package list page](https://www.nuget.org/packages?q=Volo.CmsKit), you will see that packages have admin, public and unified versions: +CMS kit packages are designed for various usage scenarios. If you check the [CMS kit packages](https://www.nuget.org/packages?q=Volo.CmsKit), you will see that some packages have `Admin` and `Public` suffixes. The reason is that the module has two application layers, considering they might be used in different type of applications. These application layers uses a single domain layer. - `Volo.CmsKit.Admin.*` packages contain the functionalities required by admin (back office) applications. - `Volo.CmsKit.Public.*` packages contain the functionalities used in public websites where users read blog posts or leave comments. @@ -59,7 +59,7 @@ CMS kit packages are designed for various usage scenarios. When you visit the [C ### Menu items -CMS kit module adds the following items to the "Main" menu, under the "CMS" menu item: +CMS Kit module admin side adds the following items to the main menu, under the *CMS* menu item: * **Pages**: Page management page. * **Blogs**: Blog management page. @@ -75,11 +75,11 @@ CMS kit module adds the following items to the "Main" menu, under the "CMS" menu Pages page is used to manage dynamic pages in the system. -![pages-page](../images/cmskit-module-pages-page.png) +![pages-page](../../images/cmskit-module-pages-page.png) You can create or edit an existing page on this page. -![pages-edit](../images/cmskit-module-pages-edit.png) +![pages-edit](../../images/cmskit-module-pages-edit.png) * When you create a page, you can access the created page via `pages/{slug}` URL. @@ -87,41 +87,41 @@ You can create or edit an existing page on this page. Blogs page is used to create and manage blogs in your system. -![blogs-page](../images/cmskit-module-blogs-page.png) +![blogs-page](../../images/cmskit-module-blogs-page.png) A screenshot from the new blog creation modal: -![blogs-edit](../images/cmskit-module-blogs-edit.png) +![blogs-edit](../../images/cmskit-module-blogs-edit.png) #### Blog Features You can enable or disable a specific feature for blogs by clicking the features action. -![blogs-feature-action](../images/cmskit-module-blogs-feature-action.png) +![blogs-feature-action](../../images/cmskit-module-blogs-feature-action.png) You can select/deselect the desired features for blog posts. -![features-dialog](../images/cmskit-module-features-dialog.png) +![features-dialog](../../images/cmskit-module-features-dialog.png) ### Blog Post Management When you create blogs, you can manage blog posts on this page. -![blog-posts-page](../images/cmskit-module-blog-posts-page.png) +![blog-posts-page](../../images/cmskit-module-blog-posts-page.png) You can create and edit an existing blog post on this page. If you enable specific features such as tags, you can set tags for the blog post on this page. -![blog-post-edit](../images/cmskit-module-blog-post-edit.png) +![blog-post-edit](../../images/cmskit-module-blog-post-edit.png) ### Tag Management CMS Kit provides an extensible tagging mechanism to add tagging capabilities to various places. -![tags-page](../images/cmskit-module-tags-page.png) +![tags-page](../../images/cmskit-module-tags-page.png) You can create or edit an existing tag on this page. -![tag-edit](../images/cmskit-module-tag-edit.png) +![tag-edit](../../images/cmskit-module-tag-edit.png) ### Comment Management @@ -129,17 +129,17 @@ CMS Kit provides an extensible commenting mechanism to add comments to various p You can view and manage comments on this page. -![comment-page](../images/cmskit-module-comment-page.png) +![comment-page](../../images/cmskit-module-comment-page.png) You can manage and view replies on this page. -![comments-detail](../images/cmskit-module-comments-detail.png) +![comments-detail](../../images/cmskit-module-comments-detail.png) ### Reactions CMS Kit provides an extensible reaction component system to allow users to send reactions to your content. Here how the reactions component looks on a sample page. -![reactions](../images/cmskit-module-reactions.png) +![reactions](../../images/cmskit-module-reactions.png) You can also customize the reaction icons shown in the reaction component. @@ -147,4 +147,4 @@ You can also customize the reaction icons shown in the reaction component. You can use the rating component to add rating a mechanism to your content. Here how the rating component looks on a sample page. -![ratings](../images/cmskit-module-ratings.png) \ No newline at end of file +![ratings](../../images/cmskit-module-ratings.png) \ No newline at end of file diff --git a/docs/en/Modules/cms-kit/Pages.md b/docs/en/Modules/Cms-Kit/Pages.md similarity index 100% rename from docs/en/Modules/cms-kit/Pages.md rename to docs/en/Modules/Cms-Kit/Pages.md diff --git a/docs/en/Modules/cms-kit/Rating-System.md b/docs/en/Modules/Cms-Kit/Rating-System.md similarity index 100% rename from docs/en/Modules/cms-kit/Rating-System.md rename to docs/en/Modules/Cms-Kit/Rating-System.md diff --git a/docs/en/Modules/cms-kit/Reaction-System.md b/docs/en/Modules/Cms-Kit/Reaction-System.md similarity index 100% rename from docs/en/Modules/cms-kit/Reaction-System.md rename to docs/en/Modules/Cms-Kit/Reaction-System.md diff --git a/docs/en/Modules/cms-kit/Tag-Management.md b/docs/en/Modules/Cms-Kit/Tag-Management.md similarity index 100% rename from docs/en/Modules/cms-kit/Tag-Management.md rename to docs/en/Modules/Cms-Kit/Tag-Management.md diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index 9d98c824b0..8abfddd251 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -1200,7 +1200,7 @@ }, { "text": "CMS Kit", - "path": "Modules/Cms-Kit.md" + "path": "Modules/Cms-Kit/Index.md" }, { "text": "Docs",