Orchard module and topic list file (manifest file)

In orchard, modules and themes are important tools for expanding and customizing orchard websites. Each document and topic contains a document (manifest.pdf, which is a document named module.txtor theme.txt and is located in the root directory of the module or topic. A configuration file stores some basic information about the description module or topic for the orchard system, such as name, version, description, author, or tag. This article is about the configuration file. If you create a custom module or topic, or you write Code To access a module or topic, you must understand the fields in the configuration file. Data in the file list is stored as key-value pairs, for example, filedname: value. The following sections describe the field meanings in the module and topic list files.

 

Module list Field  

Field name	Description
Name	Module name. It can be understood as the friendly name of the module, which can express the module functions in the most intuitive way. For example:Orchard. BlogsModule. The module name can beBlogs.Orchard. BlogsYesmoduleIDThe directory name of the module. If the module name is not provided in the configuration file, the system uses the module by default.IDAs the module name. The module name is displayed inOrchard UIAndOrchardIn the software market.
Path	route name (area part ) . orchard the default route address is: {area}/{controller}/{action} , if path value is not specified, orchard default module id as area . Example: mycompany. helloworld area is mycompany. helloworld , such URL is less readable, therefore, you can provide a path value helloworld in this way, access mycompany. helloworld simplified URL , such as: /admin/helloworld .
description	module description. This description can be used to describe the functions of a module. It is displayed in orchard UI and orchard in the software market.
Version	The version number of the module. Will be displayed inOrchard UIAndOrchardIn the software market, let users know whether new updates are released.
Orchardversion	Description of the information supported by the current ModuleOrchardFramework Version
antiforgery	Anti-Counterfeiting, indicates whether the module enables request verification. Optional values: enabled and disabled . If this setting is enabled, orchard the post does the request come from this site? This prevents cross-site submission. After this setting is enabled, form the form must be used HTML. beginformantiforgerypost () generate.
Author	Module developers can be organizations, individuals, or teams.
Website	Module developer website
tags	module label, separated by commas. Tags can be easily queried in orchard software market.
featuredescription	default Function Description of the module. If the module has only one function, you can only describe it here. If the module has multiple functions, you can describe one of the main functions here. Other functions can be described in features .
Category	Module category,OrchardIn the module list function of the Management backend, different types of modules can be listed for viewing by category.
Dependencies	Module dependency, which is separated by commas.
Features	Describes all functions of the module. If the module has only one function, useFeaturedescriptionIf the module has multiple functions, the node can be used. The specific usage is as follows:Orchard. ExperimentalModule.

 

 Module List Example

A functional module

Name: mycompany helloworld
Path: helloworld
Antiforgery: Enabled
Author: Twenty-four painters
Website: http://esshs.cnblogs.com/
Version: 1.0
Orchardversion: 1.0
Description: This is a simple module for displaying helloworld.
Featuredescription: Display helloworld text
Category: Sample

Multiple Functional Modules

Name: Experimental
Antiforgery: Enabled
Author: the orchard team
Web: http://orchardproject.net
Version: 1.1.30
Orchardversion: 1.1.30
Description: an assortment of debugging tools.
Category: developer
Features:
Profiling:
Name: Profiling
Description: tools to help profile orchard.
Category: developer
Dependencies: orchard. Experimental
Orchard. Experimental. webcommandline:
Name: Web command line
Description: enables site administrators to execute orchard.exe commands via Web Interface
Category: developer
Orchard. Experimental. testinglists:
Name: Testing lists
Description: adds some content definitions to help test lists
Dependencies: orchard. Lists
Category: developer
Orchard. Experimental. locklogging:
Name: Lock Logging
Description: logs extra diagnostic information for SQL ce if a deadlock timeout occurs
Category: developer

When defining multiple functional modules, each function is listed in features with a tab indent. Use feature ID + ":" to indicate a function. Under each function, two tabs can be used to indent the name, description, dependency, and category of the function.

 

Topic list Field  

Field name	Description
Name	Topic name
description	topic description. It can be used to describe the style layout of a topic. This description is displayed in orchard UI and orchard in the software market.
Version	The version number of the topic. Will be displayed inOrchard UIAndOrchardIn the software market, let users know whether new updates are released.
Author	A topic developer can be an organization, individual, or team.
Website	Theme developer website
Tags	Topic tags, separated by commas. Labels can be easily stored inOrchardSearch in the software market.
zones	specifies the region of the topic. Use commas to separate the regions of a topic. orchard added in the background widgets display the region of the topic based on this setting.
Basetheme	TheID. This is an optional field. It is usually used when you want to copy an existing topic and make some modifications.

 

Topic List Example

 

Topic list file

Name: Test Topic
Description: This is a test topic.
Version: 1.0
Author: Twenty-four painters
Website: http://esshs.cnblogs.com/
Tags: Test, concise
Zones: Header, content, footer

 

 

Note: Field names are case sensitive. If the spelling is incorrect, the orchard system does not recognize it. In addition, if the configuration file contains Chinese characters, it must be saved in UTF-8 encoding format. Reference http://www.orchardproject.net/docs/manifest-files.ashx