rearranged docs folder; added contribute/share-a-plugin.md file; adde…

…d plugins section
redkite-labs · Jun 8, 2015 · cea1493 · cea1493
1 parent 5d5d357
commit cea1493
Show file tree

Hide file tree

Showing 44 changed files with 487 additions and 104 deletions.
diff --git a/docs/book/create-a-new-block.md b/docs/book/create-a-new-block.md
diff --git a/docs/book/how-to-change-the-website-theme-with-redkite-cms.md b/docs/book/how-to-change-the-website-theme-with-redkite-cms.md
diff --git a/docs/book/how-to-secure-redkite-cms.md b/docs/book/how-to-secure-redkite-cms.md
diff --git a/docs/book/redkite-cms-external-files-management.md b/docs/book/redkite-cms-external-files-management.md
diff --git a/docs/book/redkite-cms-inline-contents-editor.md b/docs/book/redkite-cms-inline-contents-editor.md
diff --git a/docs/book/redkite-cms-languages-management.md b/docs/book/redkite-cms-languages-management.md
diff --git a/docs/book/redkite-cms-pages-management.md b/docs/book/redkite-cms-pages-management.md
diff --git a/docs/book/redkite-cms-themes-management.md b/docs/book/redkite-cms-themes-management.md
diff --git a/docs/book/redkite-cms-user-interface-design.md b/docs/book/redkite-cms-user-interface-design.md
diff --git a/docs/book/redkite-cms-website-deploy.md b/docs/book/redkite-cms-website-deploy.md
diff --git a/docs/book/redkite-cms-website-navigation.md b/docs/book/redkite-cms-website-navigation.md
diff --git a/docs/plugins/blocks/agency-service.md b/docs/plugins/blocks/agency-service.md
@@ -0,0 +1,71 @@
+#Services block
+This block handles a content that describes the services your company offer. It provides two blocks:
+
+- AgencyService
+- AgencyServicesCollection
+
+The AgencyService is the single service
+The AgencyServicesCollection is a collection of AgencyService blocks
+
+## Get the block
+This block is included into the **redkitecms-plugins** library which is already bundled with RedKite CMS 2 since alpha 3 release. It is installed using composer as follows:
+
+    "require": {
+       [...]
+       "redkite-labs/redkitecms-plugins": "@dev",
+    }
+
+## AgencyService Definition
+Here it is the service definition:
+
+    children:
+      item1:
+        children:
+          item1:
+            value: ''
+            tags:
+              class: 'fa fa-circle fa-stack-2x text-primary'
+            type: Icon
+          item2:
+            value: ''
+            tags:
+              class: 'fa fa-shopping-cart fa-stack-1x fa-inverse'
+            type: Icon
+        tags:
+          class: 'fa-stack fa-4x'
+        type: IconStacked
+        value: ''
+    tags:
+      class: col-md-4
+    type: AgencyService
+    service_title: 'Service title'
+    service_description: 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. Minima maxime quam architecto quo inventore harum ex magni, dicta impedit.'
+
+The **children part** defines a [fontawesome stacked icon](http://fortawesome.github.io/Font-Awesome/examples/) you can easily customize changing the **item2** entry. For example, to display a bomb icon you would change that entry as follows:
+
+    item2:
+        value: ''
+        tags:
+          class: 'fa fa-bomb fa-stack-1x fa-inverse'
+        type: Icon
+
+To change the icon dimension your change the item class:
+
+    tags:
+        class: 'fa-stack fa-2x'
+
+To change the block dimension just change the block class:
+
+    children:
+        [..]
+        tags:
+          class: col-md-6
+          
+Then, to change the title and the displayed text, just edit the **service_title** and **service_description** properties:
+
+    service_title: 'E-Commerce'
+    service_description: 'It is easy to sell your products from your website...'
+
+## AgencyServicesCollection Definition
+
+As explained at the beginning, This block collections AgencyService blocks, so you can edit them as explained above. To add a new item just click the button on the inline editor. 
diff --git a/docs/plugins/blocks/portfolio.md b/docs/plugins/blocks/portfolio.md
@@ -0,0 +1,89 @@
+#Portfolio block
+This block handles a terrific portfolio content which renders single works in a row. Each work can be clicked and a nice modal opens to provide extra details for that job. 
+
+- Portfolio
+- PortfolioItem
+
+The **PortfolioItem** represents a job and cannot be used singularly.
+The **Portfolio** collects **PortfolioItem** blocks.
+
+## Get the block
+This block is included into the **redkitecms-plugins** library which is already bundled with RedKite CMS 2 since alpha 3 release. It is installed using composer as follows:
+
+    "require": {
+       [...]
+       "redkite-labs/redkitecms-plugins": "@dev",
+    }
+
+## PortfolioItem Definition
+Here it is the PortfolioItem definition:
+
+    children:
+      item1:
+        value: ''
+        tags:
+          src: /plugins/agencytheme/img/portfolio/roundicons.png
+          class: img-responsive
+          title: ''
+          alt: ''
+        href: ''
+        type: Image
+      item2:
+        value: ''
+        tags:
+          src: /plugins/agencytheme/img/portfolio/roundicons-free.png
+          class: img-responsive
+          title: ''
+          alt: ''
+        href: ''
+        type: Image
+    tags:
+      class: 'portfolio-item col-md-4 col-sm-6'
+    type: PortfolioItem
+    hover_icon: 'fa fa-plus fa-3x'
+    title: Round Icons
+    subtitle: Graphic Design
+    modal_title: 'Project name'
+    modal_description: 'Lorem ipsum dolor sit amet consectetur.'
+    modal_body: 'Use this section to describe your project. You can add normal text as html text as well. Please note this text lives into a modal form, so you must click the item to check it'
+
+This block has several properties to describe the job:
+
+    hover_icon: 'fa fa-plus fa-3x'
+    title: Round Icons
+    subtitle: Graphic Design
+    modal_title: 'Project name'
+    modal_description: 'Lorem ipsum dolor sit amet consectetur.'
+    modal_body: 'Use this section to describe your project. You can add normal text as html text as well. Please note this text lives into a modal form, so you must click the item to check it'
+
+**hover_icon** represents the icon displayed when the mouse is placed over the block, **title** and **subtitle** handle the text for the block when displayed in the collection and **modal_title**, **modal_description** and **modal_body** handles the texts on the modal dialog.
+
+The item block size can be changed managing the block's class property:
+
+    tags:
+      class: 'portfolio-item col-md-4 col-sm-6'
+
+and, at last, there are two images the first one handles the image block when displayed in the collection, the second one handles the image for the modal dialog
+
+    item1:
+      value: ''
+      tags:
+        src: /plugins/agencytheme/img/portfolio/roundicons.png
+        class: img-responsive
+        title: ''
+        alt: ''
+      href: ''
+      type: Image
+    item2:
+      value: ''
+      tags:
+        src: /plugins/agencytheme/img/portfolio/roundicons-free.png
+        class: img-responsive
+        title: ''
+        alt: ''
+      href: ''
+      type: Image
+      
+## Portfolio Definition
+
+This block is a collection of PortfolioItem blocks, you can edit them as explained above. To add a new item just click the button on the inline editor. 
diff --git a/docs/plugins/blocks/team.md b/docs/plugins/blocks/team.md
@@ -0,0 +1,99 @@
+#Team block
+This block handles a content which renders an awesome representation of a working team. This plugin is made by two blocks:
+
+- MemberTeam
+- MemberTeamCollection
+
+The **MemberTeam** represents the single member of the team.
+The **MemberTeamCollection** collects **MemberTeam** blocks. 
+
+## Get the block
+This block is included into the **redkitecms-plugins** library which is already bundled with RedKite CMS 2 since alpha 3 release. It is installed using composer as follows:
+
+    "require": {
+       [...]
+       "redkite-labs/redkitecms-plugins": "@dev",
+    }
+
+## MemberTeam Definition
+Here it is the timeline definition:
+
+    children:
+      item1:
+        value: ''
+        tags:
+          src: /plugins/memberteam/images/team.jpg
+          class: 'img-responsive img-circle'
+          title: ''
+          alt: ''
+        href: ''
+        type: Image
+      item2:
+        children:
+          item1:
+            value: ''
+            tags:
+              class: 'fa fa-twitter'
+            type: Link
+          item2:
+            value: ''
+            tags:
+              class: 'fa fa-facebook'
+            type: Link
+          item3:
+            value: ''
+            tags:
+              class: 'fa fa-linkedin'
+            type: Link
+        tags:
+          class: 'list-inline social-buttons'
+        type: Menu
+    tags:
+      class: col-sm-4
+    type: MemberTeam
+    member_name: 'Jane Doe'
+    member_role: 'Lead Designer'
+
+This block has two properties to define the member:
+
+    member_name: 'Jane Doe'
+    member_role: 'Lead Designer'
+
+and then collects an image to show the member face, with the **img-responsive img-circle** Bootstrap class attributes to render the image as a circle:
+
+    item1:
+      value: ''
+      tags:
+        src: /plugins/memberteam/images/team.jpg
+        class: 'img-responsive img-circle'
+        title: ''
+        alt: ''
+      href: ''
+      type: Image
+
+and a menu to provide the member social contact:
+
+    item2:
+      children:
+        item1:
+          value: ''
+          tags:
+            class: 'fa fa-twitter'
+          type: Link
+        item2:
+          value: ''
+          tags:
+            class: 'fa fa-facebook'
+          type: Link
+        item3:
+          value: ''
+          tags:
+            class: 'fa fa-linkedin'
+          type: Link
+      tags:
+        class: 'list-inline social-buttons'
+      type: Menu
+      
+## MemberTeamCollection Definition
+
+This block is a collection of MemberTeam blocks, you can edit them as explained above. To add a new item just click the button on the inline editor.