Basic orchard concept definitions-orchard basic concept definition

ArticleDirectory

• General CMS definitions --- general definition of CMS
• Orchard concepts-orchard Concept
• Ui composition -- interface Synthesis

Orchard is a Web CMS system that helps us build websites through existing modules. If we want to use the orchard CMS system to create website applications more efficiently, we need to familiarize ourselves with some basic concepts and terms of orchard. This article will explain some concepts used by the orchard system and their functions.

 

General CMS definitions --- general definition of CMS

In CMS, 'C' means "content", that is, content. It can be understood that all things managed by the CMS system can be referred to as content. More accurately, the content is all the information on the website. For example, a blog post, a comment, a product display information, a navigation menu, or a company logo image can be distinguished and independent. If you are thinking that the content is everything on the website, that's right. If you still think this concept is vague, there is nothing wrong with it. Fortunately, we will elaborate on different content concepts in more detail in the following chapter.

Admin panel, dashboard or back-end website background management interface

The website background management interface is the place where we can manage websites and website content. Only users authorized to access the background management interface can access and manage the website and website content. This is what 'M' means in CMS.

 

S in CMS

The concept of 's' in CMS should not sound so vague. CMS manages content in a systematic way: All content can be managed in the same way.
For example, you can use the same tool to manage blog articles, page content, and product display information. You can also use common modules to add comments, scores, and tags. In this way, the system has a consistent experience and makes it easier to create new types of content.
Front-end -- front-end

The front-end is the interface accessible to all users on the website. In other words, the front-end is all parts that can be accessed by the public except the background management interface.

 

Setup -- install configurations

The installation configuration is a necessary process for you to configure the website from the initial status to the operational status (In addition, you have a lot to do, such as creating the website content ).

 

Orchard concepts-orchard concept content item -- content entry

A content entry is a separate piece of content, which can be accessed through a separate URL. For example, a page, blog article, or product display.
Content type -- content type

Content entries are Content-Type instances. In other words, content entries belong to the content type. In the previous section, we talked about examples of content entries, pages, blog articles, and product presentations. These three examples are also three different content types.
Content Part-content unit

In the orchard system, the content type is composed of small content units. The content unit is the smallest unit of content and can be reused by other content types.

 

 

For example, comments, tags, or ratings are all content units because they have specific functions and can be reused by any content type. Comment as a content unit is not limited to a specific content type, such as blog articles. Comments play the same role in the content type of blog articles as in other content types, with no difference. One content type can have only one and only one same content unit.

Content field -- content field

The content field can be added to a content type. The content field has a name and a data type, and is limited to this content type, that is, it cannot be reused in other content types like content units. A content type can contain many content fields of the same data type.

For example, a product content type has a text content field to represent the unique identifier of the product, a digital content field to represent the price, and a digital content field to represent the weight. Each of these content fields may only make sense for this product and will not be used in other content types.

Note: You can also create a content unit named product, which contains the three content fields mentioned above. In this way, you can convert any content type into a product. Both methods are feasible in the orchard system.

Module-Module

Many of orchard's extended applications are created as modules. A module is a set of function extensions of orchard, which are integrated into the same subdirectory under the modules directory on the orchard website.
You can also find many available modules in Orchard Gallery.

 

 

Feature-Features

A module can have one or more features. It logically organizes these features, but each feature can be enabled or disabled separately. For example, a custom verification module can be: openid verification, Facebook verification, liveid verification, and other verification functions, which can be enabled or disabled independently.
Features can be mutually dependent, whether they are in the same module or not.

 

Manifest -- list file

A configuration file is a text file describing a module or topic in a module or topic.
The following is an example of the configuration file:

Name: Role: enabledauthor: the orchard teamwebsite: http://orchardproject.netVersion: 0.9.0orchardversion: 0.9.0description: The comments system implemented by this module can be applied to arbitrary orchard content types, such as blogs and pages. it provides des comment validation and spam protection through the akismet service. features: orchard. comments: Name: Comments Description: standard content item comments. dependencies: settings category: Social

Ui composition -- interface Synthesis

The content managed in orchard is composed of different units. This requires a mechanism for unified content display, while also taking into account the integrity of the content. This is why many small pieces of content need to be harmoniously integrated and displayed in a unified manner during the synthesis of the Presentation Interface. The following concepts are involved in interface synthesis.
Theme-topic

When creating a website, we may need to be able to modify the visual display of each website. Orchard clearly separates content management from content display. A topic is displayed on all interfaces of the website created by orchard. It includes CSS styles, images, layout files, template files, and even customCodeFile. We can also create a topic that inherits the attributes of another topic. This will be useful if you just want to make some minor changes to the existing topic.

Layout -- Layout

A Layout file is a file that consists of the approximate organization of the page defined in the topic. The layout file defines a group of blocks and the order and location of these blocks. Content and widgets (widgets) can be inserted in the blocks ).

 

Template -- Template

Each content unit, each content field, and each widget must be displayed on the front to display the data they represent as users can read. A template is to convert data into HTML that can be displayed by the browser.Source code. You can understand a template as a common HTML with a pre-defined location. The pre-defined location is where data can be inserted.
The following is a simple example of a template:

 
<H1> @ model. Title  
 
Shape -- shape
 

 before displaying something using a template, that something gets transformed into a shape, which is a very malleable object that contains all the information required in order to display it. before getting rendered by templates, everything gets mapped into a tree of shapes that is a sort of abstract representation of the contents of the final page. the advantage of such trees of shapes is that any module can modify existing shapes or create new ones. 
 the layout, zones, widgets and content parts all get represented as shapes as part of the rendering process. 
 one cocould imagine for example a gravatar module that wocould add Avatar icon shapes to the comment shapes that were created by the comment module. in the same way, the layers from the widget module are adding widget shapes to the zone shapes of the layout shape. 
 placement 

When rendering the collections of parts and fields-or any other shapes-that compose a page or content item, orchard needs to know in what order to do so. placement.info files are XML files that describe rules that can be used to determine what shapes go into what zones and in what order. this enables not only the rendering of each shape to be customized, but also the order in which they get rendered.
Here is an example of a placement file:
 

 
<Placement> <place parts_map = "content: 10"/> <place parts_map_edit = "content: 7.5"/> </placement>
 
 
Zone secret ¶
 

 
Zones are specific parts of a layout that can be customized by inserting Widgets. In some themes, zones are collapsible, which means that they disappear if they contain no active widget.
Widget Widgets ¶
 

A widget is a small fragment of UI that can be added to some or all pages of the site. examples of widgets are tag clouds, maps, archives, a search form, or recent blog posts.
 

 
 
Layer encryption ¶
 
A layer is a group of widgets (with their specific configuration, which includes their positioning-zone name and ordering-) that is activated by a specific rule.
For example, the thehomepage layer is activated by a rule that specifically selects the home page. the default layer is always active no matter what page is displayed. the authenticated layer is only active when users have identified themselves.
When more than one layer is active on any given page, all the widgets from all those layers get displayed at the same time. orchard orders them based on their position string.
Security groups users and roles Enabled ¶
 

In orchard, users can be attributed roles, which can be seen as stereotypes of users. permissions can then be attributed to roles in order to define who can do what on the site (more on this in the next section ). any user can have one or several roles.
Site owners can create their own roles but Orchard comes with built-in roles that shoshould cover most sites 'requirements:
 


 
 
 
  
 
   
Administrator: have full control over the site's settings and contents.
 
   
Editor: does not create content but edit and publish content created by authors.
 
   
Moderator: validates user-created contents such as comments.
 
   
Author: writes and publishes his own content.
 
   
Contributor: writes content but does not necessarily have the rights to publish it.
 
   
Anonymous: an unknown user, someone who hasn't logged in.
 
   
Authenticated: any user who has logged in.
 
  
 

 
Neither anonymous nor authenticated can be assigned to a user manually. Rather, they are determined dynamically at runtime.
Privileges and permissions privileges ¶
 

 
All users don't have the same rights and privileges in orchard: the site owner can choose who can create content, who can write or validate comments, etc. rights and privileges are represented as permissions. in orchard, permissions are granted to roles but are not explicitly denied. in other words if a user belongs to any role that has a given permission, he has that permission. to revoke a permission, you need to either remove a user with the role the permission has been granted to or you need to remove that permission for the whole role.
Some permissions are "specified tively granted ". this means that they have not been explicitly granted, but that they have been implied by another permission. for example, if you grant the site owner permission, you are implicitly granting all the other permissions.
 

 

 
Permissions, as well as their default settings for the built-in roles, are defined by modules. This means that if you build your own module, you can define specific permissions to accompany it.
 
Site owner website ¶
 
The site owner, sometimes also called "Super User" is a special user that is defined at setup time and that has all the rights on the site. it can be changed from the settings admin screen if you have the permission to do so.
There is a permission called "site owners permission" that grants the same right and that is granted by default to only members of the administrator role. we advise never to grant that permission to any other role.
Development Environment ¶
 

 
In this section we will describe concepts that are only required for module developers.
ASP. net mvc labels ¶
 

 
ASP. net mvc is the Web framework that orchard is built on.
Handler ¶
 

A handler is similar to an MVC filter in that it contains code that will execute for specific events of the request life-cycle. they are typically used to set-up data repositories or to do additional operations when something gets loaded.
Driver drivers ¶
 

 
Drivers are similar to MVC controllers, But they act at the level of a content part instead of at the level of the full request. they typically prepare shapes for rendering and handle post-backs from Admin editors.
Record records ¶
 

 
A record is a class that models the database representation of a content part. They are pocos where each property must be virtual.
Model Parameters ¶
 

 
What plays the part of the model for a content part is the part class itself. Some parts also define view models, in the form of stronugly-typed classes or of more flexible dynamic shapes.
Migration quota ¶
 

A migration is a description of the operations to execute when first installing a feature or when upgrading it from a version to the next. this enables smooth upgrades of individual features without data loss. orchard except des a data migration framework.
Injection failed ¶
 

 
Inversion of control, or injection, is widely used in Orchard. when any piece of code requires a dependency, it will typically demand the injection of one or several instances of a specific interface. the framework will take care of selecting, instantiating and injecting the right implementations at runtime.