Home

Read the Docs Template Documentation

Contents

1. Troubleshooting lf clicking on the link above does not work try the following Select and copy the entire link Open a browser window and paste the link in the address bar Click Go or on your keyboard press Enter or Return Your access key for uploading packages i5 Emo t tee If you continue to have access problems or want to report other issues please Contact Us This will return you to the web site where you can now sign in Thanks for joining As a member of Orchard Gallery you are now able to contribute modules and themes to the gallery 3 3 Using the Orchard Gallery 171 Read the Docs Template Documentation Release 1 9 2 Submitting a Package to the Gallery A package is just a zipped up file in nupkg format containing your module or theme and it is easy to create a package using the orchard command line utility For instructions on how to create a package refer to these topics Packaging and sharing a module Packaging and sharing a theme Once you have packaged your module or theme visit the Contribute page on the gallery site and click the Add a New Module or Theme link ORCHARD HOME KJIM LIS OH E e Orchard gallery Home Modules Themes Contribute A Sign Iri Contribute to Orchard Gallery Add Mew Module or Theme Upload and publish your package for other Orchard users to download and enjoy You can upload 5 Get Started miultiple revisions of the same
2. rerurn 2 Add a handler The plumbing for connecting the module code to the database is almost complete The last thing to do is to register a StorageFilter for the ContentPartRecord The StorageFilter class takes care of persisting the data from repository object to the database In this case it s the FeaturedProductPartRecord class that needs registering You do this registration inside the Handler class although that s not it s only use You can think of the handler like a filter in ASP NET MVC It s a piece of code that is meant to run when specific events happen in the application but that are not specific to a given content type For example you could build an analytics module that listens to the Loaded event in order to log usage statistics If you re curious you can see what event handlers you can override in your own handlers by examining the source code for ContentHandlerBase and reading the understanding content handlers guide The handler you need in this module is not going to be very complex but it will implement some plumbing that is necessary to set up the persistence of the part 1 Inthe Solution Explorer rightclick on the Orchard LearnOrchard FeaturedProduct project and choose Add New Folder and create a new folder called Handlers 2 Now right click on the Handlers folder and choose Add Class 3 Inthe Add New Item dialog enter FeaturedProductHanadler in to the Name field and press Add
3. I default positioning gt Match ContentType Blog gt Match DisplayType Summary gt Place Parts_Blogs_Blog_Description Content before Parts Blogs Blog BlogPostCount Meta 3 Match Match lt Placement gt Markup The markup in each file is constrained by the view engine that you choose The default in Orchard is Razor cshtml files for which a quick guide can be found in Template File Syntax Guide Within a template the Model object represents the current shape being rendered That means that if you are working with the message shape which has a Message property you can display that by writing Model Message from within the template markup 46 0 2 Chapter3 Documentation Read the Docs Template Documentation Release 1 9 2 An important addition that Orchard provides is the Display method which renders a shape For example if you look at the ayout cshtml file you can see how the zones are rendered using calls such as Display Model Content Finally you can also see in various templates calls such as Html RegisterScript mystyle css or aHtml RegisterScript myscript js These registration calls are necessary because the collections of scripts and stylesheets are a shared resource The same link or script element should not be rendered twice even if multiple modules or multiple instances of the same widget require the same file Themes with Code Most themes will consist on
4. j The Retrieve and Store methods come when you inherit from ContentPart T Under the hood your data is stored in two places There is the underlying database and something called the infoset Understanding data storage in Orchard Orchard provides an incredibly modular architecture The way it achieves this 1s that it breaks everything up into their own little components called content parts We are busy building one of these content parts right now Orchard composes these together at run time to form content types such as the widget we are working on In order to store all of these little pieces of data in the database they are split up into many tables There can be a lot of SOL JOIN s involved with pulling a content item out of the database This means things aren t always as fast as they could be To minimize these effects a secondary data cache is kept AII of the different content parts are encoded into XML and stored in a single column inside a database table For example our widget looks something like this lt Data gt lt IdentityPart Identifier 0e8f0d480f0d4d4bb72ad3d0c756a0d4 CommonPart CreatedUrc Z015 09 24T19 357 19 5519580464 ModztiedULG 7015 09 24T7T194 57 19 5072049984 PublishedUtc 2015 09 24T19 37 19 6810555Z WidgetPart RenderTitle true Title Featured Product Positions tI Zone AsideFirst Name CssClasses lt Data gt 3 9 Extending Orchard 305
5. l Right click on the Models folder 2 Choose Add 3 Choose Class 4 Inthe Name field type FeaturedProductPart 5 Click Add Your new class will be created and opened up in the Visual Studio editor Important note In order for Orchard to recognize Content Part classes they must be in a namespace ending Models Because you already added this class within the Models folder the namespace is automatically wrapped around your class In the future when you re making your own classes don t forget to ensure that you follow this namespace structure Your content part class will need to derive from the Cont entPart class Normally we would add public properties to store all the related data but as we are keeping it simple this first example won t have any 3 b namespace Orchard Learn rchard FeaturedProducts Models a public class FeaturedProductPart ContentPart o 16 using Orchard ContentManagement n i 1 Change ContentPart to ContentManagement ContentPart i Add the ContentPart inheritance by following these steps 3 9 Extending Orchard 291 Read the Docs Template Documentation Release 1 9 2 1 Type ContentPart after your FeaturedProductPart class definition to inherit from the ContentPart class 2 Wait a second and the red squiggles will appear underneath the class Add the namespace by pressing Ct r1 on your keyboard to bring up the Quick Actions menu 3 Select the using Orchard ContentManagemen
6. 3 21 11 Updated screen shots and text for installing themes 3 2 3 Customizing Themes The default Orchard theme is called The Theme Machine It is designed as a versatile starting point for customizing and developing themes This article introduces The Theme Machine and demonstrates how to create your own theme by customizing The Theme Machine style sheet Site css Introducing the Theme Machine The Theme Machine provides a flexible and powerful foundation for themes The following image shows the file structure 4 TheThemeMachine 4 oF Styles A3 Site css 4 o gt Views dd BadgeOfHonor cshtml Branding cshtml Layout cshtml Theme png l heme txt iy Web config The files at the heart of the Theme Machine are the layout page Layout cshtml and style sheet Site css Overview of the Layout Page The layout page defines multiple zones Each zone has a conditional statements so that it renders if and only if it has content If you don t provide the content the rendered page will not contain the zone The following images show the zones 3 2 Customizing Websites 153 Read the Docs Template Documentation Release 1 9 2 Zone Demo Tags demo zones widgets This is the content for the Zone Demo page Foo terQuadFirst 2 Foo terQuadSecond Foo terQuadThird Foo terQuadFourth Footer This is the Footer zone This live demo site shows the anatomy of a theme Zones and their children have an aqua
7. Ajouter ou enlever des cultures de celles support es par le site S parateur de titre de page Super utilisateur admin Saisissez le nom d un compte existant ou rien si vous me voulez pas de compte super utilisateur Mode d boguage de ressource Use web config setting D termuime si lec conpts et Feuilles de Sie sant Foumies dans leur version de gekiga jg cui Pini Nombre de contenus par page par d faut 10 quo M a eee Base xm ee pel Ae En ri determine le nome de contenus guiserant aitiches pa pac par ACIU hace url Setting the default site culture to a specific culture won t have any effect unless you have a corresponding translation file installed Orchard searches the following paths to find translation files from most to least specific Core localization file path Core App_Data Localization amp lt culture code amp gt orchard core po Modules localization file path Modules amp lt module name amp gt App Data Localization amp lt culture code amp gt orchard module po Theme localization file path Themes amp lt theme name amp gt App Data Localization amp lt culture code amp gt orchard theme po Root localization file path App_Data Localization amp lt culture code amp gt orchard root po Tenant localization file path App_Datd Sites amp lt tenant name amp gt Localization amp lt culture code amp gt orchard po Translation availability You ca
8. Depends on jQuery Tokens Provides an anti spam filter based on To implement spam protection Orchard uses Akismet spam protection which reviews comments as they are posted When Akismet detects a comment that fits the criteria for spam it automatically assigns it to the Mark as spam category To enable the Akismet spam protection feature on a site do the following Obtain an Akismet key from Akismet com Enter your Akismet key in the field e Save the updated setting 3 4 Managing Websites 201 Read the Docs Template Documentation Release 1 9 2 ReCaptcha Your public key Your private key Get custom keys http www google com recaptcha Hide for authenticated users Enable to hide reCaptcha when the user is authenticated Trust content submitted by authenticated users Check if authenticated users should have their content automatically approved Api key API key for Akismet service After you enable spam protection in your site you can use the Comments screen described earlier to select the comments that are marked as spam review them and delete the comments that really are spam Change History Updates for Orchard 1 8 3 28 11 Updated existing screens for site level comment and anti spam settings Updates for Orchard 1 1 202 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 3 28 11 Updated existing screens added new step showing how to require
9. Draftable Determines if this content type supports draft versions stereotype Widget Optional The stereotype of the content type e q Widget Menultern Fields v My Media Library Picker Field Media Library Picker Field L A content item is required Check to ensure the user is providing at least one media item Allow multiple cantent items Check to allow the user to select multiple media items Help text The help text is written under the field when authors are selecting media items Content Types and Parts 220 i Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Add the Widget a Zone From the admin dashboard click on Widgets Click Add beside any zone e g BeforeContent The Choose a Widget page will open Choose the Widget that you just created 1 e My Image Gallery The Add Widget page will open Give the Widget a Title e g My Gallery Widget Click the Add button below the My Media Library Picker Field label The Media Library Picker modal will show In this screen shot we have already imported some images and created some folders You can create folders using the Create Folder button You can import images by opening a folder and clicking the Import button This tutorial assumes you know how to do that Create Folder Recent 3 ImageGalleries 3 Modules Cancel 3 Otherlmages e Select the images that yo
10. EN Add a new layer All Layers Default Header Add empty Mavigation Add Authenticated em pty Featured Add eru empty BeforeMain Add l Disabled zr empty AsideFirst Ada TheHomepage Messages Add BeforeContent Add Content Add SMe hits Afero nient Add AsideSecond Add AfterMain Add TnpelFirst Add First Leader Aside Move to currant layer Tripelsecand Add Second Leader Aside Move to current layer 1 9 2 Available Widgets Whenever a widget becomes available usually by enabling another feature in the Features tab on the Modules screen of the dashboard Orchard adds it to the list of available widgets that can be added to zones in the current theme To see the list of widgets available in a zone in the Widgets screen click the Add button on one of the listed zones For example in the Widgets screen click Add for the Header zone A screen is displayed that allows you to choose one of the available widgets 1 9 Managing Widgets 91 Read the Docs Template Documentation Release 1 9 2 Choose A Widget User admin Logout Blog Archives Container Widget Html Widget Recent Blog Posts The following table describes the widgets that are available by default in Orchard Widget Description AA _ Blog Archives Dis plays a list of archived entries for the specified blog Container Widget Displays a contained content item such as a list Html Widget
11. Fam Fam Fam Silk Icons The Orchard user interface uses Silk Icons which is an icon set containing over 700 16 by 16 pixel icons in PNG format Fluent NHibernate Orchard uses Fluent NHibernate which lets you write object relational mappings in strongly typed C code 494 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 FluentPath This library is a fluent wrapper around System IO that we use in some tests Html Agility Pack Flexible HTML parsing and querying Html5shim Provides Html 5 helpers jQuery amp jQueryUI jQuery ui timepickr jQuery utils jQuery ScrollTo We use jQuery to progressively improve the user experience in Orchard Log4Net Log4Net is a tool used in Orchard to help write log statements to a variety of output targets Lucene Net Full text search and indexation engine Microsoft SQL Server Compact 4 0 SQL Server SQL Server Express Orchard uses SQL Compact by default for database access but can also use SQL Server and SQL Server Express Moq The moq library is used when object moqs are needed for writing unit tests NHibernate amp dependencies FluentNHibernate NHLambdaExtensions LinqNHibernate Orchard uses NHibernate Fluent NHibernate and Linq To NHibernate for data access NuGet NuGet is used as the package manager modules and themes come in the form of NuGet packages NUnit NUnit is used for writing unit tests 3 12 Developer Tool
12. Graphical elements should use the png format Use alpha transparency via the 24 bit png format Use sprites where possible to improve load time and to reduce the number of requests made to the server For more information about sprites see CSS Sprites Image Slicing s Kiss of Death Accessibility Your HTML and CSS templates should pass the accessibility tests provided by Wave the web accessibility evaluation tool Your templates should satisfy the requirements of WCAG 2 0 level AA Markup Validation We recommend that you always strive for standards compliance Ensure that your templates pass validation by using the W3C Markup Validation Service 474 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 CSS Organization To allow users to easily find and read styles for modification we recommend that you standardize on a structure and coding format The organizational structure that is introduced in this section is used by the Orchard team To help you abide by the CSS standards keep the following guidelines in mind Do not use workarounds like conditional i f statements in stylesheets CSS markup should be valid CSS 2 1 or higher You can also use optional progressively enhanced CSS 3 markup CSS Format Rules The following list contains guidelines for formatting CSS markup Use four spaces instead of tabs for indentation This is the default setting in Visual Studio Use a hyphen be
13. Nov 12 2012 4 35 PM You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head over to manage themes to change or install new themes and really make it your own Once you re happy with a look and feel it s time for some content You can start creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re looking to add additional functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Second Leader Aside Third Leader Aside Lorem ipsum dolor sit amet consectetur Lorem ipsum dolor sit amet consectetur Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor adipiscing elit Curabitur a nibh ut tortor adipiscing elit Curabitur a nibh ut tortor dapibus ves
14. aHtml ValidationMessageFor model gt model StateCode lt div gt lt div eclasse editor label s Html LabelFor model gt model Zip T Zip lt div gt lt div class editor field gt Html TextBoxFor model gt model Zip Html ValidationMessageFor model gt model Zip lt div gt lt fieldset gt The DropDownListFor method takes an expression for the property to represent and a list of SelectListItems that we build on the fly from the complete list of states and what we know of the current state for that address notice the expression for Selected The Placement File Finally we need a placement file to determine the default position of our part within a larger content type lt Placement gt Place Parts Address Edit Content 10 gt lt Place Parts Addressse Content l10 75 lt Placement gt Using the Address Part We can now go into the Features admin page and enable the RelationSample feature under the Sample category Once this is done we can go to Content Types and create a new Customer content type Add the Common and Address parts as well as a text field named Name 394 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Edit Content Type Content Types gt Edit Content Type Display Name Customer Content Type Id Customer Fields Name TextField Parts Address Common We now have a new Customer menu entry u
15. gt shapeHelper Parts_Address ContentPart part Address part Address 390 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Osce Part rb Zips Pati Ap StateCode part State Code StateName part State Name protected override DriverResult Editor AddressPart part dynamic shapeHelper return ContentShape Parts_Address_Edit gt shapeHelper EditorTemplate TemplateName TemplateName Model BuildEditorViewModel part Prefix Prefix protected override DriverResult Editor AddressPart part IUpdateModel updater dynamic shapeHelper var model new EditAddressViewModel if updater TryUpdateModel model Prefix null null if part ContentItem Id 0 addressService UpdateAddressForContentItem part ContentItem model return Editor part shapeHelper private EditAddressViewModel BuildEditorViewModel AddressPart part var avm new EditAddressViewModel Address part Address City parks City Zip part Zip States addressService GetStates ur if part State null avm StateCode part State Code avm StateName part State Name return avm When displaying on the front end we prepare a Parts_Address shape that has a reference to the original part although that is not necessary all the part properties flattened out and the state is available as both a code and a name 3 9 Extending Orchard 391 Read the Docs
16. set Store r gt r City value public StateRecord State get 4 var rawStateRecord Retrievecstring StateRecord return StateRecord DeserializeStateRecord rawStateRecord set var serializedStateRecord StateRecord SerializeStateRecord value 386 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 otore StateRecord serialrizedStateRecord publico Stfrsg Zap get return Retrieve r gt r Zip set Store r gt r Zip value This uses stores the data in the infoset and in a database record However you can only store simple datatypes in the infoset so you can see that St ate field runs some extra code to encode the class into a string All properties in the AddressPart are proxies to the record properties using Orchard ContentManagement Records namespace RelationSample Models public class AddressPartRecord ContentPartRecord public virtual string Address get set public virtual suring City get sac J public virtual StateRecord StateRecord get set public virtual string Zip get set The state record class itself has a two letter code and a name It also has methods to serialize and deserialize its data into a string so that the AddressPart above can store its data in the infoset namespace RelationSample Models public class StateRecord public virtual int Id get set public virtual string Code get set public virtua
17. 3 Start Page Filter be BLEROY REDMOND ble 2 Application Pools Name I 1 eT a Meb 1 Add Web Site Refresh Add Web Site From Gallery Switch to Content View In the Add Web Site dialog box fill in the fields to point the new website to a folder such as inet pubNwwwrootNOrchard Name the new site Orchard and give it an unused port such as 90 Use the default application pool NET 4 0 integrated pipeline Click OK Add Web Site Y 2 Site name ipplicati Orchard Orchard Content Directory Physical path CAinetpubWwwwrootyOrchard Pass through authentication Connect as Test Settings Binding IP address All Unassigned Host name Example www contoso com or marketing contoso com W Start Web site immediately oma From the Windows Start menu launch Web Platform Installer select Orchard CMS click Add and then click 350 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Install Web Platform Installer 3 0 Spotlight Products Applications Name Released Install Umbraco CMS 3 15 2011 Add Applications Products aia ath Visual Studio 2010 SP1 3 10 2011 Te Visual Web Developer Express 2010 SP1 3 10 2011 Installed Orchard CMS zara Add DotNetNuke Community Edition 1 19 2011 Add Drupal 7 Developer release 1 18 2011 Add Joomla 1 6 1 12 2011 Add IS 7 Recommended Configu
18. Depends an Common jQuery LUE Disable Disable Scheduling Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 amp snaglt 8 w Remote Desktop Connection oe Microsoft Visual Studio 2010 Visual Studio Command Promp 2010 Ec Microsoft Office PowerPoint 2007 EE Microsoft Office Word 2007 Choose Add blog account from the Blogs menu 3 1 Authoring Websites 107 Read the Docs Template Documentation Release 1 9 2 View blog Manage blog el Edit blog settings v Azure Blog Add blog account Choose Other blog service from the available options and click Next ive Wri ex J windowstveweter OO What blog service do you use Windows Live Writer works with most popular blog services Tell us which one you use I don t have a blog create one on Windows Live for me Windows Live Spaces SharePoint blog Q Other blog service Blogger WordPress TypePad all others Type the URL to your Orchard blog along with the admin user name and password that you defined when you set up Orchard for the first time 108 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Note it is possible to publish using other XML RPC aware client applications but you might have to provide the URL of the xmlrpc endpoint rather than the blog URL For example http myimaginaryorchardsite com xmlrpc L Windows Liv
19. If you load the Orchard site up in the web browser then the data migration will automatically run You can see the updated description in the Content Definitions page 1 Within Visual Studio press Ct r1 F5 to load up the dev server 2 Navigate to the admin dashboard and click the Content Definition menu option 3 Click the Content Parts tab along the top of the page 4 Scroll down to the Featured Product entry It will now have a description Element Wrapper Edit Turns elements into content items Featured Product Edit Renders information about the current featured product Identity Automatically generates a unique identity for the content item which is required in import export scenarios where one content item references another Edit Roll your data migrations up into Create Now our Migrations class contains a Create and two UpdateFromN methods As time goes on it will get more added We may have some updates which revert earlier mistakes or remove features that aren t needed There is no point in making a new user that s installing the module for the first time to go through all of these steps if they are no longer needed for the final product Instead we should keep the Create asa pristine record of the way we want our data to be configured for the current codebase At the end of the Create we can then return a higher number which will leapfrog the Create method over all the unnecessary UpdateFromN
20. In this section we ll take the example of a request for a specific blog post When a request comes in for a specific blog post the application first looks at the available routes that have been contributed by the various modules and finds the blog module s matching route The route can then resolve the request to the blog post controller s item action which will look up the post from the content manager The action then gets a Page Object Model POM from the content manager by calling BuildDisplay based on the main object for that request the post that was retrieved from the content manager A blog post has its own controller but that is not the case for all content types For example dynamic content types will be served by the more generic ItemController from the Core Routable part The Display action of the ItemController does almost the same thing that the blog post controller was doing it gets the content item from the content manager by slug and then builds the POM from the results The layout view engine will then resolve the right view depending on the current theme and using the model s type together with Orchard conventions on view naming Within the view more dynamic shape creation can happen such as zone definitions The actual rendering is done by the theme engine that is going to find the right template or shape method to render each of the shapes it encounters in the POM in order of appearance and recursively
21. Maps OnMainMenu true Command Orchard 3 4 Managing Websites 213 Read the Docs Template Documentation Release 1 9 2 Note the following about the changes made to the default recipe Module element This element identifies a module that will be downloaded from the Orchard Gallery on the website This does not enable the features in the module it only downloads it To enable a module feature add it to the Feature element as shown in the example Theme element This element identifies a theme that will be downloaded from the Orchard Gallery If the current attribute is set to true the theme becomes the current theme and is applied to the website Otherwise it will just be downloaded It is also possible to enable a theme by using the enable true attribute Otherwise the theme is initially disabled If you use current true the theme is automatically enabled Important The Module and Theme elements must appear in the recipe immediately after the Recipe element layer create command This was added in order to create the Blog and Maps layer blog create command This was added in order to create the blog page create command This was added in order to create the Maps page menuitem create command This was added in order to create the Blog and Maps menu tabs In addition to the attributes shown here for the Module and Theme elements both elements support a version attribute If the version is specified that version
22. RewardsPart part dynamic shapeHelper return ContentShape Parts Rewards Edit gt shapeHelper EditorTemplate TemplateName TemplateName Model BuildEditorViewModel part Prefix Prefix protected override DriverResult Editor RewardsPart part IUpdateModel updater dynamic shapeHelper var model new EditRewardsViewModel updater TryUpdateModel model Prefix null null if part ContentItem Id 0 rewardService UpdateRewardsForContentItem part ContentItem model Rewards return Editor part shapeHelper private EditRewardsViewModel BuildEditorViewModel RewardsPart part var itemRewards part Rewards ToLookup r gt r Id return new EditRewardsViewModel Rewards _rewardService GetRewards Select r gt new RewardProgramEntry RewardProgram r IsChecked itemRewards Contains r Id Le TOLLISE io Like with the address part we are fetching all the reward programs and putting them on the editor view model for the template to display as checkboxes In BuildEditorViewModel you can see that we build the current rewards as a lookup and then use that to determine the checked state of each reward program Here is the editor view model using System Collections Generic using RelationSample Models namespace RelationSample ViewModels public class EditRewardsViewModel public IList lt RewardProgramEntry gt Rewards get set public class RewardProgramEntry
23. This Orchard applicatiq and layout The content inclu main menu and a foot menu content types and widgets and typography tests use it to test your theme stibulum Ali ves bulum Aliquam ve items of the most used sem nibh Suspendisse vel condimentum tellus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus The content of this Orchard site is distributed as an export file as part of the Orchard Dojo Library L i dolor sit Recent Blogposts O and is open source If you have found any errors or would like to add something to it you re more Projection PUR than welcome to fork the library and edit the export xml adipiscing elit Curabitur a e Test Blogpost nibh ut tortor dapibus You can log in with the credentials admin password and play with the content yourself vestibulum Aliquam vel Tags test sem nibh Suspendisse vel Created by Lombiq for the fellow Orchard enthusiasts blogpost condimentum tellus Content content posti Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus Saturday Apri 27 vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus 2013 10 37 07 AM NO 1 5 3 DotNest Orchard SaaS provider DotNest 1s the Orchard SaaS provider this means that you can simply register and create Orchard websites that run in the cloud without any hassle Your website will just work you don t have to deploy and later upgrade it you can just use
24. e Shape Information about the shape and the template to render the shape Includes the option of creating alternates as described later in this article Model Information about the model for this shape Placement The p acement info file Template The code in the template file HTML The HTML for rendering this shape Creating Alternate Templates The Shape Tracing interface displays links that let you automatically create alternate templates for a shape The interface displays the available alternate templates and includes a link titled Create to generate that template 4 Alternate 3 Create Themes TheThemeMlachine Views Parts Common Body cshtml Create Themes TheThemeMachine Views Parts Common Body 9 cshtm Create Themes TheThemeMachine Views Parts Common Body HtmlWidget cshtml The Create option only creates the template in the specified directory You must customize the template to render the shape as needed If you are using Visual Studio you must include the template in your project by selecting Add amp gt Existing Item in Solution Explorer For more information about how to create alternates see Alternates 3 12 Developer Tools and Guidelines 3 12 1 Developer FAQ What are the dependencies Orchard uses a number of external libraries They can all be found under lib directory in your enlistment They are also enumerated in Orchard dependencies and libraries What framework versions does Orchard suppo
25. gt shapeHelper Parts_Map Longitude part Longitude Latitude part Latitude The expression uses a dynamic object shapeHelper to define a Parts Map shape and its attributes The expres sion adds a Longitude property to the shape and sets it equal to the part s Longitude property The expression also adds a Latitude property to the shape and sets it equal to the part s Lat it ude property The ContentShape method creates the results object that is returned by the Display method The following example shows the entire driver class that sends a shape result to a template either to be displayed or edited in a Map part The Display method is used to display the map The Editor method marked GET is used to display the shape result in editing view for user input The Editor method marked POST is used to redisplay the editor view using the values provided by the user These methods use different overloads of the Editor method using Maps Models using Orchard ContentManagement using Orchard ContentManagement Drivers namespace Maps Drivers public class MapPartDriver ContentPartDriver lt MapPart gt protected override DriverResult Display MapPart part string displayType dynamic shapeHelper return ContentShape Parts Map gt shapeHelper Parts_Map Longitude part Longitude Latitude part Latitude GET protected override DriverResult Editor MapPart part dynamic shapeHelper return Con
26. namespace SimpleCommerce DataMigrations public class Migrations DataMigrationImpl 3 9 Extending Orchard 353 Read the Docs Template Documentation Release 1 9 2 public int Create Creating table ProductPartRecord SchemaBuilder CreateTable ProductPartRecord table gt table ContentPartRecord DColumni Skut DDIyOS oOLrr1tg Column Price DbType Single return 1 The method name Create is the convention for the initial data migration It calls the SchemaBuilder CreateTable method that creates a ProductPartRecord table that has Sku and Price columns in addition to the columns from the basic ContentPartRecord table Notice that the method returns 1 which is the version number for the migration Add another migration step to this in order to illustrate how you can later alter the existing schema and type metadata as the module evolves In this case you will take this opportunity to add a feature that will enable the part to be attached to any content type Add the following method to the data migration class public int UpdateFroml 4 ContentDefinitionManager AlterPartDefinition ProductPart builder gt builder Attachable recurn i This new migration is named UpdateFroml which is the convention for upgrading from version 1 Your next migration should be called UpdateFrom2 and return 3 and so on Make sure the following line is present in the csproj file It should already ha
27. span class region gt Model StateCode lt span gt span class postal code gt Model Zip lt span gt lt p gt We are using the vcard microformat in this template so the address can get picked up by consumers that understand this format The Editor View The editor view is also relatively straightforward with just the editor for the state being of a little more interest model RelationSample ViewModels EditAddressViewModel lt fieldset gt lt legend gt Address lt legend gt lt div class edaitor label Html LabelFor model gt model Address T Street Address lt div gt lt div class editor field gt Html TextAreaFor model gt model Address Html ValidationMessageFor model gt model Address lt div gt lt diy classe editor label Html LabelFor model gt model City T City lt div gt lt div class editor field Html TextBoxFor model gt model City 3 9 Extending Orchard 393 Read the Docs Template Documentation Release 1 9 2 Html ValidationMessageFor model gt model City lt div gt lt div class editor label gt Html LabelFor model gt model StateCode T State lt div gt lt div oclass editor tield Html DropDownListFor model gt model StateCode Model States Select s gt new SelectListItem Selected s Code Model StateCode Text s Code 1T s Name Value s Code Choose a state
28. table table Columneint Idt column gt column PrimarykKey ldentity i Column string Code column gt column WithLength 2 Column lt string gt Name J3 388 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 ContentDefinitionManager AlterPartDefinition AddressPart builder gt builder Attachable return 1 This migration creates an AddressPartRecord table that is a content part record this gets us the default fields that a content part needs It adds columns for address city and zip that are going to be auto mapped to our record s properties The interesting column here is StateRecord_Id As you can see its type is the same as the type of the Id column of the StateRecord class because the system will be able to recognize this as a foreign key and to map that integer value to a StateRecord property by just following the relation It is important here that the name of the column that will represent the relation is the name of the column on the 1 end of the relation followed by an underscore and the name of the column of the n end of the relation There is nothing remarkable on the StateRecord table it s just mapping Id to be the primary key and constraining the Code column to be 2 characters long The last statement before the return in the migration is declaring the AddressPart and making it attachable That will enable us to attach it
29. 402 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 public RewardProgramRecord RewardProgram get set public bool IsChecked get set Note we are making the assumption here that there are only a few reward programs If you are modeling a relationship with a large number of records on both sides of the relationship the basic principles and models exposed here still stand but you ll have to adapt and optimize the code In particular using checkboxes to select the associated records is the best UI solution for small numbers of records but it won t scale well to more than a few dozens of records Instead you d probably need to use a search UI of sorts and an Add Remove pattern The Rewards Service The rewards service is responsible for driving the relatively complex task of updating the database for the new values for the relation using System Collections Generic using System Ling using Orchard using Orchard ContentManagement using Orchard Daca using RelationSample Models using RelationSample ViewModels namespace RelationSample Services public interface IRewardService IDependency void UpdateRewardsForContentItem Contentltem item TEnumerable lt RewardProgramEntry gt rewards IEnumerable RewardProgramRecord GetRewards public class RewardService IRewardService private readonly IRepository lt RewardProgramRecord gt _rewardProgramRepository private readonly IRep
30. DateTimeFieldDisplays DateOnly ShowTime settings Display DateTimeFieldDisplays DateAndTime settings Display DateTimeFieldDisplays TimeOnly be protected override DriverResult Editor ContentPart part Fields DateTimeField field dynamic shapeHelper var settings field PartFieldDefinition Settings GetModel DateTimeFieldSettings var value field DateTime if value HasValue value value Value ToLocalTime var viewModel new DateTimeFieldViewModel Name field Name Date value HasValue value Value ToLocalTime ToShortDateString Tr Time value HasValue value Value ToLocalTime ToShortTimeString tT ShowDate settings Display DateTimeFieldDisplays DateAndTime settings Display DateTimeFieldDisplays DateOnly ShowTime settings Display DateTimeFieldDisplays DateAndTime settings Display DateTimeFieldDisplays TimeOnly er return ContentSnape Frelds Custom DateTime Edit T gt shapeHelper EditorTemplate TemplateName TemplateName Model viewModel Prefix GetPrefix field part protected override DriverResult Editor ContentPart part Fields DateTimeField field IUpdateModel updater dynamic shapeHelper var viewModel new DateTimeFieldViewModel if updater TryUpdateModel viewModel 374 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 GetPrefix field part null null DateTime value v
31. Dependencies Orchard Tokens Orchard Forms Feeds Title In this particular demo we ll create an External Post functionality using Query Projection Page and Projection Widget Creating External Post Content Type Learn how to Create Custom Content Types External Post Content Type Upload Projections CreateContentType png 2 Adding 3 Fields Title Author Url and 1 Part BodyPart Upload Proje ctions addingfieldsnparts png 3 Click on Edit Placement to place fields and parts accordingly Upload Projections editingplacement png 4 Creating External Post Upload Proje ctions creatingexternalpost png Upload Projections externalpostcreated png Creating a Query 1 Creating a Query ExternalPostQuery 226 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Upload Proje ctions addingquery png Upload Proje ctions querycreated png Editing a Query Filter Sort Layouts Upload Proje ctions editingquery png 2 Click Add a new Filter Upload Projections addfilter png Select External Post as the Content Type Upload Projections externalpostfilter png 3 Click Add a new Sort Criteria and Select Publication Date Upload Projections sortpublicoation phg 4 Click Add a new Layout and Select Html List 3 4 Managing Websites 227 Read the Docs Template Documentation Release 1 9 2 Upload Proje ctions selectlayout png 5 Save the Layout with Display Type as De
32. Once you have the product id in a string it s just a case of comparing it against the known value and setting isOnFeaturedProductPage true if it s a match 1 Open up the FeaturedProductDriver cs file located in the Drivers folder 2 Locate the Display method and replace it with the following protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts FeaturedProduct gt bool isOnFeaturedProductPage false var item TypeName CurrentContent ContentItem TypeDefinition Name if itemTypeName Equals Product StringComparison InvariantCulturelgnoreCase new code var dynamicContentltem dy namic CurrentContent ContentItem var itemProductiId dynamicContentItem Product ProductId Value if itemProductId Equals SPROCKET9000 StringComparison InvariantCulture isOnFeaturedProduct Page true end of new code return shapeHelper Parts FeaturedProduct IsOnFeaturedProductPage isOnFeaturedProductPage That s all the code that s needed to detect the page content type and check the product id field You might have noticed that this time around we just used St ringComparison InvariantCulture This is because we have already enforced uppercase so we can be sure that the case doesn t conflict with the test value Now that we have completed the code to identify the current page and passed that through to the shape it will be
33. OrchardDoc This is a shortcut that GitHub have implemented to help you quickly create a pull request from your most recent push If this isn t the branch you want to create the pull request you want by following these steps 1 Visit your fork of OrchardDocs in your GitHub account don t forget it can be found at https github com YourUserName OrchardDoc 2 Click Pull Requests from down the right hand side of the site EE Wiki 3 14 Getting Involved 511 Read the Docs Template Documentation Release 1 9 2 3 Click the New pull request button in the top right New pull request 4 You will be taken to the Comparing changes screen In the main box it will probably say there isn t anything to compare Comparing changes Choose two branches to see what s changed or to start a new pull request If you need to you can also compare across forks base fork OrchardCMS OrchardDoc v base master v head fork rtpHarry OrchardDoc compare master v There isn t anything to compare OrchardCMS master is up to date with all commits from rtpHarry master Try switching the base for your comparison The base fork is the place you are sending the changes to the official Orchard repository The head fork is your fork with the new files 5 Nextto the head fork select the drop down box that starts with the label compare 7 compare master 6 Select the branch you want to merge 512 Chapter 3 Docu
34. Publish Later Disable Razor Templates Enable Draft creation and scheduled publishing Extends Templates with Razor templates Depends on Common Scheduling Depends on Templates Templates Enable Tokens Disable Provides a Template type that represents a shape template stored as a content ite Provides a system for performing string replacements with common site values Depends on Contents Tokens Each feature has an Enable or Disable link depending on its current state as well as an optional list of dependencies that must also be enabled for a specific feature The documentation throughout this site describes the variety of features in Orchard and how you can use them to customize your site s user interface and behavior Change History Updates for Orchard 1 8 9 04 14 Added new sections for how to get started with Orchard and how to get up and running with Or chard Try Orchard DotNest Azure Websites Updated screen shots for themes PJS Bootstrap Theme modules and control wrappers 4 22 14 Media selection is different now updated that part Adding a widget layer is not suggested anymore when adding a new page updated that part Link to registering additional gallery feeds was not working Updated several screenshots Added capitalization to section headers Updates for Orchard 1 6 11 25 12 Added section describing how to change the layout for a page by enabling disabling zones Removed section on Creatin
35. Read the Docs Template Documentation Release 1 9 2 C inetpub werwroot Orchard WBA Pass through authentication Its B F Ca 8 Sit a Add Website Bindi p The binding 80 ts assigned to another site If you assign the same Typ binding to this site you will only be able to start one of the sites Are httr you sure that you want to add this duplicate binding Hos Exat Your website is running now Click browse to navigate to it a Internet Information Services IIS Manager Oo o 7 o File View Help gt W8A Sites Orchard gt Connections dsl Actions rcnar ome Fi B Explore n E d i i f ri i jezi a E 2 tiatopessbor Filter Po el m Edit Permissions Leh Application Pools ba eee Edit Site ala Sites ASP NET C A EE Ap um Bindings E pa Basic Settings NET NET NET Error View Applications Authorizat Compilation Pages View Virtual Directories e 5 Manage Website NET NET Profile NET Roles Restart Globalization b Start i B Stop IF B amp l Advanced Settings fa v Configure c l Limits 1 Features View G Content View I e n You should see the Orchard setup screen in your browser 1 2 3 Running the Site Using WebMatrix and IIS
36. Shift S Its a good practice to always save before using the command line utility Many of its commands will make changes to your solution and if you have unsaved changes you will get merge conflicts 2 In the Solution Explorer scroll down to the Orchard Web project It should be the very last project in the solution 3 Right click on the Orchard Web project and choose Open Folder in File Explorer 3 9 Extending Orchard 287 Read the Docs Template Documentation Release 1 9 2 Fook Venari vearmidpa Build perties Rebuild erences Clean View ae ba resh html Publish contig Configure Azure AD Authentication Add Application Insights Telemetry Scope to This New Solution Explorer View Build Dependencies Add Manage NuGet Packages Set as StartUp Project Debug Source Control Cut Ctrl X Paste Ctrl V Remove Del Rename Alt Enter 4 Open the bin folder 5 Locate orchard exe in the list and double click it to open _ Orchard Core pdb 09 09 2015 02 00 VisualStudio pdb 1 000 KB Orchard exe 09 09 2015 02 00 Application ET Orchard Fran rnrk dil PAGO 0200 X amp nnlicatinn extens 1 20 KR Note If you don t see orchard exe in the bin folder then you didn t follow the steps in the setting up for a lesson guide You need to have built the solution at least once for this file to exist Press Ctr1 Shift B within Visual Studio to build the soluti
37. html Dark Theme not implemented Brown Theme not implemented 519 Read the Docs Template Documentation Release 1 9 2 4 1 4 Admin UI Below are some of the more recent admin designs Light Admin Theme Dark Admin Theme ist of posts Manage users rev Manage users rev 2 4 1 5 Admin UI Original Below are some of the original admin designs These show how the design progressed from something that was strongly branded Orchard to a more generic design Manage blogs e Manage pages ist of posts e Zip of admin designs 4 1 6 Design Concepts amp amp Ideas These designs and mocks are not related to work we are currently developing Wireframes Context buttons deep zoom concept board Silverlight required Toolbar concept for edit page UI Module install rev 1 Module install rev 2 Page Builder concept Live edit concept PhotoShop mocks e Sidebar toolboxes concept for edit page UI Drawer concept for edit page UI Drawer tab concept rev 1 Drawer tab concept rev 2 JavaScript amp amp html Mocks Context publish buttons Context TinyMCE View switcher Admin buttons We use the Balsamiq Mockups tool to create these walkthroughs 520 Chapter 4 User Experiences 5 1 Archived Specs Blogs Comments Content types Definitions HTML doctype Linkbacks Pingbacks Refbacks and Trackbacks Media management Navigation Page editing Page management and publishing Page
38. lt cig SWithsebbtrng i Srereoryoe te Wrdget 7 3 9 Extending Orchard 343 Read the Docs Template Documentation Release 1 9 2 WithPart typeof FeaturedProductPart Name WithPart typeof CommonPart Name WithPart typeof WidgetPart Name Featured Product Part ContentDefinitionManager AlterPartDefinition typeof FeaturedProductPart Name part gt part WNithDescription Renders information about the featured product Featured Product Part Record SchemaBuilder CreateTable typeof FeaturedProductPartRecord Name table gt table ContentPartRecord Column bool IsOnSale return 1 public int UpdateFroml SchemaBuilder CreateTable typeof FeaturedProductPartRecord Name table gt table ContentPartRecord Column bool IsOnSale recur 25 public int UpdateFrom2 ContentDefinitionManager AlterPartDefinition typeof FeaturedProductPart Name part gt part WithDescription Renders information about the featured product return 33 In the future when you add new updates to your Migration you should follow these steps 1 Create a new UpdateFromN method 2 Set the appropriate return value 3 Apply the amendments you want to make within the update method 4 Alter the Create method so that it creates your data in the correct way your codebase is expecting for a fresh install 5 Update the return value of Create so that it match
39. ve added one or more cultures click General on the dashboard to return to the Manage Settings screen In the Default Site Culture list select the culture to set as the default When you re done click Save 3 1 Authoring Websites 117 Read the Docs Template Documentation Release 1 9 2 Manage Settings 118 Global Settings Site name Orchard Playground Default Site Culture ove supported cultures for the site Page title separator Super user admin Enter an existing account name or nothing if you don t want a Super user account Resource Debug Mode Use web config setting Determines whether scnpts and stylesheets load in their debuggable or minified form Default number of items per page 10 Determines the default number of items that are shown per page Base url Enter the fully qualified base url of your website eg http localhost30320 orchardlocal http www yourdomain com Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Assuming that you have the appropriate set of po files installed applying a new culture has the effect of translating the text in the dashboard menu and UI text The following illustration shows the effect of changing the culture to fr FR Note The translation files might not be complete Configu rer User admin Logout Configuration mise jour Configuration globale Mam du site Orchard Playground Culture par d faut du site fr FR
40. 2318 Core Common Extensions HtmlHe lperExtensions cs 22 msgid as a Draft 23msgid as a Draft 24 msgstr en tant que brouillon 25 268 Core Common Hand lers CommonPartHandler cs 27 msgid Invalid user name 28 msgid Invalid user name 29msgstr Nom d utilisateur invalide 30 318 Core Common Settings LocationSettingsEditorEvents cs 32 msgid Location in a Detail screen 33msgid Location in a Detail screen 34 msgstr Position dans un cran de d tails 45 4 Pi Ln 1 5790 Coll SelO 183 36 KB UTF 8 CR LF INS Default Text How to contribute Register on Crowdin Go to the project page of Orchard CMS and Orchard CMS Gallery and apply to join the project e Your application will be accepted shortly and you ll be added to the project as Proofreader for the selected languages This means that you ll be able to edit and approve translations which is necessary for the translated strings to be included in the downloadable packages f you are new to the Orchard translations please consult with other translators of the same language and make sure you follow the same conventions Resource String Reference The reference for a resource string in a po file the reference string value described in the previous section is optional If no reference is specified the resource string will be used as a fallback whenever a resource with the same ID is queried with a reference that can t be found This is a useful
41. 3 9 Extending Orchard 273 Read the Docs Template Documentation Release 1 9 2 views 9 First Steps Into Orchard x amp First Steps Into Orchard x W ero eee ree gt C fi localhost30321 OrchardLocal blog e WA kA 00 ii Matthew first Steps Into Orchard Writing a blog post Vednesday September 16 2015 10 09 40 PM Welcome to the website Pellentesque in ipsum id orci porta dapibus Sed porttitor lectus nibh Mauris blandit aliquet elit eget tincidunt nibh pulvinar a Vivamus magna justo lacinia eget consectetur sed Mauris blandit aliquet elit eget tincidunt nibh pulvinar a Quisque velit nisi pretium ut lacinia in elementum sed convallis at tellus Curabitur non nulla sit amet nisl tempus convallis quis ac lectus Vivamus suscipit toi accumsan id imperdiet et porttitor at sem Stylesheets Javascript and Media files They are used to modify the look defined in the views They are files like Site css jQuery or the images for background borders and icons Widget A web page typically presents one main content like a blog post but it often also has small pieces of information on the sides Eg a tag cloud a list of recent posts a twitter feed etc Layers and the binding between content to specific zones A layer is like the description of a group of pages Once defined you can tell where to put each content or widget Eg A layer grouping all the blog posts can be defined the
42. 7x for Ib Mae Typography Optional ck KK KK KK KK KK KKK KK KK KK KK KKK KK KK KK KK KK KK KKK KK KK KKK KEK KKK KKK ck ck ko k k import url hbttpil yuilyahoocapusicom 2 0 1 buuild fonts fonts min Jgoss xx General KK KK KK KK KK KK KK KKK KK KK KK KKK KK KK KK KK KK KKK KEK KEK KKK KEK KEK KEKE KKK ck ck k ck k body B elink il hoveri Visited o ooo Db nonse one Structure KK KK KK KK KK KK KK KK KK KK KK KK KKK KK KK KK KK KK KKK KKK KKK KKK KEK KEKE KKK KK KEK container fheader logo 476 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Frooter 1j x Main KK KKK KKK KK EK KK KK KKK KK KK KK KK KK KKK KK KK KK KK KKK KKK KKK KK KK KEKE KK Secondary Kckckckckckckckokckockckckckokckokckokckckckckckckokckokckokckockckckckckckckckckckckckckckckckckckckckck ck ck ckck ck ck ckck ck ck k Forms ck ckckckckckckckckckckockckckckckckckokckockokockckockockockckckckckokckokckokckckckckckckckckokckokckckckckckckckck ck ck ckck ck ck k x Misc Kckckckckckckckokckokokokckokckokckockckckckckckckokckokckokckckckockckckckckckckokckckckckckckckckckckok ck ck ckck ck ck ck ck ck ck k CSS Reset You should always use a reset to normalize styling between browsers and then apply default markup manually For more information about resets see Reset Reloaded You can optionally use a reset library To reset a global style 1 Apply the reset 2 Appl
43. Add or remove programs Calendar oe me add or remove programs FTSE 100 A 6 584 17 42 56 Spe ate ote gs NIKKEI 225 14 417 68 420 87 or remove programs windows 8 Click Turn Windows features on or off mi Programs and Features T iml t Control Panel Programs Programs and Features w oC Search Programs Control Panel Home i ED Uninstall or change a program resa uxctallerl urnrlaterc To uninstall a program select it from the list and then click Uninstall Change or R Ae Turn Windows features on or off Organize Mame Publisher Mo programs are installed on this computer Click Internet Information Services and then ASP NET 4 5 Click OK 10 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 z Windows Features Turn Windows features on or off To turn a feature on select its check box To turn a feature off clear its check box A filled box means that only part of the fea Oe NET Framework 3 5 includes WET 2 0 and 3 0 a NET Framework 4 5 Advanced Services Cie Active Directory Lightweight Directory Services Ce Hyper V m l tt i di Internet Information Services H OE FIP Server E oe Web Management Tools c j World Wide Web Services E m Application Development Features NET Extensibility 3 5 v NET Extensibility 4 5 1j Application Initialization Ch ASP LI LI Fat Fn Ecc At this point we recommend reb
44. Alias Tokens Content Control Wrapper Enable Add an Edit button on the front end for authenti Depends on Contents Date Time Format Localization Enable Enables localization of date time formats and na Lists Disable A basic container enabled content type Depends on Autoroute Containers Contents Admin user interface for Orchard Alias Depends on Alias Blogs Disable A simple web log Depends on Autoroute Common Feeds jQuery Content Localization Enable Enables localization of content items Depends on Settings Feeds Tokens Enable Provides a content part to customize RSS fields Depends on Feeds Tokens Pages Disable A basic page content type Depends on Contents Orchard ContentPicker Scheduled archiving Depends on Common Scheduling Containers Disable Container and containable parts to enable paren Depends on Contents Feeds ContentTypes Disable ContentTypes modules enables the creation and Depends on Contents Import Export Enable Imports and exports content item data Projector Disable Provides methods to control how lists of content Depends on Feeds Forms Title Tokens The Features screen displays the available features that can be enabled or disabled Depending on which features are enabled or disabled your site will have different admin panel options front end user interface elements and other behaviors The default view of ava
45. GetRewards return rewardProgramRepository Table ToList Note again this is designed for small numbers of reward programs If you have larger models and have adopted an Add Remove pattern talked about in the previous note the code for the service actually becomes simpler as it executes lower level operations that affect one program at a time rather than try to synchronize the whole collection at once Building the Views The Front End View The front end view is just displaying the list of rewards as an unordered list h4 GT Rewards h4 ul foreach var reward in Model Rewards li G8string Format 0 1 P1 reward Name reward Discount li Jub 404 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 The Editor View The editor view is a little more remarkable model RelationSample ViewModels EditRewardsViewModel lt fieldset gt lt legend gt T Rewards lt legend gt SS var rewardlndex 0 foreach var reward in Model Rewards lt li gt lt input type hidden value reward RewardProgram Id name Html FieldNameFor m gt m Rewards rewardIndex RewardProgram Id label for Html FieldNameFor m gt m Rewards rewardIndex IsChecked lt input type checkbox value true name Html FieldNameFor m gt m Rewards rewardIndex IsChecked id Html FieldNameFor m gt m Rewards rewardIndex IsChec
46. Orchard Azure Orchard Azure MediaServices Orchard Blogs Orchard Caching Orchard CodeGeneration Orchard Comments Orchard ContentPermissions Orchard ContentPicker Orchard ContentTypes Orchard Core Orchard Core Tests Orchard CustomForms Orchard DesignerTools Orchard DynamicForms Orchard Email Orchard Fields Path E rtpSoftware Orchar E rtp Software Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftwarekOrchar E rtpSoftwareVOrchar E rtpSoftwareXOrchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftwareVOrchar E rtpSoftware amp Orchar E rtpSoftwarexOrchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar Search Projects Ctrl E P Name Lucene 3 Now we have to update our dependencies straight away so they don t get forgotten Open up the Module txt file located in the project root 4 The last line of the file should contain the Orchard Widgets dependency that we created in part one This field will take a comma separated list detailing each dependency a modules has Update the line to add Orchard Alias Add 322 Dependencies Orchard Widgets ensuring that the line keeps it s indentation Below the pr
47. Orchard Recipes allow you to setup your site with additional pre configured options features and settings out of the box Default 210 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 The initial list contains the following recipes Default The default recipe for an Orchard site that includes pages blogs custom content types comments tags widgets and basic navigation Blog A recipe that provides an installation profile with features for a personal blog Core A recipe that provides the Orchard framework with limited end user functionality that can be used during development After you choose a recipe and click Finish Setup Orchard creates the website using the selected recipe and opens the home page How Recipes Work An Orchard recipe is an XML file that contains website configuration information The following example shows the contents of the default recipe file lt xml versions 1 0 o gt SOPOnarco Recipe lt Name gt Default lt Name gt lt Description gt The default recipe for an Orchard site that includes pages blogs custom lt Author gt The Orchard Team lt Author gt lt WebSite gt http orchardproject net lt WebSite gt lt Tags gt lt Tags gt Version 1 0 Version lt IsSetupRecipe gt true lt IsSetupRecipe gt lt Recipe gt Feature enable Orchard Blogs Orchard Comments Orchard Tags Orchard Alias Orchard Auto TinyMce Orchard Me
48. Provides a content part to customize RSS fields Imports and exports content item data Depends on Feeds Tokens Lists Disable Pages Disable Projector Disable A basic container enabled content type Depends on Autoroute Containers Contents A basic page content type Depends on Contents Orchard ContentPicker To enable a feature simply click Enable for that feature Manage Features Content Provides methods to control how lists of content Depends on Feeds Forms Title Tokens Localization Disable Depends on Settings Orchard Blogs Depends on Feeds PublishLater Depends on Common Settings Disable When a feature is enabled a message appears at the top of the Features screen telling you the feature was enabled successfully 3 4 Managing Websites 181 Read the Docs Template Documentation Release 1 9 2 Localization was enabled Manage Features Content Localization Disable Orchard Blogs Disable Depends on Settings Depends on Feeds PublishLater Disable Depends on Common Settings A feature can depend on one or more other features listed under the feature name When a feature with dependen cies 1s enabled the dependencies are also automatically enabled For example the Gallery feature depends on the Packaging Commands feature which in turn depends on Packaging Features Installed Recipes Filter galler Actions Choose action Execute Packaging Gallery Enable
49. Sidebar Footer Change History Updates for Orchard 1 1 4 4 11 Updated introduction to the Razor syntax Added new section on accessing Orchard objects in code 3 11 7 Packaging and Sharing Themes This topic is being updated for the Orchard 1 1 release Orchard provides a packaging feature that lets you share themes you have created The feature creates a package zip file in nupkg format that contains your theme It also lets you upload your new theme to the Orchard Gallery This article shows you how to package a theme and upload it the Orchard Gallery and how users can download and install your theme Viewing the Packaging Modules To view the packaging modules open the Orchard dashboard and click Modules Scroll to Packaging 3 11 Creating Themes 469 Read the Docs Template Documentation Release 1 9 2 Packaging Gallery Disable Package Updates Disable Packaging Disable Depends on Packaging commands Depends on Gallery Packaging commands Disable Depends on Packaging The Packaging modules are enabled by default If any of the modules have been disabled you must enable them in order to package and upload your theme Packaging Your Theme To package your theme open the Orchard command line and type the following command replacing MyFirstTheme with the name of your theme and C 7emp with the output path for the generated package file package create MyFirstTheme C Temp The package feature
50. The Culture calendar option means the default calendar for the culture of the current request will be used not necessarily the configured default site culture Gallery Settings To access settings for the gallery click Gallery in the Settings panel This opens the following screen Gallery Add Feed Title Url Orchard Gallery http packages orchardproject net FeedService svc Delete In the gallery feed settings you can add or delete a feed using the following settings Add Feed Lets you specify the URL to a gallery feed Delete Lets you remove an existing gallery feed For more information about how to add feeds to the gallery see Registering Additional Gallery Feeds Comments Settings To access settings for comments click Comments in the Settings panel This opens the following screen Comments Comments must be approved before they appear Check if you want to manually approve comments before they can be displayed Automatically close comments after 0 days Number of days after comments are automatically closed Leave to 0 to have them always available In the comments settings you can enable or disable the following features 196 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Comments must be approved before they appear Requires user comments to be approved by an administrator or moderator before they become visible on the site Automatically close comments after
51. The Handler UsedImplicitly public class ShareBarSettingsPartHandler ContentHandler public ShareBarSettingsPartHandler T NullLocalizer Instance Filters Add new ActivatingFilter lt ShareBarSettingsPart gt Site Filters Add new TemplateFilterForPart ShareBarSettingsPart ShareBarSettings public Localizer T i get sec j protected override void GetItemMetadata GetContentItemMetadataContext context if context ContentItem ContentType Site return base GetItemMetadata context context Metadata EditorGroupInfo Add new GroupInfo T Modules The View model Szmyd Orchard Modules Sharing Models ShareBarSettingsPart lt fieldset gt lt legend gt T Content sharing settigs legend lt div gt Html LabelFor m gt m AddThisAccount QGT AddThis service account dHEmlI bEditorbori m gt m AddIlIhisAccount Html ValidationMessageFor m gt m AddThisAccount x div lt fieldset gt Using site scope settings Accessing your site setting is a simple one liner var shareSettings _services WorkContext CurrentSite As lt ShareBarSettingsPart gt Where _ services is the TOrchardServices object eg injected in the constructor Defining site scope settings Pre Orchard 1 8 Defining custom site scope settings for before Orchard 1 8 can be in Adding Custom Settings pre Orchard 1 8 3 9 Extending Orchard 423 Read the Docs Template Documentation
52. The dex geneated by this module can then be ured by the search module to provide an integrated full text search experience to a web site More information Lj commer Tage orchard lucene indexing search 643 Downloads Search 1 0 20 By The Orchard Team Li bh dh d EXovoanb o ad The search module enables the management of Ehe search index and provides the front end searching user betere Move Modules are categorized so you can quickly find what you are looking for by clicking any category link or selecting from the category dropdown next to the search input box 164 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Hosting Localization Contact us 0 6 0 Downoad By Aaron Rhoades of East Watch Services and Richard Garside of HogginBas Location Adds a contact us page t ir website More infonnateon 295 messaging email contact contact form Mesa Perlamance Mobile Contact User 0 9 Download Ey Ardre Rodregues ay More infermation Publishing mem Reporting 2 Contact Form 0 9 1 Download e Ey Cyberstnde Security erm requests More information EC laci ernail contact oem friiLagan g Coat Site Navigation The Themes tab displays a list of themes similar to the modules section Unlike modules themes are not categorized However both modules and themes support tags that can be specified by the author submitter and you can click any tag link on the site to fi
53. You can see examples of that by looking at the source code of any core content type for example Pages e Autofac Autofac is an IoC container Orchard makes heavy use of dependency injection Creating an injectable Orchard dependency is as simple as writing a class that implements Dependency or a more specialized interface that itself derives from Dependency a marker interface and consuming the dependency is as simple as taking a constructor parameter of the right type The scope and lifetime of the injected dependency will be managed by the Orchard framework You can see examples of that by looking at the source code for IAuthorizationService RolesBasedAuthorizationService and XmlRpcHandler Castle Dynamic Proxy we use Castle for dynamic proxy generation The Orchard application and framework are built on top of these foundational frameworks as additional layers of abstraction They are in many ways implementation details and no knowledge of NHibernate Castle or Autofac should be required to work with Orchard Orchard Framework The Orchard framework is the deepest layer of Orchard It contains the engine of the application or at least the parts that couldn t be isolated into modules Those are typically things that even the most fundamental modules will have to rely on You can think of it as the base class library for Orchard Booting Up Orchard When an Orchard web application spins up an Orchard Host gets created A host is a s
54. calls At the moment the Migrations cs is on UpdateFrom2 which has a return value of 3 This is the value that we want new installs to start at The first update calls CreateTable ona SchemaBuilder instance That can be copied in to the end of the Create method The second update uses AlterPartDefinition which is another method on the ContentDefinitionManager class so technically this could be chained on to the end of the ContentDefinitionManager instance already in use in the Create method In practice however it is common to separate out the work on each content type part to its own statement block This means the process will be as follows 1 Open the Migrations cs located in the root folder of the module 342 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 2 Copy the CreateTable call from UpdateFroml to the Create method so that your Create method now looks like this public int Create Featured Product Widget ContentDefinitionManager Alter TypeDefinition FeaturedPro ductWidget cfg gt cfg WithSetting Stereotype Widget WithPart typeof FeaturedProductPart Name WithPart typeof CommonPart Name WithPart typeof WidgetPart Name Featured Product Part Record SchemaBuilder CreateTable typeof FeaturedProductPartRecord Name table gt table ContentPartRecord lt CoLumn boolL gt osonsale 3 return y j Leave the original UpdateFr
55. e Shell only one instance is created per shell tenant Use this by deriving from ISingletonDependency Only use this for objects that must maintain a common state for the lifetime of the shell Replacing Existing Dependencies It is possible to replace existing dependencies by decorating your class with the OrchardSuppressDependency attribute that takes the fully qualified type name to replace as an argument Ordering Dependencies Some dependencies are not unique but rather are parts of a list For example handlers are all active at the same time In some cases you will want to modify the order in which such dependencies get consumed This can be done by modifying the manifest for the module using the Priority property of the feature Here is an example of this Features Orchard Widgets PageLayerHinting Name Page Layer Hinting Description Dependencies Orchard Widgets Category Widget Priority i ASP NET MVC Orchard is built on ASP NET MVC but in order to add things like theming and tenant isolation it needs to introduce an additional layer of indirection that will present on the ASP NET MVC side the concepts that it expects and that will on the Orchard side split things on the level of Orchard concepts For example when a specific view is requested our LayoutAwareViewEngine kicks in Strictly speaking it s not a new view engine as it is not concerned with actual rendering but it contains the logic to find the right view de
56. featuredProductService protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts FeaturedProduct gt return shapeHelper Parts FeaturedProduct IsOnFeaturedProductPage featuredProductService IsOnFeaturedProductPage ee protected override DriverResult Editor FeaturedProductPart part dynamic shapeHelper return ContentShape Parts FeaturedProduct Edit gt shapeHelper EditorTemplate TemplateName Parts FeaturedProduct Model part Prefix Prefix protected override DriverResult Editor FeaturedProductPart part IUpdateModel updater dynamic shapeHelper Extending Orchard 339 Read the Docs Template Documentation Release 1 9 2 updater TryUpdateModel part Prefix null null return Editor part shapeHelper Now the driver class is clean again and only has dependencies that it directly needs Describe your content parts We created the content part the widget back in the first part of this course However we missed a best practice when running that initial data migration because the content part was created without a description You should always add a description to your parts so that it s clear what they do Both your users and likely even yourself when you come back in a few months time will need a prompt which explains what it s for The description can be added within a data migration by calling W
57. following path views parts Map cshtml The following table summarizes the conventions that are used to name shape types and templates Applied To Shape Naming Convention Shape Type Example Template Example Ss Sr Content shapes Content__ ContentType Content__BlogPost Content BlogPost Content shapes Content__ Id Content__42 Content 42 Content shapes Content__ DisplayType Content__Summary Con tent Summary Content shapes Content_ DisplayType __ ContentType Content_Summary__BlogPost Content BlogPost Summary Content shapes Content DisplayType Id Content_Summary__42 Content 42 Summary Content Edit shapes Content Edit DisplayType Content Edit Page Content Page Edit Content Part tem plates ShapeType Id Parts Common Metadata 42 Parts Common Metadata 42 Content Part templates ShapeType ___ ContentType Parts Common Metadata BlogPost Parts Common Metadata BlogPost Field tem plates ShapeType FieldName Fields Common Text Teaser Fields Common Text Teaser Field templates ShapeType PartName Fields Common Text TeaserPart Fileds Common Text TeaserPart Field templates ShapeType __ ContentType __ PartName Fields Common Text Blog TeaserPart Fields Common Text Blog TeaserPart Field templates ShapeType PartName FieldName Fields Common Text TeaserPart Teaser Fields Common Text TeaserPart Teaser Field t
58. lt div class editor label Html LabelFor model gt model Longitude lt div gt lt div class editor field gt Html TextBoxFor model gt model Longitude Html ValidationMessageFor model gt model Longitude eoa wo fieldset The Html LabelFor expressions create labels using the name of the shape properties The Html TextBoxFor expressions create text boxes where users enter values for the shape properties The aHtml ValidationMessageFor expressions create messages that are displayed if users enter an invalid value Layout and Document Templates The layout and document templates are special template types that define the structure of a web page These templates are most often used in themes for laying out a web page Each web page has a Layout shape dynamic object 3 11 Creating Themes 467 Read the Docs Template Documentation Release 1 9 2 associated with it The Layout shape defines the zones that are available to hold web page contents The layout and document templates determine how the zones defined in the Layout shape will be laid out on the web page The layout template Layout cshtml lays out the zones for the body of the web page The document template Docu ment cshtml wraps around the layout template and lays out the remainder of the web page By default the Layout shape defines three zones for use in the document template Head Body and Tail and one shape for the layout template Content
59. n4 n5 NG p 9Dlockquote pre a abbr acronym address big cite code del dfn em font img ins kbd q s samp small strike Strong sub Sup tt var di Ot Od Ol ul Li fieldset form label legend table caption tbody tfoot thead tr th td margin 0 padding U border 0 outline 0 font weight inherit font style inherit tont sizes I00 7 font family inherit 434 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 vertical align baseline header footer aside nav article display block Clearing Float KK KK KK KK KK KK KK KK KK KK KK KK KKK KK KK KK KK KK KKK KK KK KK ok ckckckckckckckckckckckck ko k k group after CONTENE S TI TES displays Dlock hesxghus s clear both visibility hidden Ogrtoup displayi inline block ge Jof ILbE M ac General ck ckckckckckckckckokokokckckckckckckockckokckokckockckckckckckckokckokckckckckckckckckckckokckckckckckckckckckckckckckck kk k body font normal 100 Segoe UI Trebuchet Arial Sans Serif height 100 text align left colorsqOoOO0s background d3d3d3 Headings x hl h2 h3 h4 Hh5 h6 legend font weright normal font style normal AL Tont Sres 19605223 K2 Lrfontesrizei 14253 no wronbtesrs2etf 23092 h4 font size 120 no Ironbtespoeee 0595 margin 0 0 lem line height 1 538em p zmg lerb c Pleats Lert maron 0 9235e60m 04 9256 0 925em 0s paddrng
60. normal user aka reader visitor guest administrator designer and developer User As a user an Orchard website is just like any website It starts with a front page from which you can access other pages by following links Depending on what the website is about the content will vary can be static pages blog wiki e commerce etc 3 9 Extending Orchard 269 Read the Docs Template Documentation Release 1 9 2 Administrator The administrator has access to a few more aspects of the website 1 When installing Orchard they will see the installation page This step results in the creation of a database where all the content and settings of the website are stored y 5 Orchard Setup Get Start X X h C ft D localhost 30321 OrchardLocal Tw wt Ed o9o z 9 Welcome to Orchard Get Started Please answer a few questions to configure your site What is the name of your site First Steps Into Orchard Choose a user Name admin Choose a password How would you like to store your data 2 Of course as users they can see the front end as well 3 They can open the dashboard aka control panel back end for two reasons a Configure the website Edit settings around the behavior and look of the website or install disable upgrade them 270 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 k 9 ZEHN NE Settings EY Dashboard General Site name First Ste
61. re working on You can bring your branch back in line with the main repo by syncing your fork What to do if your pull request is not accepted Sometimes pull requests don t get accepted Maybe the feature isn t classed as complete enough maybe you have a different vision for the feature compared to the core team Whatever the reason if you find yourself in this position then don t worry Consider implementing your new idea as an Orchard Module instead There are plenty of tutorials on this website and around the web which will teach you how to do this With the way Orchard has been built you can extend and replace almost every part of it 516 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 When you have extracted your code into a module you can submit it to the Orchard Gallery for other users to download and use in their sites 3 14 Getting Involved 517 Read the Docs Template Documentation Release 1 9 2 518 Chapter 3 Documentation CHAPTER 4 User Experiences 4 1 Walkthroughs and UI Mockups 4 1 1 Orchard Branding Branding svg e Branding vectors Branding PSD Adobe Illustrator logo sources 4 1 2 Wireframes Click on the walkthrough title to download a zip file containing the numbered images Blog Comments Media Management Pages Roles and Permissions e Themes 4 1 3 Themes Photoshop and HTML front end theme mockups Classic Theme html Green Theme
62. recommended Import the publishsettings from your hosting provider s control panel Enter settings Enter your FTP or Web Deploy credentials manually I need web hosting Ey Get started with Windows Azure Sign up for free cloud hosting on Windows Azure By Find Windows web hosting Sign up for web hosting To publish a website you must have an account with a web hosting provider If you don t have one yet you can select either Get Started with Windows Azure or Find Windows Web Host ing If you select Windows Azure you will have the option of creating your website as eli ther an Azure Website or Azure Web Role For instructions on working with Azure see 1 3 Working with Orchard in WebMatrix 35 Read the Docs Template Documentation Release 1 9 2 a g PORTAL Free trial HOME PRICING DEVELOP MANAGE STORE COMMUNITY SUPPORT ACCOUNT Cloud optimize your buSINesSsS Windows Azure 90 day free trial Quickly build deploy amp manage applications Use any operating system language or tool try it free No obligation totally free lg cc or buy now yO Ul fre e compute 750 small compute hours per month web sites 10 web sites tri qd CO nta S mobile services 10 mobile services relational database 1 SQL database SQL reporting 100 hours per month storage 35GB with 50 000 000 storage transactions bandwidth unlimited inbound amp 25GB outbound cdn 20GB outbou
63. reorder and remove menu items This will not delete the content item it will only remove the menu item 76 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 User admin Logout Dashboard Manage Main Menu Content Home L Remove Blogs Download 2 Miewnlaad Renee Comments Our Bleq 3 eur bleg Rare gt Lists Upate All Widgets Add Mew Item Media Text Pesiti n Url Add Orchard Site 2 1 http orchardproject nat Tags Themes Users gt Co nfiquratio n You can also add arbitrary URLs in your menu whether external or pointing to a page in your Orchard site by adding a new menu item Note that only items added in this way have an editable URL on this screen Content item URLs must be edited from the editor screen for that content item instead To reorder menu items type a numeric index in the Position textbox Position indexes can be any of the following format nteger 1 2 3 etc Decimal 1 1 1 2 1 3 etc Multi part number 1 1 1 1 2 1 1 2 2 etc When you are satisfied with your changes click Update All to update the main menu of your site effective immedi ately Change History Updates for Orchard 1 8 4 24 14 Added screenshots Now you can t create a Content Menu Item and leave empty the content item updated that part Changed a bit the structure to comply with Orchard style documentation guidelines 1 7 Adding a Blog to Your Sit
64. 1 M I Add Existing Copy l 30 To Line al Restart d Close A diis duras Select A View Launch E ud a _ Orchard a App_Data bin Config Core Media Modules Themes CREDITS txt pz Create a new file F Global asax i Choose from one of many templates LICENSE b t E Site E Files F n You should see the Orchard setup screen in your browser 1 2 4 Running the Site Using Visual Studio and the Visual Studio Development Server This procedure was tested with Visual Studio 2013 Update 1 Altough you can run the precompiled version of Orchard in Visual Studio you will find much easier to work in Visual Studio with the full source code version Download the full source code from here Extract the zip file to a local folder 1 2 Manually installing Orchard from a zip file 19 Read the Docs Template Documentation Release 1 9 2 Launch Visual Studio and select File gt Open gt Project Solution Navigate to the folder where you extracted the zip Mame i lib di src AzurePackage proy build cmd ClickToBuild cmd ClickToBuild amp zurePackage cmd Ej CREDITS txt DeleteModuleBinaries cmd E LICENSE txt Orchard proj Date modified 11 7 2012 5 41 PM 11 7 2012 5 42 PM 11 7 2012 5 42 PM 11 7 2012 5 42 PM 11 7 2012 5 42 PM 11 7 2012 5 42 PM 11 7 2012 5 42 PM 11 7 2012 5 42 PM 11 7 2012 5 42 PM 11 7 2012 5 42 PM and open the folder named src Select the Orchard sln solution fi
65. 12 Developer Tools and Guidelines 487 Read the Docs Template Documentation Release 1 9 2 Repository to clone https github com Orchard C MS Orchard Destination EXOrchardLearnOrchard Subdirectory to create Orchard Branch master d The repository will be cloned to a new directory located here E Orchard LearnOrchard Orchard New directory Repository type Personal repository J Public repository no working directory bare Initialize all submodules Load SSH key You will not be prompted for your GitHub login and password unless you try to commit changes Step 3 Building and Running the Orchard Source You can build and run Orchard either from the Visual Studio or using a command line batch file Using Visual Studio Open Orchard sln from the Git enlistment directory in src For information on the struc ture of the Orchard solution see the source code organization page of this website 488 Chapter 3 Documentation DA Developer Command Prompt for VS2012 Program Fil Microsoftt Visual Studio 11 8 cd C XASourcesXMOrchard dir w iFurePackage proj ClickToBuildAzurePackage cmd sXOrchard cd src cr Sources Orchard srcsdir w Orchard Orchard 5 ReSharper Orchard Azure Tests Orchard Protile Orchard sln DotSettings Orchard Tests Orchard WarmupStarter Orchard Web Tests OrchardSecurity ruleset Tools build cmd CREDITS txt Biles ET an Read the Docs Temp
66. 5 Route new Route HelloWorld this is the name of the page url new RouteValueDictionary area HelloWorld this is the name of your module oontroLler Home tya action Index new RouteValueDictionary new RouteValueDictionary area HelloWorld this is the name of your module by new MvcRouteHandler n A route is a description of the mapping between URLs and controller actions This code maps the HelloWorld URL to the area HelloWorld with the Home controller and the Index action Creating the Controller The new module also has a Controllers folder ready to be filled Create the following HomeController cs file in that folder 3 9 Extending Orchard 347 Read the Docs Template Documentation Release 1 9 2 using System Web Mvc using Orchard Themes namespace HelloWorld Controllers Themed public class HomeController Controller public ActionResult Index return View HelloWorld This is the controller that will handle the requests for the HelloWorld URL The default action index is requesting that the HelloWorld view gets rendered Notice the Themed attribute on the controller class that will request that the view gets skinned with the currently active theme Creating the View In the Views folder create a folder named Home In the Views Home folder create the following HelloWorld cshtml file h2 80T Hello Worlgd
67. 6 Adding a Timer Activity The Timer Activity adds a delay so that the processing thread doesn t get blocked Upload workflows addingtimer png 7 Editing Timer Activity Upload workflows editingtimer png 8 Adding Send Email Activity Upload workflows addingsendemail png 9 Editing Send Email Activity Using Tokens to access the form posted values by the end user New Contact Request by Content Fields ContactUs Name lt p gt New Contact Request by Content Fields ContactUs Name lt p gt lt p gt Email Content Fields ContactUs EmailAddress lt p gt lt p gt Message Content Fields ContactUs Message lt p gt N 24 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Upload workflows editingsendemail png 10 Submitting Form Upload workflows submittingform png 11 Workflow Running Upload workflows workflowrunning png 12 Blocking Activity The timer Blocking Activity has a delay period of 2 mins Upload workflows blockingactivity png 13 Contact Us Email Notification Sent Upload workflows emailsent png Upload workflows emailsentl png for more on Workflows browse to the Orchard Tutorials Area 3 4 11 Projection This topic targets and was tested with the Orchard 1 5 release 3 4 Managing Websites 225 Read the Docs Template Documentation Release 1 9 2 The Orchard Projections Module Provides methods to control how lists of content items are filtered and displayed
68. B Z 3 Paragraph E Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh condimentum tellus 7 Click Create Folder g Create Folder ow Any show al Y Ordered by recently created Recent 8 Name the folder myImages and click Save 15 Getting Started with Orchard 57 Read the Docs Template Documentation Release 1 9 2 Media Library gt Add a Folder Folder Name mylmages Cancel 9 Click the folder myImages and then click Import Media folder created Edit Folder ecc Show Any show all Ordered by recently created Recent 10 Click My Computer and then click in the central zone to browse for an image If you prefer you can drop your image into the central zone Media Folders gt mylmages My Comput Q Web Search D Media Url Click here Drop files o 58 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 11 Close the dialog Media Folders gt mylmages Create Any 4 My Computer Q Web Search 2 Media Url Recent PROPERTIES 2 mylmages Last modified 1 minute ago By admin Title Tulips Filename Tulips jpg Mime Type image jpeg Status Published Dimensions 1024 x 768 SELECTION 13 If needed resize the image using the handlers so that later it fits nicely into the zone Then click Save to save the 1
69. CSS snippet into the lt style gt block at the top of the view sale red background color d44950 color fff float right padding 25em lem display inline 3 Add this snippet in to the main body above the first p tag if Model ContentPart IsOnSale ON SALE You will notice that this view doesn t feature an model directive at the top This is because the model is a dynamic class which contains the content part information and various other properties supplied by Orchard This means that you can t define it in the view beforehand as the class isn t a named type and IntelliSense doesn t know what properties are going to be available at run time Because of this you are on your own when typing up the views It can be helpful to add breakpoints to inspect the structure of the model at run time if you don t know what value you re looking for The Gif Model ContentPart IsOnSale line simply checks if the value is true and if so it dynami cally shows the HTML contained within the curly braces displaying a red ON SALE banner within the widget You should now have a FeaturedProduct cshtml file that looks like this style btn green padding lem text align center color 111 background color 4344853 3 9 Extending Orchard 311 Read the Docs Template Documentation Release 1 9 2 font size 2em display block Sale red background color 3044950 color Sri t fl at rignt padding 2
70. Content Types Content Lets you manage the instances of your content types For example it lets you create pages edit or remove existing pages and publish pages For more information see Adding Pages to Your Site Content Definition Lets you manage existing content types as well as creating your own For more information see Content Types Blog Lets you add a blog to your website create new blog posts and manage your blog For more information see Adding a Blog to Your Site Queries Lets you add new queries and edit or remove existing queries Queries are later used for display lists of content items through the site Comments If your website is configured to allow users to post comments lets you manage the posted comments For more information see Moderating Comments Taxonomies Lets you manage taxonomy terms Later on you can use them to categorize content items and display or hide them in different ways according to their taxonomy Widgets Lets you manage the widgets that appear on the pages of your site For more information see Managing widgets Media Lets you add or remove folders that contain media For more information see Adding and Managing Media Content Navigation Lets you add or remove items in the main menu and define additional navigation menus For more information see Navigation and Menus Tags Lets you add or remove content tags for your site For more information see Organizing Content with Tags Modules Lets yo
71. ContentHandler public ProductHandler ITRepository lt ProductPartRecord gt repository Filters Add StorageFilter For repository j Add the file to the csproj file so that dynamic compilation can pick it up using the following line Compile Include Handlers ProductHandler cs Adding a Driver A driver in Orchard is analogous to a controller in ASP NET MVC but is well adapted to the composition aspect that is necessary in web content management systems It is specialized for a specific content part and can specify custom behavior for well known actions such as displaying an item in the front end or editing it in the administration UI A driver typically has overrides for the display and editor actions For the product part create a new Drivers folder and in that folder create a ProductDriver cs file that contains the following code using SimpleCommerce Models using Orchard ContentManagement Drivers using Orchard ContentManagement namespace SimpleCommerce Drivers public class ProductDriver ContentPartDriver lt ProductPart gt protected override DriverResult Display ProductPart part string displayType dynamic shapeHelper return GContentsShape Parts Product gt shapeHelper Parts_Product SKUe part oku Price part Price GET protected override DriverResult Editor ProductPart part dynamic shapeHelper return ContentShape Parts_Product_Edit gt shapeHelper EditorTemplate
72. Displays HTML content which is entered using the widget s editor Recent Blog Posts Displays a list of recent posts for the specified blog 1 9 3 List of Layers Orchard comes with a number of layers already defined You can define additional layers as needed as discussed later in Adding a Layer In the Widgets screen you can edit the existing layers by selecting a layer in the Current Layer drop down list or you can add new layers by clicking Add a new layer The following table lists the default layers shows the rule that defines the layer and describes the effect of the layer Layer Rule Description Default true Always dis played on every page Authenticated authenticated Displayed if the user is authenticated Anonymous not authen ticated Displayed if the user is anonymous Disabled false Not displayed This layer is provided as way to save the configuration of widgets that are not currently displayed TheHomepage url Displayed on the home page 1 9 4 List of Zones In Orchard a web page is divided into zones regions The available zones are defined by the website s theme In the Widgets screen you can see the list of all zones available for the currently selected layer The list also shows the widgets assigned to each zone for the selected layer For information about the zones that are available in the default
73. E Edit any blog posts E Publish or unpublish blog post E Publish or unpublish blog post for others E Delete blog post lal Delete blog post for others E If you unselect the Manage blogs permission all of the other permissions are also revoked The following image shows a role with Edit any blog posts granted Edit own blog posts is implicitly granted Orchard Blogs Feature Permission Allow Effective Manage blogs IP Edit own blog posts E Edit any blog posts Ei Publish or unpublish blog post E Publish or unpublish blog post for others Delete blog post Delete blog post for others The following image shows a role with only Edit own blog posts granted No permissions are implicitly granted with 208 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Orchard Blogs Feature Permission Allow Effective Manage blogs Edit own blog posts FJ Edit any blog posts Publish or unpublish blog post Publish or unpublish blog post for others B PED D Delete blog post Delete blog post for others al this selection Orchard ContentPermissions This applies to the Orchard ContentPermissions Module available since Orchard 1 5 1 When enabling the ContentPermissions module you can define item level permissions for the front end This allows you to protect your Projections or own Content Types 3 4 8 Making a Website Recipe Orchard simplifies the process of setting up a new website by letting yo
74. Express Download the Orchard Web 1 x xx zip file from here Extract the Orchard zip file to a local folder Launch WebMatrix and in the Quick Start screen click Open and then Folder 16 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 3 Quick Start Microsoft WebMatrix o Bee Sign in O 7 hh Sites Windows Azure Microsoft e WebMatr w e Source Control iy Sites New Open Skip this page on start up Options Navigate to the folder where you extracted the zip file select the folder named Orchard and then click Select Folder to open the site 1 2 Manually installing Orchard from a zip file 17 Read the Docs Template Documentation Release 1 9 2 2 Select Folder f di Mye Orchard Web w C Search Orchard Web 1 8 pe Name Date modified E orrera jE This PC E Desktop EJ Documents IISExpress m My Web Sites Orchard Web 1 8 Orchard m Downloads M Music LE Pictures LB Videos ia Local Disk C 4 16 2014 4 48 P Organize New folder i l w ii s Folder Orchard Cancel To run the site in the WebMatrix Files workspace select the root Orchard folder Click the drop down list in the Run button and then select a browser 18 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 z 1LI d Orchard Microsoft WebMatrix Home Remote Source Control 3 Bl Stop ai 30 T
75. FeaturedProductDriver ContentPartDriver lt FeaturedProductPart gt protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts FeaturedProduct gt shapeHelper Parts_FeaturedProduct 298 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 View Orchard uses Razor template views to display it s shapes You can supply strongly typed data models and use many of the normal ASP NET MVC Razor view features within Orchard For this first widget our needs are simple and we will only be putting plain HTML markup inside the cshtm1 file 1 Add a new folder inside the Views folder called Parts Right click on the View folder in the solution explorer click Add New Folder andtype Part s 2 Add a new cshtml1 Razor view within the Parts folder called FeaturedProduct cshtml 3 Within the FeaturedProduct cshtml view file add the following HTML markup Placement Almost all of the key elements are in place now except for this last one The configuration inside a driver class tells Orchard how to render that content part Content parts always exist within a larger composite content item Placement is used to tell Orchard where to render these components The placement info file goes in the root folder of the module It is an XML file with a simple structure You can learn more about the placement info in understanding placement info
76. IWorkContextAccessor workContextAccessor private readonly IAliasService aliasService private IContent currentContent null private IContent CurrentContent get if currentContent null var itemRoute aliasService Get workContextAccessor GetContext HttpContext Request AppRelativeCurrentExecutionFilePath sUDSErIng CL atr m 5 currentContent contentManager Get Convert ToInt32 itemRoute Id return _currentContent public FeaturedProductDriver IContentManager contentManager IWorkContextAccessor workContextAccessor IAliasService aliasService _contentManager contentManager _workContextAccessor workContextAccessor aliasService aliasService protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts FeaturedProduct gt bool isOnFeaturedProductPage false 3 9 Extending Orchard 327 Read the Docs Template Documentation Release 1 9 2 if CurrentContent null var itemTypeName CurrentContent ContentItem TypeDefinition Name if itemTypeName Equals Product StringComparison InvariantCultureIgnoreCase var dynamicContentItem dynamic CurrentContent ContentItem var itemProductId dynamicContentItem Product ProductId Value if itemProductId Equals SPROCKET9000 otringComparisSon lnvarzanctCulture 4 isOnFeaturedProductPage true return shapeHelper Parts FeaturedPr
77. In the document template the Head zone is used to define the header of the web page the Body zone is where the layout template is inserted and the Tail zone is used for the footer of the web page The following example shows a typical document template Gusting Orchard Myc Html using Orchard UI Resources RegisterLink new LinkEntry Type image x icon Rel shortcut icon Href Url Content modules orchard themes Content orchard ico Script Include html5 js AtLocation ResourceLocation Head var title Request Path Request ApplicationPath amp amp string IsNullOrWhiteSpace st Model Title WorkContext CurrentSite PageTitleSeparator D Y WorkContext CurrentSite SiteName j lt DOCTYPE html lt html lang en class static GHtml ClassForPage lt head gt lt meta charset utf 8 gt lt title gt title lt title gt Display Model Head x script gt function d d className dyn d className substring 6 d className length lt head gt lt body gt G Layout template is in the Body zone at the default position x Display Model Body Display Model Tail lt body gt So ACM This document template contains a code block that links to an icon and formats the page title It also contains the basic HTML structure for the web page and it determines placement of the Head Body and Tail zones The following example shows a typical layout template Notice t
78. Location USA Tags Orchard Harvest Separate multiple tags with commas W Show on a menu Main Menu Select which menu you want the content item to be displayed on Menu text Events The text that should appear in the menu Comments Show comments Enable to show the existing comments Allow new comments Enable to show the comment form Disabling still allows the existing comments to be shown but does not allow the conversatior Allow threaded comments Enable to allow users to answer directly to other comments Owner admin Publish Now o aT IE Looking at the Manage Content screen in the Orchard admin panel we can see our event item listed among the 3 1 Authoring Websites 0 MA Read the Docs Template Documentation Release 1 9 2 pages in the site Manage Event Content User admin Logout Actions Choose action EET Create New Event Show Event ordered by recently modified filter by latest i O First Event Event Q Published No Draft Published 2 minutes ago 0 comments Last modified 2 minutes ago By admin View Unpublish Clone Edit Delete On the site s front end notice the event has been added to the main menu as expected and that our fields and parts are being displayed correctly here as well It is possible to customize the way the event appears and template its rendering See Template File Syntax Guide for more informatio
79. Map Fields Latitude 47 622 769 Longitude 122 131491 Show on main menu Menu text Dinner On the front end of your site you can see the effect of the Map part rendering on the event content item 368 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 My Orchard Site About Us Our Blog Dinner Nerd Dinner Tonight Location Crossroads Food Court Date Tuesday August 3rd Tags nerds dinners Add a Comment Getting the Code The Map part described in this topic is available from here Orchard Module Maps 1 0 0 zip ready to install and use with full source code 3 9 8 Writing a Content Field This guide has been marked for review If you are just getting started with Orchard module development you should read the Getting Started with Modules course first It will introduce you to building modules with Orchard using Visual Studio Community a free edition of Visual Studio 3 9 Extending Orchard 369 Read the Docs Template Documentation Release 1 9 2 Fields can be used in Orchard to build new content types Orchard comes with a few built in field types such as text date or enumeration but it is possible to build your own field types that can then be used to build new content types This topic will teach you how to add such a new field type You can find the source code for this tutorial here http orcharddatetimefield codeplex com We will assume Visual Studio and a f
80. Module gallery management Depends ony Packaging commands Enabling Gallery will enable Packaging Commands and Packaging Documentation Upload screenshots 675 gallery enabled 675 png Enabling a feature such as Gallery will sometimes add additional menu items in the admin panel as shown in the previous image Orchard also provides a command line interface from which you can also list enable and disable features You can find the Orchard command line tool in the bin directory of the application and run it from the root of the website by typing bin orchard exe at the Windows command prompt To list available features type feature list or feature list Summary true at the command prompt 182 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 C inetpub orchardlatest gt bin orchard Initializing Orchard session This might take a few seconds Type for help exit to exit els to clear screen A orchard gt feature list Summaru true Common Enabled Contents Enabled ContentsLocation Enabled Dashboard Enabled Feeds Enabled Futures Widgets Enabled Gallery Disabled HomePage Enabled Localization Enabled Lucene Enabled Enable a feature from the command line by typing feature enable amp lt feature name amp gt forexam ple feature enable Gallery orchard gt feature enable Gallery Enabling features Gallery Gallery was enabled For more information ab
81. Open it and customize it as follows name HelloWorld antiforgery enabled author The Orchard Team website http orchardproject net version 0 5 0 orchardversion 1 8 1 description The Hello World module is greeting the world and not doing much more features HelloWorld Description A very simple module Category Sample 346 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 This text file is describing your module to the system The information contained in this file will be used for example in the features administration screen Note While both spaces and tabs are supported to indent the manifest file we recommend that you use spaces instead of tabs As with your main coding using spaces gives a more consistent editing experience when working in teams Adding the Route Your module will have to handle the HelloWorld relative URL under your Orchard web site In order to declare what to do when that URL gets hit create the following Routes cs file in the HelloWorld folder using System Collections Generic using System Web Mvc using System Web Routing using Orchard Mvc Routes namespace HelloWorld public class Routes IRouteProvider public void GetRoutes ICollection RouteDescriptor routes foreach var routeDescriptor in GetRoutes routes Add routeDescriptor public IEnumerable lt RouteDescriptor gt GetRoutes return new new RouteDescriptor Priority
82. Overlaying Mono Versions of Some Assemblies Orchard comes with a host of assemblies it depends upon both during compilation and the execution Two of those assemblies Microsoft Web Infrastructure dll and NHibernate dll have to be replaced because the versions shipped with Orchard will work only in the Microsoft NET environment The assemblies can be found in this archive which has to be unzipped in the directory where you unpacked your Orchard sources Compiling You must use MonoDevelop 2 6 or newer to compile on Orchard on Linux you can also use VisualStudio after performing the steps above since its earlier versions had a bug which would require you to edit assembly references in all of the Orchard projects Compilation using Mono s xbuild is also currently not possible because of missing features but we re working on it and soon you should be able to compile Orchard from command line You must make absolutely sure that the full Mono 2 10 1 or newer stack is installed all of the development files assemblies compilers have to be present on your system After opening the solution in MonoDevelop just type F8 or use the Build gt Build All menu option and after a while you should have Orchard compiled and ready to run Deploying Unfortunately at the time of this writing MonoDevelop will not deploy Orchard properly so you need to do it manually To do so copy contents of the src Orchard Web directory to your website root If you
83. Preview for the theme To apply an available theme to your site select Set Current for the theme For more details see Previewing and Applying a Theme and Installing Themes 68 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 euius Themes Installed Gallery Current Theme E Content Nurser Machins The Theme k Content Definition By Jowall mit Version 1 8 1 http orchan Orchard Them lena a ee NWavigalion Jags Modules in Themes i W Or all OW 5 Ava i la ble PJS Bootstrap a Dar el SS me EX x Palais m Oo a aI mE DOE zd wel Set Current By Philip semer Version 3 1 1 Description for the theme http philipsenechal com Enable Uninstall 15 Getting Started with Orchard gg Read the Docs Template Documentation Release 1 9 2 Getting Started with Orchard Home Signin Welcome to Orchard You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head over to manage themes to change or install new themes and really make it your own Once you re happy with a loo
84. ServiceContract public interface IService IDependency OperationContract string GetUserEmail string username Provide implementation 1 e Service IService What s in App Data The App Data folder is used to store various kinds of data Contents of App Data are never served The contents are organized this way File cache dat is a cache XML document describing what features are enabled for each tenant in the site This being only a cache modifying it may have unpredictable results File hrestart txt stands for Host Restart It is a file that is touched by the system to indicate a need to restart the application Folder Dependencies is used by dynamic compilation to store compiled dlls and has an XML file dependen cies xml that tracks how each module was compiled dynamically or not 484 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Folder Exports contains export XML files generated by the import export feature Folder Localization contains localization po files Folder Logs contains log files e Folder RecipeQueue is used during setup to queue the recipes to execute Folder Sites contains one folder per tenant The default tenant is in the Default folder which is all there is if no tenant was created Each folder contains the following mappings bin is a binary serialized cache of nHibernate mappings Orchard sdf is the SQL CE database file for the
85. StorageConnectionStri Connection String UseDevelopmentStorage true Orchard Azure OutputCache Hostldentifier String Orchard Azure Web Orchard Azure OutputCache CacheMame String OutputCache Orchard Azure QutputCache Hostname String rchard Azure OutputCache Port string s Orchard Azure QutputCache Authorization T Stri ng e Now to deploy the cloud service right click the Orchard Azure CloudService project in Solution Explorer and select Publish and follow the instructions in the publishing wizard to select subscription cloud service storage account and other publishing options How to use the Windows Azure publishing tools in Visual Studio is beyond the scope of this topic but they are pretty self explanatory Solution Explorer ii T i ft go pl T T Search Solution Explorer Ctrl 5 P o m aW Solution Orchard Azure 63 projects E P mag Modules a P fg Modules Deprecated zi E P B Orchard P ag Themes gt Bg Tools b si Orchard Azure Web Essentials T 2 aJ Build m in cscfg Rebuild def Clean Package E e Publish in Manage Configurations Configure Remote Desktop pen Command Prompt Once deployment has successfully completed browse to the newly deployed Orchard site and go through setup 3 5 Hosting and Deploying Websites 247 Read the Docs Template Documentation Release 1 9 2 Specify the connection string to the Windows Azure SQL Database you created ea
86. TIown Cityc label lt input id Lown cirty 7 gt SL lt li gt lt fieldset gt lt legend gt Is this address also your invoice address lt em gt lt em gt lt legend gt lt label gt lt input type radio name invoice address Yes lt label gt lt label gt lt input type radio name invoice address No label fieldset dE EP 94 fieldset Progressive Enhancements Base your designs on modern browsers that implement up to date patterns but without handicapping the experience of older browsers If you feel it is important to the design use known CSS techniques such as sliding door to achieve the desired effect Border radius Multiple background images Gradient 2 3 4 Transparency RGBA and opacity 5 Shadows 6 Text Shadows 478 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 3 11 9 Customizing Orchard Using Designer Helper Tools Orchard provides a designer tool named Shape Tracing that enables you to customize the appearance of your site The Shape Tracing module provides tools that you can use to select sections of your website and discover information about the rendering code Getting Started with Shape Tracing To use Shape Tracing first enable the Shape Tracing feature in the dashboard The Shape Tracing feature comes with the Designer Tools module that you may have to install After you enable the feature you will notice a narrow f
87. Template Documentation Release 1 9 2 When in the admin UI we build shapes with a statically typed view model because these are still easier to use when using form fields and MVC model binding That view model like the shape used on the front end has a flattened view of the data that we need to display but it also has a full list of all the available states that the view will use to render the state drop down list using System Collections Generic using RelationSample Models namespace RelationSample ViewModels public class EditAddressViewModel public string Address get set public string City get set public string StateCode get set public string StateName get set public string Zip get set public IEnumerable StateRecord States get set The last thing to notice in the driver is that the Editor override that handles postbacks is just using updater TryUpdat eModel which is enough to incorporate the submitted form values onto the view model This is followed by a call into the address service class which will update the actual content part data with the updated model The Address Service Class The address service class takes a dependency on the state repository in order to be able to query for the full list of states Its other method UpdateAddressForContent Item copies an EditAddress ViewModel onto the address content part of a content item It does so by looking up a state record from
88. This won t work because the cloud service load balancer has no session affinity so users will lose their state when moving between instances Luckily Orchard has features to overcome each of these complications but you must configure and enable them Preparing for multiple instances First off configure the number of instances you want to use in the cloud service project In Solution Explorer navigate to Orchard Azure CloudService project double click the Orchard Azure Web role and navigate to the Configuration tab Change the nstance count value from 1 to some higher number 248 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Orchard Azure Web Role 4 X Configuration Service Configuration All Configurations v n Settings Endpoints Instances Local Storage Instance count Certificates VM size Small v Q9 Learn about setting the VM size Caching Startup action Launch browser for HTTP endpoint HTTPS endpoint NOTE You can also leave the instance count at 1 and change it after deployment through the Windows Azure management portal Problem 1 in the list above we will deal with by enable the Windows Azure Media Storage feature later To prepare for this configure the storage accounts to use for shell settings and media storage To do this navigate to the Settings tab Change the following settings to the storage account connection strings you want to use You can use the same sto
89. a given keyword are accessible via a front end tags tag name URL The browser navigates to the URL for a particular tag when that tag is selected by the user hittp localhost42861 Tags Orchard My Orchard Site Home Getting Started Contents tagged with orchard Welcome to Orchard Tags orchard an 4 2011 2 27 PM 0 Comment You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you c Once you feel confident you don t more Getting Started Tags Map News orchard Jan 4 2011 2 29 PM 0 Comments To begin open more Powered by Orchard The Theme Machine 2010 Sign In To edit the global list of tags in your site go to the Manage Tags screen in the Orchard dashboard by selecting Tags from the navigation section 98 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Tags Here you can edit the tag keywords and remove tags When you remove a tag it is removed from all content items that share that tag When you edit a tag it updates all content items with that tag to the new keyword You can also collapse tags by renaming a tag to the same name as another tag This is useful for cleaning up your tags so that they are consistent throughout your site Tags Actions Choose action Y Name Map Edit Delete News Edit Delete Development Edit Delete Orchard Edit Delete Clicking on a tag keyword in this scree
90. able to publish the event immediately on a schedule or as a draft PublishLater part Also add the Common part so that your items can appear in lists of content items 136 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Choose the Parts to add to this Content Type Admin Menu Adds a menu item to the Admin menu that links to this content item Audio Provides common metadata for an Audio Media Autoroute Adds advanced url configuration options to your content type to completely customize the url pattern for a content item Body Allows the editing of text using an editor provided by the configured flavor e g html text markdown v Comments Allows content items to be commented on Containable Allows your content item to be contained by a content item that has the ContainerPart attached Container Turns your content item into a container that is capable of containing content items that have the ContainablePart attached Disable Theme When attached to a content type disables the theme when a content item of this type is displayed Document Provides common metadata for a Document Media Identity Automatically generates a unique identity for the content item which is required in import export scenarios where one conte Image Provides common metadata for an Image Media Java Script Anti Spam Prevents spambots to post the editor by requiring JavaScript suppor
91. add the BaseTheme field to the manifest for the customized theme and specify the Id of the base theme For example if you customized the Contoso theme you could add the line BaseTheme Orchard Theme Contoso to the manifest of your theme The following example shows the manifest for The Theme Machine theme which is the default Orchard theme Name The Theme Machine Author jowall mibach loudej heskew Description Orchard Theme Machine is a flexible multi zone theme that provides a solid foi Version 1 9 1 lags Awesome Website http orchardproject net Zones Header Navigation Featured BeforeMain AsideFirst Messages BeforeContent Cont For more information about how to write a theme including how to generate and modify a manifest see Writing a New Theme For information about how to customize an existing theme and then generate a manifest for it see Customizing Themes 3 9 13 Caching Here are the different levels of caching that Orchard can provide Application Settings Cache Using ICacheManager This is used to store application settings and can be invalidated based on an extensible set of parameters By default you find expiration tokens based on time file system and signals This is a very powerful caching API but has one drawback it is not meant to provide farm invalidation because it has not been designed for this purpose and should not be used for data which is volatile Using for settings is totally fine li
92. administrator chooses to enable or update the part The update methods provide a history of changes to the database schema When an update is available the site administrator can choose to run the update You can create a data migration class by running the following command from the Orchard command line codegen datamigration lt feature_name gt 428 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 This command creates a Migrations cs file in the root of the feature A Create method is automatically created in the migration class In the Create method you use the SchemaBuilder class to create the database table as shown below for the MapPart feature In the Uninstall method you can implement destructive operations that will be executed when the module is uninstalled Keep in mind that when a module is re added and enabled after it was uninstalled it will be installed again thus the Create method of migrations will also run namespace Map DataMigrations public class Migrations DataMigrationImpl public int Create Creating table MapRecord SchemaBuilder CreateTable MapRecord table gt table Content Part Record Corum Latritude DbType Double SCO tumn Longitude DbType Double ContentDefinitionManager AlterPartDefinition typeof MapPart Name cfg gt cfg Attachable return ds publice void Uninstall J 4 Dropping tables can potentially cause data los
93. all xsp4 Using Binary Version of Orchard Currently Orchard needs to be patched in order to run on Mono with PostgreSQL database so for your convenience a precompiled version is available All you need to do is to download the archive create a directory on your server in which you want to put the application and unzip the archive in that directory locations used here are samples which would work without changing on a machine running OpenSuSE 11 4 sudo i mkdir p srv www vhosts orchard demo cd tmp wget http dl dropbox com u 22037 511 orchard orchard 1 0 20 mono bin zip cd srv www vhosts orchard demo nzip ytmp orchard 1 0 20 mono bin zip Compiling Orchard from Source We will use the current as of March 11 2011 version of Orchard sources 1 0 20 After downloading and unzipping them in a directory of your choice you need to perform the steps outlined below in before compiling the application 3 8 Using Windows Azure Cache 257 Read the Docs Template Documentation Release 1 9 2 Patching the Source Ideally in the future Orchard will not need to be patched in order to work under Mono but for the moment you need to download two little patches and apply them to the source Unzip the archive in the directory where you unpacked the Orchard sources and issue the following commands Patch p1 lt 01 oschard 1 0 mono support patch patch pl lt 02 X orchatd 1 0 postgresgl subpport pabch And Orchard is patched
94. and updated itself The same code is run no matter where you embed the widget This time we will expand the widget so that it is aware of it s surroundings When the page loads and the widget is asked to display it will inspect the page as a whole figure out what type of page it is on and then if applicable drill down to see what specific product page it s on This information will then be passed through to the view so that we can change the display on the fly Setting up a ContentType to work with The admin dashboard is quite powerful If you have been using Orchard for long you ll likely have set up your own content types within the Content Definition section of the admin dashboard Content amp Content Definition zT B plog This section allows you to combine pre existing content parts together to form a custom content type that can be displayed in your site 314 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 It also has a section called Fields When there isn t a content part that quite fits your needs you can turn to the Fields to add extra pieces of data to the content type on the fly We are going to quickly build a Product content type which has some of the common core content parts a title a URL a menu entry and some body text We will also add in single text field called Product Id to detect which particular product is being viewed 1 Navigate to the admin dashboard o
95. and work with the repository The easiest way to get started with GitHub is to use Github Desktop This software has a built in tutorial which will teach you the basics when you first install it You can also create a fork via the GitHub website GitHub have provided a guide explaining how to fork a repo GitHub is powered by Git If you re an advanced user with experience of using Git on the command line then you can interact with GitHub hosted repositories as you normally would If you re interested in learning then GitHub have their own interactive code school and the entire Pro Git book is available has also been made available by it s authors and is endorsed by the official Git website Working on an issue By now you should have agreed with the community which issue you re working on you should know which branch you re targeting and you should have created your own fork When working on an issue you should create a branch in your local clone per issue This branch isolates your changes from the master branch You can merge this new branch back in to the main codebase later on with a pull request Please work on only one issue per branch pull request Please follow the code conventions document when writing new code for Orchard 510 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Once you ve made your changes you need to publish your local commits back to the remote fork in your GitHub account The basi
96. appears for enabling the feature Leave the feature enabled for this tutorial Geolocation Bing Maps Now you can add a new content part a Bing Map part which is included in the disabled Bing Maps feature to the page content type On the dashboard click Content and then click the Content Types tab Find the Page content type and then click Edit next to the type In the Edit Content Type screen click Add Parts in the Parts section The Add Parts to Page screen is displayed Add Parts To Pag e User admin Logout oO Admin Menu WI Bing Map Comments Containable Container I Custom Properties Identity Select the Bing Map content part from the list of available parts and then save the updated page content type Now you can see the effect of adding the Bing Maps content part to the page type On the dashboard in the New menu click Page to create a new page Because you installed the Bing Maps module enabled the feature and added the Bing Map content part to the page when you create a new page instance a number of map related fields appear 192 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Create Page User admin Logout Title Permalink http localhast 53425 Set as home page Body 38 5 X Ga d z 2 B T 35 5 Format ES Bing Maps Latitude g Longitude 0 Width 0 Height Mode Road Tags
97. as well upload dynamic forms subscribe form png At this point we have all the pieces we need to create out new widget in the right rail AsideSecond zone We ve enabled the Dynamic Forms module and we ve created a new content type Subscribe Form that will be used to capture the email address of visitors looking to enroll in the mailing list All that s left is to create the Widget Create a Form Widget Select Widgets in the left menu of the admin and find the appropriate Add button for the AsideSecond zone and add a Form Widget upload dynamic forms subscribe form png The only thing left to do is to adjust the settings on our new Form Widget In this example the layer is set to Default and the position is set to 1 This will render the widget on the top of the right rail AsideSecond zone for all pages In the Layout section of the form you need to add your form fields and bind it to your content type In the layout section see highlighted below edit the form by dragging an Email Field field from the Layout items on the right side of the screen 3 4 Managing Websites 231 Read the Docs Template Documentation Release 1 9 2 upload dynamic forms edit layout png Once it is dropped an Edit Email Field will pop up Enter the value as shown in the screenshot below upload dynamic forms edit email field png Then click on the Validation tab and make sure to check the Required checkbox
98. as the 99 full resolution but prefixed with s The typical markup to include an image is as follows Caption for my image Attachments Name Of Topic NameOfImage png If the image is a link to a higher resolution the link and image syntaxes must be combined 3 14 Getting Involved 507 Read the Docs Template Documentation Release 1 9 2 Caption Attachments Topic NameOflImage png imgl imgl Attachments Topic NameOfImage png Acceptable image formats are PNG JPG and GIF Images should be reasonably compressed Avoid JPG for screen shots and reserve it for photos Links References to other topics on this wiki can be made using Text for the link Topic Name Or Text for the link refl refl Topic Name Links to external content can be added using Text for the link http somesite somepage Or Text for the link refl refl http somesite somepage If you are using the reference syntax the references may be grouped at the end of the document separating the link itself from the reference definition Do use links to specific sections of a document where relevant see the structure section structure structure Structure Capitalization In topic titles and in section headings use title style capitalization as opposed to sentence style When referring to UI elements follow the capitalization style used in the UI elements themselves Tables Tables should be built
99. blog posts 450 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Wrapper Added in v1 1 Use wrapper from Place elements to wrap an extra shape around the original shape Similarly you can provide a wrapper as part of the placement Header after Wrapper Wrapper_GreenDiv Using a wrapper enables wrapping content with a cshtml markup Here is a 3 step example showing how to add a div around the Html Widget to enable css styling of the widget In placement info Match ContentType Widget Place Parts Common Body 2 Content 5 Wrapper Wrapper HtmlContent gt lt Match gt If you just put the wrapper without specifying Content 5 the body part will not show up By adding Content 5 it specifies which zone to render the part in After modifying your placement info the Shape Tracing module Shape tab will show your wrapper location at the bottom It will be Themes yourTheme Views Wrapper HtmlContent cshtml Create this file and put the following text in it lt div class htmlWrapperContent aModel Html x div gt This will enable you to target the wrapper from site css like this htmlWrapperContent background color 94CCE7 Shape Added in v1 1 Use shape from Place elements to rename the shape For example Place Parts _Common_Body Content 5 Header after Shape IPreferToCallThoseStickersForSomeReason gt Match Element Match elements let
100. branching and merging that has been going on on the server You can examine each change read its description and view diffs You can also right click a change and update your local repository to it by clicking Checkout revision 490 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 File Git Commands Remotes Github Submodules Plugins Settings Help Bi iy Branches origin master Burts i ese ee 19976 Implementing import export f Sipke Schoorstra 19965 Implementing import export f Sebastien Ros amp Fetch all Moving the tip Bertrand Le Roy Don t set as default 19910 Including the field name as pa Sipke Schoorstra 5 days ago Commit Author i j ti of g Date 3 hours ago Mo rx 05 17 01 02 201 13 Commit hash 5e0c26f7 3cf5052c51db835bec7 0f701f4246165 Children ace 100d40f Parentis 1 2ea4064b Updating ignore files for git You can also filter by branch which is useful for example if you re only interested in the more stable master branch Development work is done in both the 1 9 x and dev branches Viewing the Source Code Without Enlisting If you don t want to use Git you can still download the source code for the project You can download a zip file of the source code but this means you don t get the advantages of being able to easily clone and update Branches Learn more about the branches on the contributing patches page 3 12 3 Source Code Organization This s
101. by including a template in their Views tems folder The name of the template should be Content content type name cshtml or Content content type name display type cshtml For example a template that overrides how blog posts are rendered should be Views tems Content BlogPost cshtml and a template that overrides the summary rendering of a blog post should be Views V tems Content BlogPost Summary cshtml Part Templates Themes can override the rendering of content parts The convention is similar to the convention for content item templates The template for a part must be in Views Parts and must be named for the shape for the part For example the rendering for comments can be overridden by creating the file Views Parts Comments cshtml Field Templates Field rendering can be overridden as well although not yet at the field instance level In other words you can override what a text field looks like but not what a specific text field looks like To override a field template create a field type name cshtml or field type name display type cshtml file in Views Fields For example the rendering of text fields can be overridden by a Views Fields Common Text cshtml template Alternates Alternates are a set of related shapes with corresponding templates or layout files that enable you to control how different types of content are rendered within a theme For example you can use alternates to apply one layout file for the home p
102. can be created as extensions to Orchard for example CheckBoxField EmailField TextAreaField DateTimeField etc and a number of additional fields are available under Gallery gt Modules as optional downloads Type Location for the name of the field and click Save 134 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Add New Field To Event Display Name Location Name of the field as it will be displayed in screens Technical Name Location Technical name of the field Field Type Text Field Save 3 1 Authoring Websites 135 Read the Docs Template Documentation Release 1 9 2 Fields v Location Text Field Display options Small T Ww Required Check to ensure the user enters a value in this field Help text The help text is written under the field when authors are editing the content item The field is now listed in the Event type screen Fields gt Location TextField Go ahead and repeat the previous two steps to add a second field named Date To add a part to your type click Add in the Parts section of the Event type Here you can see the available parts in Orchard as of the current release For our Event type we want to be able to comment on the event Comments part tag the event Tags part access the event from the front end via a URL route Autoroute part add the event to the main menu Menu part and be
103. details see Installing and Upgrading Modules and Registering additional gallery feeds Individual modules can expose features that can be independently enabled or disabled To view the features exposed by the built in modules in Orchard click the Features tab in the Modules screen 15 Getting Started with Orchard 7 Read the Docs Template Documentation Release 1 9 2 Modules Features Installed Recipes Gallery Filter Actions Choose action Content Alias Disable Alias UI Enable Maps friendly urls to specific module actions Admin user interface for Orchard Alias Depends on Alias Autoroute Disable Blogs Disable Enables the Autoroute part for tokenized routing A simple web log Depends on Alias Tokens Depends on Autoroute Common Feeds jQuery Navigation Publish Later Shapes Content Control Wrapper Disable Content Localization Enable Add an Edit button on the front end for authenticated users Enables localization of content items Depends on Contents Depends on Settings Date Time Format Localization Enable Feeds Tokens Enable Enables localization of date time formats and names of days and months Provides a content part to customize RSS fields based on tokens Depends on Feeds Tokens Lists Enable Pages Disable A basic container enabled content type A basic page content type Depends on Autoroute Containers Contents Navigation Orchard ContentPicker Depends on Contents Orchard ContentPicker
104. ensure that URLs are unqiue for each translation You can then translate the content item from the default site culture to the selected culture 3 1 Authoring Websites 123 Read the Docs Template Documentation Release 1 9 2 Translate Content desertis Dunt Title Download Permalink http localhost53425 download fr FR Set as home page Content Localization This is the FRE variation of Download Body d tel X GAl E 0 B Z i Format emm E This is the download page for my Orchard site Add some translation text in the body of the page and then click Save After the content item is saved the current culture code is indicated along with links to any related content items in different cultures When you browse content items on the site if there are translations available for a content item links to those content items will be displayed This makes it easy for your site visitors to switch between translations of the item This is what the site looks like when you view the English en US item Orchard Playground Home Donnas Our Bog Edt Downloesd Taye cowmiosd Orchard This is the download page for my Orchard site Click the culture code link to see translated version of the page When you do the original cultural code en US appears as a link to the original page 124 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Orchard Playground Home Downlo
105. expandable section can be collapsed to show only the section title If you click a section title the first feature in that section is selected This list changes as you enable and disable Orchard features For example the Blog section will have a set of additional collapsible items under it as shown after you actually create a blog The New section allows you to create new instances of default content types as well as any custom content types that you define The right side of the page displays the settings that are available for the selected feature The following image shows the contents of the dashboard Attachments Getting Around The Dashboard Dashboard png 1 4 1 Feature Settings Available in the Dashboard The following table shows each of the dashboard sections and briefly describes the available settings Section Title Description Dashboard Contains the dashboard and displays the main Welcome to Orchard page This page contains a number of helpful links for working with Orchard The page also shows the Orchard version that is running and displays advisories from http orchardproject net when advisories are available that can notify you when a new version is available or when an important update needs to be applied New Lets you create new instances of default content types or of custom content types that you define in the Content Definition screen For more information see Creating Custom
106. first install and enable the feature The easiest way to do this is to go to Modules in the admin UI and then click the Gallery tab Do a search for code generation and then install the module To enable code generation if you didn t do so right after install you may enter the following command in the command window feature enable Orchard CodeGeneration You will use a code generation command to create a commerce module Enter the following command codegen module SimpleCommerce Open a Windows Explorer window and browse to the newly created Vnet pub wwwroot Orchard Modules SimpleCommerce folder Open the module txt file using a text editor Change the description to A simple commerce module Change the description of the feature to be A simple product part Save the file and close it The following example shows the complete module txt file after the changes Name SimpleCommerce AntiForgery enabled Author The Orchard Team Website http orchardproject net Version 0 5 0 OrchardVersion 0 5 0 Description A simple commerce module Features SimpleCommerce Name Simple Commerce Description A simple product part Category Commerce Creating the Model for the Part Next you will create a data model that is a representation of what will be stored in the database In Modules SimpleCommerce Models create a Product cs file and add the following content using System ComponentModel DataAnnotations using Orc
107. get to the Log On page In the sidebar for the site click the link to Register Now 3 3 Using the Orchard Gallery 169 Read the Docs Template Documentation Release 1 9 2 Dont have an account yet X Register now Log On Username Password Signin Lost your Password On the account registration page specify your account details my Parme ms With your account you ll be able to achieve all kinds of fame and glory by rating and reviewing modules and themes as well as submitting your own Already have an account Sign in 170 Create A New Account Usemame bradmi Email bradmi hotmail com Password LELEL ELETE EEE Confirm password 2s055p25255B2205B22258 Upon submitting this form you will receive a notification that email has been sent to you Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Email Sent An email has been sent to you Please click on the link it contains in order to have access on this site Click the verification link in the email in order to activate your account Verification E Mail Back to messages 4 4 5 Orchard Gallery Add to contacts 6 15 AM To bradmi hotmail com Reply Thank you for registering with Orchard Gallery Final Step To verify that you own this e mail address please click the following link hitp orchardproject net galleryUsers Account ChallengeE mai S ae 7 ee
108. grow and the satellite assembly design wasn t built for that kind of usage On the other hand po files can be loaded and unloaded on demand Like resx files po files are a standard format for which many tools exist Installing translation files As an example download a set of po translation files for French fr FR Browse to the page for the files at the following URL https crowdin net download project orchard cms fr zip Click the link to download the po files and save the zip file to your computer 3 1 Authoring Websites 115 Read the Docs Template Documentation Release 1 9 2 Method 1 Extracting the zip Extract the downloaded zip file into the root folder of your website Make sure you extract the contents to the actual Orchard root folder and not to a subfolder named for the zip file When Windows opens a Confirm Folder Replace window and asks whether you want to merge the extracted contents into the Orchard folders of the same names in your website select Do this for all current items and then click Yes to merge in the translation files This method of extracting the po files by expanding the zip file into your site s directory is very simple but if your site does not have all the translated modules that are in the file you may end up with some additional directories that you don t need In order to avoid that you can use the following alternative method Method 2 Using Translation Manager The Translatio
109. gt 3 4 10 Workflows This topic targets and was tested with the Orchard 1 8 release The Orchard Workflows Module in Orchard provides us tools to create custom workflows for events or activities like Content Created Content Published Content Removed Send Email Timer and many more Dependencies Orchard Tokens Orchard Forms Orchard jQuery Upload workflows workflowsmodule png In this particular demo we l be creating a Contact us Email Notification Workflow The Or chard EmailMessaging Module needs to be enabled in order to send email notifications using the Or chard Workflows Module 222 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Upload workflows emailmodule png O n O 3 Q 3 Learn how to Creating Custom Content Types Learn how to Create Custom Forms Upload workflows contactform png Workflows Demo 1 Creating Workflow Upload workflows createnewworkflow png 2 Contact Us Email Notification Workflow Upload workflows contactnotification png 3 Editing Contact Us Email Notification Workflow Upload workflows workflowcreated png 4 Workflow Starting State The workflow needs at least one activity to be set as a starting state 3 4 Managing Websites 223 Read the Docs Template Documentation Release 1 9 2 Upload workflows workflowstartingstate png 5 Editing Workflow Activity Form Submitted Upload workflows editingworkflowactivity png
110. h2 5 This file is specifying the core contents of our view All the chrome around it will get added by the current theme s default layout Notice that we used the T helper function that makes this view ready to be localized This is not mandatory but it s a nice touch Adding the new files to the project We re almost done The only task remaining is to declare to the system the set of files in the module for dynamic compilation Open the HelloWorld csproj file in a text editor and add the following lines after one of the amp lt ItemGroup amp gt tags lt I LemGEoup gt lt Compile Include Routes cs compile Inolude ControllersVXHomeController cs 5 lt ItemGroup gt Also add the following to the ItemGroup section that already has other Content tags Content Include Views Home HelloWorld cshtml gt Activate the Module Finally you need to activate your new module In the command line type feature enable HelloWorld You could also have done this from the Features screen in the site s admin UI 348 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Use the Module You may now add HelloWorld to the URL of your Orchard site in your favorite web browser and obtain a nice Hello World message Documentati n Attachments Building a hello world module HelloWorld png Conclusion In this tutorial we have built a very simple module that handles a route HelloWo
111. has been updated for the Orchard 1 9 release Data access in an Orchard project is different than data access in a traditional web application because the data model is built through code rather than through a database management system You define your data properties in code and the Orchard framework builds the database components to persist the data If you need to change the data structure you write code that specifies the changes and those changes are then propagated by that code to the database system This code centric model includes layers of abstraction that permit you to reuse components in different content types and to add or change behaviors without breaking other layers The key concepts of data access are the following e Records e Data migrations Content handlers e Content drivers 3 10 Working with Data 427 Read the Docs Template Documentation Release 1 9 2 Records A record is a class that represents the database schema for a content part To create a record you define a class that derives from ContentPartRecord and add the properties that you need in order to store data for the content part Each property must be virtual For example a Map part might include the following record namespace Map Models public class MapRecord ContentPartRecord public virtual double Latitude get set public virtual double Longitude get set Typically the record class resides in a folder named Models The pare
112. have plans to address this in a future update to the gallery website see About the Orchard Gallery Project below For now we recommend that you search for the name of the package without the version number in order to list all versions of a given package before selecting one to download 168 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 About the Orchard Gallery Project The gallery website and related feed implementation are being developed as an open source project under the same New BSD license and contribution terms as Orchard itself and the source code is available to you on Or chardGallery CodePlex com and GalleryServer CodePlex com The open source gallery project is meant to provide a reference implementation for exposing a gallery feed and website and can be used to set up your own gallery site For example the NuGet org website uses this gallery implementation too The gallery project is a work in progress and there are a number of improvements we will be making to the gallery over time In the near future we are planning to implement these features Reviews and ratings Collapse all versions of a package under a single details page Display aggregate rating and download stats across all versions of a package Better management and submission interface for package submitters If you want to log a bug or submit a patch for the gallery website or if you have a great feature sugges
113. i eee ee ep Rm CEPIT el ina is Sia tial o mm nis ml Ppi nLr uni h ass Gua cou by adding a page rre a blog pr rere ee meo May Dried ust be ged te be oed E conor eh ac EPA Dosen um b diei paa h ns e ped inal oda prs ja Forni ya m im nm ki e mid heres vna cpm 60 120 ny oe pesgr mem rei rar diy a sna cn fait Bre ban erae Ec eg coppa by eiat ngon C ec er Ua qug ie 8 iron TH a Rr piede Cen ecd Dun cce a Ti Tod Tris 3 11 Creating Themes 437 Read the Docs Template Documentation Release 1 9 2 Applying a New Theme To apply a theme in the Dashboard click Themes Under Available select the new theme and then click Set Current 438 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Themes User admin Logout Installed Gallery Updates 0 Current Theme Theme Machine The Theme Machine By jowall mibach loudej heskew i A Version 1 0 20 ee http orchardproject net coe Pao UIS aene Orchard Theme Machine is a flexible multi zone theme re that provides a solid foundation to build your site It eS features 20 collapsible widget zones and is flexible lu enough ta cover a wide range of layouts Available Install a theme from my computer iE MyFirstTheme n Wieltoma t Orchard Tam ea e hok p aa a ea r a a If lll bes m ee Prap cen re Fiya leeh ri br paar eee eee T RRA you des oie eC Oui CM re Tid Es ice E G cod mu mp mgr kih aha me EGG Pau fep depo rud pri acra e
114. in C or Visual Basic into web page markup Like server code in other ASP NET web applications the server code that you embed in a web page using the Razor syntax runs on the server before the page is sent to the browser The server code in ASP NET web pages can dynamically generate client content such as HTML markup CSS or JavaScript and then send it to the browser along with any static HTML that the page contains The most commonly used language for writing server code with the Razor syntax is C and the examples in this article are all written in C For an introduction to web page programming using the Razor syntax with C see Coding with the Razor Syntax For a Visual Basic version of the introduction see ASP NET Web Pages Visual Basic Web pages that contain Razor content have a special file extension cshtml for C vbhtml for Visual Basic The Microsoft feature name for these pages is ASP NET Web Pages with Razor Syntax These pages contain the full functionality of the ASP NET MVC page framework with the added capability of the Razor syntax for writing page templates The server recognizes these file extensions runs the code that s marked with Razor syntax and sends the resulting page to the browser 3 11 Creating Themes 463 Read the Docs Template Documentation Release 1 9 2 Experimenting with Razor Syntax If you want to experiment with Razor syntax you might want to start with WebMatrix WebMatrix is a free program m
115. in the Orchard UI Will be overridden by the FeatureDescription field when present Dependencies Required if the feature has dependencies If all features are defined in the Features subsection this field is not required A comma separated list of the application Id values of all features that the specified feature depends on Note dependencies are case sensitive Category OptionalDefaults to uncategorized This field groups the module together in the Modules page of the Orchard admin dashboard Related modules which have the same category are displayed together The category field can be assigned one category To aid in discoverability module developers should review the Modules page of the Orchard admin dashboard and choose a related category from existing categories If a relevant category doesn t exist modules can freely define a new category within this field Tags OptionalA comma separated lists of tags for the module The tags field allow users to find related modules in the Orchard Gallery FeatureDescription OptionalA description of the default feature in a module If the module has only a single feature use either the FeatureDescription or Description field to describe it The FeatureDescription will override the Description field If the module has multiple features and one of the features is the default use the FeatureDescription field to describe the default feature The FeatureDescription will override the Description field If the module h
116. indexing has indexed our Location field and our event appears in search results as expected 144 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Home Orchard CMS Scheduled Page Events Search Search USA Search First Event Tags Orchard Harvest Location USA There is one result This concludes the tutorial on custom content types If you are interested in delving further check out the related tutorials on this site for how to build a custom type field or part using code Change History Updates for Orchard 1 8 9 6 14 Updated all screen shots for creating custom content type 3 2 Customizing Websites 3 2 1 Previewing and Applying a Theme Orchard provides a powerful but simple theming system for customizing the look and feel of your site Orchard includes one theme in the default installation to help you get started Managing Themes To manage themes click Themes in the dashboard 3 2 Customizing Websites 145 Read the Docs Template Documentation Release 1 9 2 Themes User admin Logout Installed Gallery Updates Current Theme Macer The Theme Machine i By jowall mibach loude heskew Version 1 0 20 httpi archardpraoject net Orchard Theme Machine is a flexible multi zone theme that provides a solid foundation to build your site t features 20 collapsible widget zones and is flexible enough to cover a wide range of layouts Available Install a
117. into the modules directory at src Orchard Web Modules 4 Run Orchard by pressing Ct r1 F5 go to the admin dashboard select Modules from the navigation menu and enable the module Now we can begin the lesson by starting to build in database functionality to the Featured Product module Add a ContentPartRecord class In the first part of this course we created a simple ContentPart class called FeaturedProductPart Because we weren t storing anything at the time this class was just an empty placeholder We are going to go back and give it a property to store some data in the next section but first we need to create a ContentPartRecord class The ContentPartRecord class is used by Orchard to store content part data in a database Let s add the class to the module and then start wiring in the Boolean IsOnSale property 1 Locate your FeaturedProduct module in the Solution Explorer Right click on the Models folder and choose Add Class 2 In the Add New Item dialog enter FeaturedProductPartRecord in to the Name field and press Add 3 Derive the class from ContentPartRecord 3 9 Extending Orchard 303 Read the Docs Template Documentation Release 1 9 2 public class FeaturedProductPartRecord ContentPartRecord 4 Add the namespace by pressing Ct r1 J i 49 E public class FeaturedProductPartRecord ContentPartRecord g 16 using Orchard ContentManagement Records 11 Change ContentPartRecord to ContentManage
118. is a living thing If you make more commits to your branch and push them to your GitHub account they will be automatically included in the pull request This is useful if somebody gives you feedback suggesting changes but it also means that you shouldn t delete the branch until after the pull request has been accepted or declined You will get a notification when there is any activity on your pull request When you are on GitHub com you will see your notification icon light up with a little blue dot Oo This repository Pull requests Issues Gist nz Qa Unless you have turned email notifications off you will also receive an email from GitHub You can check on your pull request at any time by navigating to it through one of several ways in GitHub Click the Pull requests menu option in the top of the GitHub com website Pull requests Issues e Navigate to the OrchardDocs repo and click Pull requests down the side menu 3 14 Getting Involved 515 Read the Docs Template Documentation Release 1 9 2 lt gt Code D Issues 12 Wiki Pull request review process The Orchard development team meets every week to review pull request and triage issues During this meeting the team will decide if the pull request fulfills the prerequisites or comment if any improvements should be applied If an agreement is reached to accept the pull request then it will be marked as so and someone with commit rights on the main repository will acc
119. it With DotNest you can try out Orchard very simply very quickly and since your website is already hosted for you you can also show it to everybody Apart from getting used to the user interface and features of Orchard you can also get into the basics of Orchard theme development with it and style and customize your Orchard website in a lot of ways Convenience does come with disadvantages due to the architecture of DotNest you can t install custom modules so you have to use what is already available that however should be enough for a big part of websites 15 Getting Started with Orchard a Read the Docs Template Documentation Release 1 9 2 DOTNEST MY TENANTS ABOUT PRICING KNOWLEDGE BASE BLOG What is DotNest Edi DotNest is a SaaS provider that gives hosted Orchard CMS web applications think Wordpress com for Orchard This basically means that after registration you can create Orchard websites on DotNest without having to worry about hosting or maintenance Orchard is always kept up to date and in good working order for you you just have to use it Want to know who are behind DotNest DotNest sites are part of a multi tenant environment While this enables us to provide you such a flexible service it also adds some limitations on what you can do from your site Also see how DotNest works Are you interested in the core technology behind DotNest Check out the Lombiq Hosting Suite 1 What is DotNest 2 Click New Tenan
120. lt email gt Creates a new User The available commands depends on the features that are currently enabled for your site To list the features that you can enable or disable type feature list or feature list Summary true You can enable additional features and thus additional commands by typing feature enable amp lt feature name amp gt at the command prompt ercharad gt feature List 7Stmmary crue Common Enabled Containers Enabled Contents Enabled Dashboard Enabled DatabaseUpdate Disabled Feeds Enabled Gallery Enabled HomePage Enabled Lucene Disabled Navigation Enabled Orchard ArchiveLater Disabled Orchard Blogs Enabled Orchard Blogs RemotePublishing Disabled Orchard CodeGeneration Enabled Orchard Comments Enabled Orchard ContentTypes Enabled Orchartd Emall Disabled Orchard Experimental Disabled Orchard Experimental TestingLists Disabled Orchard Experimental WebCommandLine Disabled Orchard Indexing Disabled Orchard jQuery Enabled Orchard Lists Enabled Orchard Localizatron Disabled Orchard Media Enabled Orchard Messaging Disabled Orchard Migrations Disabled Orchard Modules Enabled 3 4 Managing Websites 185 Read the Docs Template Documentation Release 1 9 2 Orchard MultiTenancy Disabled Orchard Packaging Enabled Orchard Pages Enabled Orchard PublishLater Enabled Orchard Roles Enabled Orchard Scripting Enabled Orchard Scriplring Dir Disabled Orchard Scripting Ligh
121. map The Editor method marked GET is used to display the shape result in editing view for user input The Editor method marked POST is used to redisplay the editor view using the values provided by the user These methods use different overloads of the Editor method For more information about how to define shapes see Accessing and Rendering Shapes The following example shows a simple template that is used to display the map lt img alt 2 Location border 1 src http maps google com maps api staticmap amp zoom 14 amp size 256x2560 amp maptype satellite amp markers color blue Model Latitude G8Model Longitude amp sensor false This example shows an img element in which the src attribute contains a URL and a set of parameters passed as query string values In this query string Model1 represents the shape that was passed into the template There fore GModel Latitude is the Latitude property of the shape and Model Longitude is the Longitude property of the shape The following example shows the template for the editor This template enables the user to enter values for latitude and longitude model Maps Models MapPart lt fieldset gt lt legend gt Map Fields lt legend gt div class editor label aHtml LabelFor model model Longitude lt div gt div oclass edrtor field Html TextBoxFor model gt model Latitude Html ValidationMessageFor model gt model Latitude lt div gt
122. modify the module or install it in an Orchard site 190 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Contact Form Version 0 9 3 Install Download This module allows you to create one or more Contact Pages alternatively you can assign a ContactForm as a content part or widget to an arbitrary page In all cases the posted request will be shown in the admin panel under the Contact Requests menu item and you may optionally designate an email address to be sent the contact request as well if you have the Email madule configured 0 9 2 is a minor update to the previous version improving the output of the email to the admin to include info entered by the user on the form 0 9 3 is minor update which fixes some reported bugs where form data was not being validated Last Updated 3 17 2011 5 11 23 AM Author CyberStride LLC Downloads 1312 Website http cyberstride net Rating WHr tr r Installing a Module from your Local Computer To install a module from your local computer to an Orchard site go to the Modules Installed tab and then click the link to Install a module from your computer Modules User admin Logout Features Installed Gallery Updates 0 Archive Later Version 1 0 20 The ArchiveL ater module introduces scheduled archiving functionality Features Archive Later Author The Orchard Team Website http orchardproject net IE Blogs Version 1 0 20 The
123. module simply create a new directory under Orchard Tests Modules and populate it with your tests Integration Tests These are also NUnit tests generated using SpecFlow http www specflow org feature files Your integration tests would go under Orchard Specs and there are a multitude of examples there you can look at if you are new to the BDD approach Running the unit tests is a matter of right clicking the solution or appropriate project and choose Run Unit Tests Note this applies to writing tests for the modules that come with the standard source code distribution of Orchard To write code for your own modules you should work in your own separate project You can use the orchard scaffolding command codegen moduletests module name to set up test projects for your own modules How do I contribute my changes to Orchard Contributing changes to Orchard are discussed on the contributing patches page How to build a WCF service that exposes Orchard functionality To host a WCF Service in Orchard with all of its goodies coming from IoC you have to Create a SVC file for your service with the new Orchard Host Factory 80 ServiceHost Language C Debug true S ervice Orchard Service Services 1 Service Orchard sService Factory Orchard Wcf OrchardServiceHostFactory Orchard Framework gt Register the service normally as an IDependency using System ServiceModel namespace Orchard Service Services
124. of integers separated by dots For example the following values are all valid 5 10 1 7 5 3 1 Widgets with lower position values will be rendered before those with higher values After setting the values of all fields click Save 1 9 7 Editing or Deleting a Widget To edit or delete a widget in the Widgets screen use the Current Layer drop down list to select the layer that the widget is assigned to In the list of zones displayed for the layer click the widget you want to edit The Edit Widget screen 1s displayed 96 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Edit Widget User admin Logout Zone TripelFirst Layer TheHomepage Position 5 Title Tulips Body amp X gadA o I 5 Q2 Bz jm i Fom m Bl Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Owner admin Save 1 9 Managing Widgets 97 Read the Docs Template Documentation Release 1 9 2 Edit the field you want to change then click Save To remove the widget from the zone click Delete Change History Updates for Orchard 1 1 3 16 11 Updated screen shots for 1 1 version Updates for Orchard 1 7 4 4 14 Added Content Type rule 1 10 Organizing Content Using Tags Content items in Orchard can be categorized with tags and the list of items tagged with
125. on the parameter indicating a response file orchard myfile txt Adding Commands Modules developers can add their own commands to the system by implementing a new class deriving from Or chard Commands DefaultOrchardCommandHandler A command is simply a method on that class that has the Com 186 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 mandName attribute The following code creates a new hello world command that takes a name as a parameter and can take an optional YouRock switch CommandName hello world CommandHelp hello world lt name gt YouRock true false says hello and whether you rock or not OrchardSwitches YouRock public void HelloWorld string name Context Output WriteLine T Hello 0 name world Context Output WriteLine YouRock You rock You do not rock The switch itself is declared as a property of the class OrehardSwitch public bool YouRock 1 get set Jj Commands run in the full Orchard environment and can query the database inject dependencies and in general do almost anything that can be done from code running in the web site Throwing Exceptions From Commands Throwing from a command handler is not recommended Instead whenever possible write to the context output and return If you do want to throw a generic exception you should throw an OrchardException 3 4 3 Installing and Upgradin
126. probably want to manage your settings and configure Orchard to your liking After that you can head over to manage themes to change or install new themes and really make it your own Once you re happy with a look and feel it s time for some content You can start creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re looking to add additional functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team Orchard will display the Edit Page screen Note The Edit Page screen can also be reached from the Dashboard by selecting Content on the Dash board and then selecting Edit for the page you are interested in 15 Enter some text for the content 1 5 Getting Started with Orchard 61 Read the Docs Template Documentation Release 1 9 2 Edit Page Title Welcome to Orchard You must provide a unique title for this content item Permalink http localhost 42861 Save the current item and leave the input empty to have it automatically generated using the pattern Title e g my page Body d X Ba dA i Q B Z iz Paragraph gt om B 1
127. provided Orchard builds URLs based on the module s name if one is provided or on the ID 29 99 However module names often have spaces and ID values often have characters neither of which result in very 3 9 Extending Orchard 417 Read the Docs Template Documentation Release 1 9 2 readable URLs For example for the Orchard ArchiveLater module its name is Archive Later and its ID is Archive Later In the manifest a path is provided with the value of ArchiveLater which enables Orchard to build a more readable URL than the module name or the ID would Note If specified the Path must be a valid URL segment If you re unsure what this means the best bet is to stick with letters and numbers with no spaces An tiForgery RequiredPossible values are enabled or disabled A value that indicates whether request validation is enabled for a module Author OptionalThe developer of the module This can be an organization individual or a list of individuals Website OptionalThe URL for the website of the module developer Version RequiredThe version number of the module in Sem Ver format The version information is displayed in the Orchard Gallery and in the Orchard ULIt is also used to determine whether an update is available OrchardVersion RequiredThe mini mum version of Orchard CMS that the module has been tested against Description OptionalA brief summary of what the module does The description is used in the Orchard Gallery and
128. run the site Finally you can open the site in Visual Studio as a web site and run it The new site will have all the data from the old site and have all the new features Go into the dashboard Modules should have already upgraded themselves automatically In rare cases you may be prompted to upgrade features Click Modules and upgrade each of the modules one by one until they are all up to date If this doesn t work it means that something is wrong with your install and or one of the modules you re using and you should investigate further in App Data Mlogs e Go to the Orchard Gallery and get the latest version of all the modules you have on your site e Some versions of Orchard come with version specific upgrade features Go to Modules and locate the Upgrade feature Enable it then click on the new upgrade menu entry that was added to the admin menu Visit all the relevant tabs and execute the required upgrade actions they present Once you re done the feature can be disabled which will remove the menu entry Publishing the Upgraded Site You can deploy the locally upgraded site to your production server using your preferred deployment solution That might be Visual Studio Web deployment WebMatrix or even FTP You again have a choice of wiping out the target directory before you deploy Make your choice depending on your deployment method how clean you want the resulting directory to be and on how long it s acceptable to keep the
129. s time for some content You can start creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re looking to add additional functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Second Leader Aside New Third Leader Aside Lorem ipsum dolor sit amet consectetur Lorem ipsum dolor sit amet consectetur My new third leader aside adipiscing elit Curabitur a nibh ut tortor adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Suspendisse vel condimentum tellus Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard 1 5 6 Editing The Content Of The Home Page Orchard provides a feature that makes it easy for you to edit the content in a zone or the page body To turn on this feature you must enable the Content Control Wrapper and Widget Control Wrapper modules 1 Select Modules on the Dashboard 2 Enable Content Control Wrapper 3 Enable Widget Control Wrapper 54 Chapter 1 Getting Started Read t
130. safe mode which happens typically during setup It has a very low priority An example of a theme selector might be one that promotes a mobile theme when the user agent is recognized to belong to a mobile device 3 9 3 Command Line Code Generation Code generation is an Orchard module that automates the task of creating additional files and extensions This feature is useful for developers that want to create controllers data migration classes modules and themes The code generation feature is installed by default but has to be enabled by the end user developer Documentation Upload screenshots_675 codegen PNG To enable code generation click Features under Modules find the Code Generation feature and click Enable Documentation Upload screenshots_675 codegenenable png To enable the feature from the Orchard command line open the orchard command line and enter the following com mand For more information about the Orchard command line see Using the command line interface orchard gt feature enable Orchard CodeGeneration Enabling features Orchard CodeGeneration Orchard CodeGeneration was enabled Once the code generation feature is enabled new commmands are available for creating a module theme data migra tion or controller Currently the code generation commands add files to the appropriate location codegen controller lt module name gt lt controller name gt Create a new Orchard controller in a module c
131. separate database server If you choose this option then you don t need to configure the database at all A mini version of SQL Server called SQL Server CE will be automatically run with your site It keeps its data inside a database file that lives inside App_Data However if you are running SQL Server or SQL Server Express you can configure Orchard to use either of those products instead by specifying a connection string The database and user specified in the connection string must be created before you start the Orchard setup Just create an empty database on your database server create the user and that s it Orchard will set up all of the tables and data automatically for you during the setup process Optionally you can enter a table prefix so that multiple Orchard installations can share the same database but keep their data separate How would you like to store your data Use built in data storage SQL Server Compact amp Use an existing SOL Server SQL Express database Use an existing MySql database Connection string server local database orcharddb user orcharduser password orcharduser Data 5ource sgiServerName Initial Catalog dbName Persist Security Info True User ID zuserName Password password Database Table Prefix default The Orchard setup screen includes a section where you can choose an Orchard recipe You can choose from the following Orchard recipes e Default Sets up a site with frequently used O
132. set public string Name 4 get Setz Here is the code for the driver itself which should by now seem very familiar using using using using using using using System Ling JetBrains Annotations Orchard ContentManagement Orchard ContentManagement Drivers RelationSample Models RelationSample Services RelationSample ViewModels namespace RelationSample Drivers UsedImplicitly publrc class SponsorPartDriver ContentPartDrrver SponsorPart 4 private readonly ICustomerService customerService private const string TemplateName Parts Sponsor public SponsorPartDriver ICustomerService customerService ccustomerService customerService protected override string Prefix get i1 retur Sponsor Ty protected override DriverResult Display SponsorPart part string displayType dynamic shapeHelper return ContentShape Parts Sponsor gt shapeHelper Parts Sponsor ContentPart part oDOlnso i parit oponsor SponsorName customerService GetCustomerName part Sponsor DE protected override DriverResult Editor SponsorPart part dynamic shapeHelper return ContentShape Parts Sponsor Edit gt shapeHelper EditorTemplate TemplateName TemplateName Model BuildEditorViewModel part Prefix Prefix protected override DriverResult Editor SponsorPart part IUpdateModel updater dynamic shapeHelper 39 Extending Orchard A Read the Docs Templ
133. should be in the Styles folder of the theme e JavaScript files should be in the Scripts folder of the theme Any scripts you put in this folder should be custom scripts that are only related to your theme not scripts that are intended to be reused Such reusable scripts should be included in a separate module See the jQuery module for an example e Images should be in NConteniNmages folders If your theme contains few images it s fine to keep them all at the same level However if you have many images it is recommended that you organize them in subfolders Note To enable files to be served each of the folders that contains static files such as style sheets images or JavaScript code should contain a web config file that contains the following content lt xml version 1 0 encoding UTF 8 gt lt configuration gt lt system webServer gt lt staticContent gt lt clientCache cacheControlMode UseMaxAge cacheControlMaxAge 7 00 00 00 gt lt staticContent gt lt handlers accessPolicy Script Read gt Ale iis7 for any request to a file exists on disk return it via native http module accessPolicy Script is to allow for a managed 404 page lt add name StaticFile path 2 verb modules StaticFileModule preCondil lt handlers gt lt system webServer gt configuration Document The Document cshtml file is usually not found in themes because there is seldom any reason t
134. site with additional pre configured options features and settings out of the box Default i Default Blog Core Od II Lu a g EL E Li LIE Feri Ad pw LAgJIL IR tion content types comments tags widgets and basic naviga Finish Setup For information about recipes and how to make a custom recipe see Making a Web Site Recipe After you ve entered the required information on the setup screen click Finish Setup When the setup process is complete your new site s home page is displayed cu es T 1D http localhost 17206 D QD Orchard Playground Wele X Orchard Playground Welcome to Orchard Monday Apel 14 2014 10 38 00 PM You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and configure Orchard to your kking After that you can head over to manage themes to change or install new themes and really make it your own Once you re happy with a look and feel it s time for some content You can start creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modu
135. start creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re looking to add additional functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Second Leader Aside Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Suspendisse vel condimentum tellus Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard 4 Select Add for the TripelThird zone to add a widget to the zone TripelFirst Add First Leader Aside Remove TripelSecond Add Second Leader Aside Remove TripelThird 15 Getting Started with Orchard 0000 B Read the Docs Template Documentation Release 1 9 2 S Select the HTML Widget to add this type of widget to the TripelThird zone Choose A Widget Blog Archives Container Widget Menu Widget Projection Widget Rec
136. tenant reports dat is a legacy log file Settings txt describes the low level settings for the tenant database provider connection string etc settings xml You will see one of these per search index you have configured in the admin panel They hold configuration settings for the current state of that index Folder Indexes Used by the Lucene module to store search index cache files Folder Warmup contains cached versions of pages generated by the warmup module and a warmup txt file that contains the timestamp for the last warmup file generation Understanding bug status and triage When you submit a bug the team or anybody subscribing to notifications receives an e mail We do regular triage meetings with a small committee sometimes as often as daily and usually at least once a week When we do triage we make a query that returns all bugs in Proposed state ordered by number of votes This means that we are always looking at the most voted bugs first If you care about a bug you should vote for it and it won t fall on deaf ears A bug that is still in Proposed state has not been triaged yet When we look at a bug several things can happen We may close it if it doesn t reproduce if it s by design or if it was fixed since submitted We may ask for more information and leave it in Proposed state Or finally we may move it to the Active bucket A bug that is in Active state has been
137. that other community members and partners in the ecosystem may be interested in utilizing Orchard to help them build their own applications You can also insert pictures to your post using the Insert Picture button on the toolbar 3 1 Authoring Websites 111 Read the Docs Template Documentation Release 1 9 2 File Edit View Insert Format Table Tools Blogs Help Publish New Open Save draft B IU A iZ iZ p F E E A second post from Live Writer The Orchard Project is committed to open community participation We encourage contributions of all sorts including code submissions bug fixes and patches feature recommendations general project feedback and more In addition we hope that other community members and partners in the ecosystem may be interested in utilizing Orchard to help them build their own applications To edit the URL for your post select View Properties in the Live Writer menu 112 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 File Edit View Insert Format Table Tools Blogs Help Publish pv Edit FH Preview F12 Para Source Shift F1l i E E CENE 8 1j Ey Inert v Edit using theme Ctrl Fll Refresh theme The Slug input appears at the bottom of the editor where you can type the portion of the URL that refers to this post Hg F Edit Preview Source To preview your post in the context of the currently applied Theme i
138. the bin folder of each module such that the Precompiled Module loader can use them directly When using Visual Studio this should be the case Otherwise use the command line tool to build the website which will have the same effect References Resolution TODO Explain how Orchard figures out references by looking at the References section of the csproj file as well as looking at additional assembly binaries dropped in each module bin directory Change of Configuration Detection As explained above modules are loaded at application startup However once the application is started up changes can happen a new module might be installed the source code of a module might be manually updated a module might be removed from the site etc To detect these changes Orchard asks each module loader in the system to monitor potential changes and notify when a change happens When a change is detected the current module configuration is discarded and modules are re examined loaded and activated as if the application was starting up again In some cases these changes require an ASP NET AppDomain restart e g a new version of a module assembly needs to be loaded Orchard detects these situations and forces an ASP NET AppDomain restart 502 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Rendering Web Forms Views TODO Explain that Orchard uses a custom virtual path provider to insert custom
139. the On Sale label yellow the class name of sale red would not make sense Instead you should describe the functionality that the class is styling Let s take a look at the class names we have used so far and improve them based on this best practice Current class name Improved class name _ btn green btn featuredproduct sale red label onsale box purple box moreinfoavailable You might have your own ideas for some improved class names As long as they don t tie your functionality to a specific visual style you can use whatever you think is best This is actually a best practice for all of your style sheets Over time your website projects will be refined and even redesigned You shouldn t tie your classes to the visual designs in any area of your project Apply these changes to the module 1 Open the Styles FeaturedProduct css file 2 Change btn greento btn featuredproduct 3 Change sale redto 1abel onsale 4 Change box purple to box moreinfoavailable 5 Open the front end view at NViewsNPartsNFeaturedProduct cshtml 6 Update the view to reflect the new class names 2 Style Require FeaturedProduct if Model ContentPart IsOnSale 9 T ON SALE Use services instead of making a mess in your driver In part three of this course we spent our time making a complete mess of the driver class We took a nice clean driver class that wires data to the vie
140. the Orchard exe command line tool that you can use to run commands defined in an Orchard website in order to automate administrative tasks Orchard Core The Core project contains a set of core modules and content types for Orchard such as feeds theming navigation or the common routable and body content parts Orchard Framework Project Orchard Framework is a class library project containing the Orchard CMS framework Orchard Web Project Orchard Web is an MVC web application project This is the application that you actually run It is the startup project of the application It contains the Orchard CMS core platform binaries and is therefore the Orchard CMS host application 492 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Other Notes The Orchard Web project is set as the startup project of the solution for example when you use Visual Studio debugging Orchard Web dynamically loads all Orchard modules and discovers module extensibility points MVC routes admin pages and so on The projects in the Modules folder are physically located under the Ochard Web Modules folder This allows modules to contain ASP NET views aspx ascx and other files and static content without having to copy files between projects to be able to run the project The Orchard Web project has project references to the modules This enables automatic copying of the output assemblies into the bin folder of the
141. the latest check in on the GitHub repository is not necessarily the one you want to download or sync to as it may be a different branch than the master branch When synchronizing your enlistment you will probably want to sync to the master branch This is the latest stable release Branches are covered in more detail here For more information about Git please read Git Basics Basic Branching and Merging or Git Extensions user manual Step 1 Install Git Extensions Git Extensions is one of many Git clients available You can access the repository using any Git client This tutorial explains how to clone the repo with Git Extensions Download the latest release directly from GitHub You have two main options the Setup msi and the SetupComplete msi You should get the SetupComplete msi version which comes with some useful extra utilities bundled with it Open the msi when it has downloaded Follow the steps to complete the installation 1 Installation Scope Install for all users unless you don t have administrator privileges 2 Required Software Select MsysGit and KDiff3 You must have a a version of MsysGit installed for Git Extensions to function properly KDiff is great for comparing the differences between two files or folders You can optionally installWindows Credential Store for Git 3 Destination Folder Accept the default or select your preferred destination 4 Custom Setup The defaults are fine 5 Select SSH Client Choose P
142. the state repository using the state code from the model using System Collections Generic using System Ling using Orchard using Orchard ContentManagement using Orchard Dasta using RelationSample Models using RelationSample ViewModels namespace RelationSample Services public interface IAddressService IDependency void UpdateAddressForContentItem ContentlItem item EditAddressViewModel model IEnumerable StateRecord GetStates public class AddressService IAddressService private readonly IRepository StateRecord stateRepository public AddressService IRepository lt StateRecord gt stateRepository _stateRepository stateRepository public void UpdateAddressForContentItem ContentIlItem item 392 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 EditAddressViewModel model var addressPart item As lt AddressPart gt addressPart Address model Address addressPart City model City addressPart Zip model Zip addressPart State stateRepository Get S gt s Code model StateCode public IEnumerable lt StateRecord gt GetStates return stateRepository Table ToList Building the Views The Front End View The front end view for the part is straightforward as it s just displaying the properties of the shape p class adr div class street address 8Model Address div span class locality gt Model City lt span gt
143. theme TheThemeMachine see Customizing the Default Theme 1 9 5 Adding a Layer To add a layer in the dashboard click Widgets On the Widgets screen click Add a new layer The Add Layer screen is displayed 92 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Add Layer User admin Logout Mame Description Layer Rule Owner admin To define the new layer enter the name of the layer a description and the rule that defines the layer When you re finished click Save The Layer Rule value is an expression that resolves to either true or false If it resolves to true the widget is displayed otherwise the widget is not displayed The following table summarizes the syntax for building layer rules Rule Syntax Description url amp lt url path amp gt True if the current URL matches the specified path If you add an asterisk to the end of the path all pages found in subfolders under that path will evaluate to true for example url homex authenticated True if the user is logged in ContentType amp lt Type amp gt True if the content type being view matches the content type specified e g ContentType Page not Logical NOT and Logical AND or Logical OR Your expression can use parentheses For example the following expression defines a rule that displays a widget o
144. theme from your computer There are ne additional themes installed The main Themes screen defaults to the Installed tab which displays the current theme shows any other available themes and lets you upload a new theme There are also tabs for the Gallery which shows additional online themes you can install Updates which shows available updates for installed themes and a link to Install a theme from your computer use this to install a theme package from your local computer to your site For more information on options for adding new themes see Installing Themes To download and install additional themes click the Gallery tab Click Install on a theme to install it in your site To see how themes work install the Contoso and the Classic themes 146 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Themes User admin Logout Installed Gallery Updates 0 EJ Show All feeds Sortby Downloads Dark Version 1 0 22 Install Download Dark is a highly flexible theme based in shades of black And if you are looking for further customization of this theme discover Bind Tuning our online configuration tool Create a fully customized Dark theme in just a few clicks just like if you had a design team working for you visit httpz tuning bind pt Last Updated 3 16 2011 7 15 23 PM Author BIND Downloads 5090 Website http tuning bind pt Rating iced de Contoso Ver
145. to fit into the standard width of pages on this site The markup to create a table is a common extension for Markdown Header A Header B Header C a ea en eee ee ee ee ee eae M ee MET ae Cell AL Cell Bol Celi C 1 Cell A 2 Cell B 2 Cell C 2 Cell A 3 Cell B 3 Cell C 3 This markup will create the following table Header A Header B Header C Cell A 1 Cell B 1 Cell C 1 Cell A 2 Cell B 2 Cell C 2 Cell A 3 Cell B 3 Cell C 3 For details of table syntax see Markdown Extra Tables Reference Contributing Documentation The Orchard documentation is managed as Markdown files in a Git repository hosted on Github 508 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Making Edits On Existing Topics In the right sidebar of each topic you will find a link to the document on Github Search ion The y Table of Contents feature roadmap Current Priorities Currently Implemented Partially Areas of Focus for Future Iteration Contributing Larger Changes And Topics We recommend the use of GitHub for Windows to clone the documentation locally This will give you a local copy of the documentation site that you can run from WebMatrix or Visual Studio 3 14 3 Contributing Patches Orchard CMS uses GitHub for its source code management and issue tracking You can find the main Orchard CMS repository at https github com OrchardCMS Orchard We welcom
146. to use for site data and the Orchard recipe If you are just starting out using Orchard we recommend that you select SQL Compact Server for the database and Default for the recipe Enter the information and click Finish Setup 28 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Welcome to Orchard Get Started Please answer a few questions to configure your site What is the name of your site My Website Choose a user name admin Choose a password Confirm the password How would you like to store your data amp Use built in data storage SOL Server Compact Use an existing SQL Server SOL Express database Use an existing MySql database Choose an Orchard Recipe Orchard Recipes allow you to setup your site with additional pre configured options features and settings out of the box Default 1 3 Working with Orchard in WebMatrix 29 Read the Docs Template Documentation Release 1 9 2 The default recipe for an Orchard site that includes pages blogs custom content types comments tags widgets and basic navigation Finish Setup Orchard sets up your initial site and then opens a browser window with the site s home page You will automatically be logged in with the user name you specified in setup in this case admin At this point clicking on Dashboard will take you to the Orchard Dashboard where website changes can be made My Website Welcome to Orchard
147. tuning bind pt aa SS rua 7 40 5 Pu i Si 3 16 2011 7 15 23 PM Author BIND Downloads 5090 Website http tuning bind pt Last Updated Rating 7 Contoso Version 1 0 install Download 4 subtle and simple CMS theme perfect for any modern product or service business website Last Updated 1 13 2011 amp XX11 AM Author The Orchard Team Downloads 4117 Website httpz Aewww orchardproject nety Rating Terra Version 1 0 1 ineiall Download Terra is a highly flexible theme based in shades of brown And if you are looking for further customization of this theme discover Bind Tuning our onhne co niiguration tool Create a fully customized Terra theme in just a few clicks just like if you had a design team working for you visit http tuning bind pt Last Updated 3 16 2011 7 17 13 PM Author BIND Downloads 2074 Website http tuning bind pt Rating Classic Version 1 0 TII ms nstall Download ma Orchard Classic Blog Theme once ai Last Updated 1 14 2011 231 729 AM Author The Orchard Team Downloads 1517 SS Website httpc orchardproject net Ratna Boe If you install a theme it becomes available to apply to your site If you download a theme you save the theme package file to your local computer You can then use the Themes screen in the Orchard dashboard to install the downloaded theme package For more information see Installing Themes Previewing and Applyi
148. upload it and if you are the first person to submit a package with this ID you will given exclusive ownership for that ID While you can upload additional versions of packages sharing this ID no other submitter will be able to use this ID for their package uploads unless you grant explicit owner rights to that user It is also possible to register a package ID in advance of uploading your module to be sure you can claim the name that you want Package Version is a version number for the package and must be unique among all other packages in the gallery that same the same package ID Every time you submit a package to the gallery you will need to increment the version number for your package This allows users of your package to know when a new version is available Package Type is what determines whether your package will appear on the Modules or Themes tab of the gallery site Be sure to pick the right type for your package Specifying a Logo and Screenshots In the final step of the submission process you can specify a custom logo image and zero or more screenshot images which users will be able to see on the details page for your package Both of these are optional so feel free to skip this step if you prefer not to customize the default images Orchard gallery ORCHARD HOME jo us on El E d amp bradi MYACCOUNT SIGH OUT Home Modules Themes Contribute My Contribution erem Logo and Screenshots 7 Submit
149. v1 0 zip To use it in Orchard simply extract the archive into the modules directory at src Orchard Web Modules For Orchard to recognize it the folder name should match the name of the module Make sure that the folder name is Orchard LearnOrchard FeaturedProduct and then the modules files are located directly under that Conclusion This first guide in the module introduction course has shown the main components of a module In the next part we will extend the module to add some interactivity to the module This means adding database backing an editor view configuration settings and we will dip our toes in with some of the Orchard API features In the final part of the course we will review the module and clean it up to ensure we follow development best practices that have been missed so far This was a long guide Take a break now and when you re refreshed come back and read part two of the course Part 2 Make the Widget Dynamic Introduction This is part two of a four part course It will get you started with a gentle introduction to extending Orchard at the code level You will build a very simple module which contains a widget that shows an imaginary featured product It will teach you some of the basic components of module development and also encourage you to use best practices when developing for Orchard If you haven t read the previous part of this course then you can go back to the overview to learn about the Getting S
150. virtual string Name get set public virtual double Discount get set The Association Record Finally the association record has a reference to a reward part record and a reference to a reward program namespace RelationSample Models public class ContentRewardProgramsRecord public virtual int Id get set public virtual RewardsPartRecord RewardsPartRecord get set public virtual RewardProgramRecord RewardProgramRecord get set Creating the Database Tables and Record Here is the migration public int UpdateFrom2 SchemaBuilder CreateTable RewardsPartRecord table table ContentPartRecord T SchemaBuilder CreateTable RewardProgramRecord 3 9 Extending Orchard 399 Read the Docs Template Documentation Release 1 9 2 table gt table Column int Id column gt column PrimaryKey Identity Column lt string gt Name Colamn lt cdouble gt Discount SchemaBuilder CreateTable ContentRewardProgramsRecord table table Column int Id column gt column PrimaryKey Identity Column int RewardsPartRecord Id Column int RewardProgramRecord Id 3 ContentDefinitionManager AlterPartDefinition RewardsPart builder gt builder Attachable return 3 This code creates the three tables we need to persist the three records that we just modeled It also declares the RewardsPart and makes it attachable As
151. want to remove the source and binary files which aren t necessary for the CMS to run please consult the binary release of Orchard and use it as a template of what has to remain and what can be removed safely Resources SuSE Studio Appliance with Orchard and Mono We have prepared a virtual machine and a Live CD based on OpenSuSE 11 4 with Orchard 1 0 20 and Mono 2 10 1 preinstalled so that you can test the CMS without having to go through any of the steps above The Virtual Machine can be loaded both in Virtual Box recommended tested with version 4 0 4 and VMware After starting the VM Live CD type http orchard demo in the browser FireFox will auto start and watch it work The first time you browse the above URL you will be greeted with Orchard setup screen and prompted for database connection string You need to use the following Server localhost Database orchard User ID orchard Password orchard 258 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Known Issues Orchard requires Mono IOMAP to be active since there are a few files and directories that use inconsistent name case e After a few requests you might get npgsql PostgreSQL ADO NET provider connection errors Only restarting the application will cure it 3 8 2 Setting Up a Multi Tenant Orchard Site When running Orchard you most often will run a single site in a single application domain app domain which in ASP NET terms is an iso
152. way to create generic resource strings that are used in multiple places in the application and are not context sensitive You can always override a generic fallback like this as needed The reference strings can be stored in different locations depending on how the string is used in the application 3 1 Authoring Websites 121 Read the Docs Template Documentation Release 1 9 2 e Strings from views Use the virtual path of the view from the root of the application for example Themes TheThemeMachine Views User cshtml Strings from cs files Use the fully qualified type name of the class where the string is being used for example Orchard Packaging AdminMenu Strings from module manifests or theme manifests Use the virtual path of the manifest from the root of the application for example Themes TheThemeMachine Theme txt Note that module and theme manifest localization uses a path for fields as the key For example the Author field uses the key Author and the Description field of the Gallery feature would be under the key Gallery Description Contributing files for third party modules Our localization infrastructure is built to host translations for third party modules If you are the author of a module or want to contribute translations for a module you can generate po files for it using the Translation Manager module From an Orchard command line type the following command for the example of the Bing Maps modul
153. will Lets update the manifest now to include the Orchard Widgets dependency 1 In the solution explorer open up Module txt which will be located in the root folder of the module 2 The last three lines describe the main feature of the module we have only one feature in this module Features Orchard LearnOrchard FeaturedProduct Description Description for feature Orchard LearnOrchard FeaturedProduct Add an extra row underneath Description andaddaDependencies entry like this Features Orchard LearnOrchard FeaturedProduct Description Description for feature Orchard LearnOrchard FeaturedProduct Dependencies Orchard Widgets The indentation is important as creates hierarchy within a YAML document Indent the line with 8 spaces How is all this magic working So far the ContentPart class has been magically detected as long as it uses the Model namespace now the data migration is automatically detected just for deriving from DataMigrationImpl How is all of this happening Under the hood Orchard uses Autofac an Inversion of Control container If you re interested you can learn about how it s integrated in the how Orchard works guide Don t worry though you don t really need to know anything deeper about it other than it s in the background and it automatically scans amp registers your components for you Later on we will use Autofac s dependency injection which let us automatically get instances of things we need sup
154. will automatically add the cs on to the end for you vontrollers MI LESS Style Sheet Interface View in Browser Google Chrome Ctrl Shift W dels e Web Confiquration File Browse With Feat raductPart cs Add e3 De les Scope to This E Mew Solution Explorer View ets json Iigrations cs T eenia eea 0 o e 3 Extend the class so it derives from ContentPartDriver lt FeaturedProductPart gt note that the generic type class ends in Part not Driver 4 Add the missing namespaces using the Ctrl shortcut In the future we will do a lot with the driver class and the way that it builds its display but for this simple example all we need is a simple class to wire the shape to a view 1 Inside your FeaturedProductDriver class add this single method protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts_FeaturedProduct gt shapeHelper Parts_FeaturedProduct This says that when displaying the FeaturedProductPart return a shape called Parts_FeaturedProduct By default Orchard will look for this shape in ViewsNPartsNFeaturedProduct cshtml which is what we will build next Your FeaturedProductDriver cs file should now look like this using Orchard ContentManagement Drivers using Orchard LearnOrchard FeaturedProduct Models namespace Orchard LearnOrchard FeaturedProduct Drivers public class
155. will be downloaded from the Orchard Gallery Both elements also have a repository attribute By default the repository attribute points to the Orchard Gallery However you can set it to any feed URL To add your custom recipe to the setup page use the IsSetupRecipe attribute in the Recipe element as shown above and put the recipe XML file into the Recipes folder or its subfolder of a module Note that recipe files should have a name ending in recipe xml e g Custom recipe xml When you set up a new Orchard website the recipe list will contain your setup recipe 214 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 amp Welcome to Orchard Get Started Please answer a few questions to configure your site What is the name of your site My Site Choose a User name admin Choose a password Seee0006 Confirm the password S8G00066 How would you like to store your data amp Use built in data storage SQL Server Compact Use an existing SQL Server or SQL Express database Choose an Orchard Recipe Orchard Recipes allow you to setup your site with additional pre configured options features and settings out of the box Default F3 Custom Recipe Stes eeesomments tags widgets and basic navigation 3 4 Managing Websites 215 Read the Docs Template Documentation Release 1 9 2 Note that recipes used for importing mustn t contain an IsSet upRecipe ele
156. will see the same view as the homepage Attachments getting started with modules part 3 testing testproduct png This is because it matches the content type but not the product id Download the code for this lesson You can download a copy of the module so far at this link e Download Orchard LearnOrchard FeaturedProduct Part3 v1 0 zip To use it in Orchard simply extract the archive into the modules directory at src Orchard Web Modules If you already have the module installed from a previous part then delete that folder first For Orchard to recognize it the folder name should match the name of the module Make sure that the folder name is Orchard LearnOrchard FeaturedProduct and then the modules files are located directly under that Conclusion In this part we have learned valuable skills that will allow us to create content types in the admin dashboard and add fields to them We have learned about dependency injection how to request access to Orchard s various service classes how to examine the current content item and make decisions based on it Finally we looked at how we can create and surface custom information from the code of the module up to the view In the next and final part of this getting started with modules course we will refine the existing module and apply some development best practices that haven t been covered yet Part 4 Applying Best Practices Introduction This is part four of a four part cour
157. writes modules or themes for Orchard you are probably interested in sharing your module with others in the gallery For information about how to do this see Contributing a Module or Theme to the Gallery 3 3 Using the Orchard Gallery 157 Read the Docs Template Documentation Release 1 9 2 Registering Additional Gallery Feeds The Orchard Gallery is just one gallery that you can browse By default a single feed is exposed from http packages orchardproject net FeedService svc Orchard allows you to register additional feeds for other galleries To register a feed expand the dashboard Settings section and then click Gallery On the Gallery Feeds page you can add new feeds or delete existing ones For more information see Registering Additional Gallery Feeds Module gallery feeds If you want to set up your own gallery a reference implementation for exposing a gallery feed and website is available on OrchardGallery CodePlex com and GalleryServer CodePlex com Change History Updates for Orchard 1 1 3 22 11 Updated dashboard and UI references in the text 3 3 2 Installing Modules and Themes from the Gallery Orchard makes it easy to browse available modules and themes from an online gallery and install them using the Orchard dashboard This topic shows how to install both modules and themes from the gallery Note If your site is running under IIS make sure you have granted read write permissions to the Themes folder under
158. you don t have any changes to the default distribution In that case just get the source code for the new version In any case at this point you should have a local directory on your development machine that has the code for the new version plus any themes and modules you may have added and no data be it media or database as on Azure you are using blob storage for the former and Sql Azure for the latter All that remains to be done is to build the new package and deploy it Run clickToBuildAzurePackage cmd This file should be at the root of your source code folder If it s not there it was missing from older release files get it and other root files from the relevant version in http orchard codeplex com SourceControl list changesets Unzip artifacts Azure AzurePackage zip Open ServiceConfiguration cscfg and replace the value of the DataConnectionString with your DefaultEndpointsProtocol https AccountName your account name AccountKey your account key Open the Azure Management Portal go to Hosted Services Storage Ac counts amp CDN and choose your deployment target Click Upgrade 3 5 Hosting and Deploying Websites 237 Read the Docs Template Documentation Release 1 9 2 EY Windows AzurePlatform us Nm 20421 R pages New Hosted Mew Produchon New Staging Stop Swap Confic Service Deployment Deployment VIP OE lt aa t3 Deployment Health Choose Columns id ty Affinity Groups MSIE Type 2 Management Ce
159. your there or module for others to enjoy a Upload from Computer A 200 x 200 puel lon is required PHG file are recommended IP Images that are Ahd peorlz are best Tor screenshots For Upload from external URL uploading you can select multiple photos in the dialog by holdin the cti key down while clicking cn ther images Browse Update Logo Add Screenshot When you finish the submission you will be notified that your package will appear on the gallery shortly Normally your package will appear on the site in 60 seconds or less 3 3 Using the Orchard Gallery 175 Read the Docs Template Documentation Release 1 9 2 DarHAmDHOME JON us on ER E a Orchard gallery Home Modules Themes Contribute Z bradey RY ACCOUNT SIGH OUT Submission complete Your Package will appear on Orchard shortly Managing your Contributions to the Gallery Once your package appears on the web site you will notice that you can perform additional tasks for this package when you are logged in TestPackage 1 0 one es By The Orchard Team M Edit Manage Owners X Delete This is a test package Please ignore it More information c comments Tags test experimental 0 Downloads Edit allows you to return to the package details form and update information about your package Manage Owners allows you to assign additional owners for your package Delete allows you to delete a submission from the gallery Note When yo
160. 0 summer krtsch and based en The Theme Machine Meee irdormation J comments Tags Skevwed Typekit tach summer orange green bla I Downloads Urban Blue One 1 0 ri Dovnkoad By contmiuum rich media lab The Urban theme wath its street srt background in combination with the Ineehy colors is anything but reserved and perfect for topics libe auth feste morc and many mone Mare infcemation T D comments Tage cms Mrest art design graffiti urban star skull det youth lifestyle rnutic skate nightlife blue z omnloads th Family Blue 1 0 Download Es eanbriuurm neh media lab ity With rhe Ine colon and graphic Ehe Farry hare of perfect for nepnisientimg pour lami on the web Mans eesmabion M Qcomments Tags cms senple family children relationship personal blue 50 Downloads Shop Dark Blue 1 0 r3 Download By contmiuurm rich media lab The one offers 2 grest bess for any fond of webshop and comes in a wide range of color warsations Moore informatsan w Each module or theme in the gallery has a details page that displays more information about the package such as screenshots the package version number of downloads license information or a project site where you can learn more There is a Report Abuse link on every details page that you can use to contact the gallery administrator to report inappropriate content or malware Please use this for abuse reports only If you want to repo
161. 2 gt lt add key Tenant2 Orchard Azure Media StorageConnectionString value storageConne lt appSettings gt 3 8 Using Windows Azure Cache 3 8 1 Running Orchard on Mono Orchard doesn t currently run on Mono and hence can t run on Linux 254 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 All command line examples in this article assume you are using a Linux machine You can test the CMS using our virtual machine and or Live CD SuSE Studio appliance Prerequisites You will need the following software in order to run Orchard on your Linux distribution of choice PostgreSQL RDBMS version 8 2 or newer 8 4 recommended installed with rights to create databases Mono 2 10 1 or newer Apache 2 optional you can use Mono s XSP development server for testing A set of Linux utilities installed on your machine wget patch unzip and sudo for root access you must have administrative root rights on the machine If you want to compile Orchard from source on Linux compiling with VisualStudio is of course also supported you will also need e MonoDevelop 2 6 Beta 1 or newer Mono versions of certain assemblies used by Orchard Common Setup Steps Add a Host Name Alias for the Demo Since you are using a non existing DNS name for this demo you need to let the system know how to find the server To do so execute the following sequence of commands sudo i echo 127 0 0 1 o
162. 280 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Widgets Widgets are content types that have the Widget content part and the widget stereotype Like any other content types they are composed of parts and fields That means that they can be edited using the same edition and rendering logic as other content types They also share the same building blocks which means that any existing content part can potentially be reused as part of a widget almost for free Widgets are added to pages through widget layers Layers are sets of widgets They have a name a rule that determines what pages of the site they should appear on and a list of widgets and associated zone placement and ordering and settings The rules attached to each of the layers are expressed with IronRuby expressions Those expressions can use any of the IRuleProvider implementations in the application Orchard ships with two out of the box implementations url and authenticated Site Settings A site in Orchard is a content item which makes it possible for modules to weld additional parts This is how modules can contribute site settings Site settings are per tenant Event Bus Orchard and its modules expose extensibility points by creating interfaces for dependencies implementations of which can then get injected Plugging into an extensibility point is done either by implementing its interface or by implementing an interface that has the
163. 3 9 Extending Orchard 307 Read the Docs Template Documentation Release 1 9 2 4 Derive the class from ContentHandler public class FeaturedProductHandler ContentHandler 5 Add the namespace by pressing Ctrl b namespace Orchard Learn rchard FeaturedProduct Handlers i J F public class FeaturedProductHandler ContentHandler 16 using Orchard ContentManagement Handlers n 17 Thames Pate mtllaweller fa WERE AS A or emt Usandleace ante nthlanweller 6 You now need to add in the standard boilerplate handler constructor code which wires up the StorageFilter to the repository public FeaturedProductHandler Repository repository Filters Add StorageFilter For repository 7 Add the namespace for the FeaturedProductPartRecord and then the TRepository lt gt You should now end up with a FeaturedProductHandler cs file that looks like this using Orchard ContentManagement Handlers using Orchard Data using Orchard LearnOrchard FeaturedProduct Models namespace Orchard LearnOrchard FeaturedProduct Handlers public class FeaturedProductHandler ContentHandler public FeaturedProductHandler TRepository lt FeaturedProductPartRecord gt repository Filters Add StorageFilter For repository Update the driver to support an editor view This time through with the driver it s going to get it s other two core boilerplate methods The first is a method called Editor which is used to build the shape which wil
164. 5 Getting Started with Orchard ig Read the Docs Template Documentation Release 1 9 2 changes to the widget Body 2 X GB i Q B z iziz Paragraph om Bj Lorem ipsum dolor sit amet consectetur adipisicing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua Ut enim as minim veniam quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea comm odo consequat Path p span Owner admin The home page is automatically displayed with the updated zone 60 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 First Leader Aside Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Powered by Orchard The Theme Machine 2010 Second Leader Aside Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel New My tl condimentum tellus Sign In 14 Select the Edit link for the Body of the page Welcome to Orchard ov AL 05 32 PM You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you want First things first You ll
165. 5em lem display inline lt style gt if Model ContentPart IsOnSale lt p class sale red gt ON SALE lt p gt lt p gt Todays featured product is the Sprocket 9000 lt p gt lt p gt lt a href 2 sprocket 9000 class btn green gt Click here to view it lt a gt lt p gt Update the placement info Before we run the module to see our updated widget in action we need to make a change to the placement info file The module should run without errors at this stage but until we set up a place for the editor template you won t be able to configure the TsOnSale variable 1 Open the placement info file located in the root folder of the module 2 Within the placements tag add the following place tag The order of the place tags doesn t matter The name of the place that we are targeting Parts FeaturedProduct Edit was defined in the driver class when we configured it in the EditorTemplate shape factory method The shape will be injected into the local zone named content with a weight of 7 5 In this case the weight of 7 5 will move it down to the bottom of the form When developing your modules it is common to forget this last stage While you might not always be able to remember to update the placement info before you run you should take a moment to remember the solution Whenever the shape isn t displayed where it was expected think placement info first You should now have a placement info fie th
166. 6 Select Publish Now at the bottom of the page to make the updates to the page visible immediately LJ Show on a menu Created On 4 22 2014 03 17 PM lt gt Owner admin ee 1 5 7 Adding a New Page to Your Site 1 In the Orchard Dashboard under New select Page 2 Enter a title for the page When you enter a title for the page and save it for example Download the permalink URL for the page will be filled in automatically download You can edit this link if you prefer a different URL 3 Enter some text for the content page body 62 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Your Site New Page Permalink http localhost42861 Save the current item and leave the input empty to have it automatically generated using the pattern Title eg my paq Set as home page heck to promote this content as the home page Body H u amp Ga 8 i B Z t Paragraph arm 3j 4 In the Tags field add comma separated tags such as download and Orchard so that you can search and filter using those tags later 5 Check Show on main menu and enter the menu text Downloads to use in the site s main menu 6 Select Publish Now to make the updates to the page visible immediately You can also save the page as a draft to edit later before publishing or you can choose to publish the page at a specific date and time Tags do
167. 9 2 It is a known issue that you cannot see the packages that you have previously claimed This will be fixed in a future update to the gallery site Managing Your Account The My Account link allows you to manage your gallery account ORCHARD HOME Joinusom Mic B amp obradewi MYACCOUNT SIGN OUT Contribute You can view your account key and reset your password from here You account key is used when using the NuGet org command line utility to upload a package to the gallery feed My Account Actions Change Password Your access key provides you with a token that identifies you to the gallery Keep this a secret You can always regenerate your key at any time invaldating previous keys if your token is accidentally revealed The NuGet command line utility allows you to submit a nuget package to the gallery and you would pass you token like thes nuget push source http packages nuget arg v1 MyPackage l J nupkg Your access key is Generate New Key 3 3 5 Registering Additional Gallery Feeds To facilitate sharing of modules and themes Orchard lets you register gallery feeds When gallery feeds are registered in an Orchard site you can browse install or download the available modules and themes from the feeds by using the Orchard dashboard This topic shows you how to register new gallery feeds and remove existing feeds from an Orchard site To see the gallery feed registration screen expand the dashboard Se
168. A 4 part series by Brent Arias Introduction to Orchard 1 4 by Bertrand Le Roy 2 1 4 Hands on Labs Kris van der Mast made his hands on lab material http www krisvandermast com downloads html 2 1 5 Conferences 2 1 6 CodeStock 11 Grow Your Website using Orchard by Jason Gaylord 2 1 7 TechEd 11 Orchard 1 1 Build Customize Extend Ship by S bastien Ros 2 1 8 TechDays 11 available to anyone for free TechDays 11 Basel Develop and maintain CMS solutions using WebMatrix and Orchard by Ken Casada 2 1 9 Mix11 Deconstructing Orchard Build Customize Extend Ship by Brad Millington 102 Chapter 2 Tutorial Videos Read the Docs Template Documentation Release 1 9 2 2 1 10 Themes 2 1 11 Getting Started With Custom Theme Development 2 1 12 Deployment 2 1 13 Deploying an Orchard site using WebMatrix 2 1 14 Migrating from SglCe to SQL Express 2 1 15 Taxonomies 2 1 16 Getting Started With Taxonomies 2 1 17 Projector 2 1 18 Live demo of Projector by Sebastien Ros 2 1 19 Development 2 1 20 Setting up a source code environment 2 1 21 Localization 2 1 22 Building a Multilanguage Website Structure 2 1 Tutorial Videos About Orchard 103 Read the Docs Template Documentation Release 1 9 2 104 Chapter 2 Tutorial Videos CHAPTER 3 Documentation 3 1 Authoring Websites 3 1 1 Blogging with LiveWriter While Orchard provides a simple way to write blog posts using the built in features of the admin
169. Assembly Src xx and Assembly Namezxxx directive when reading ascx and aspx files Rendering Razor Views TODO Explain that Orchard uses a Razor custom API to add Module dependencies to Views The App Data Dependencies Dependencies xml File This file contains the list of modules their loader and their resolved references of the last known good configuration of module i e the last time Orchard successfully loaded all modules of the application Examining the content of this file can be useful for debugging purposes i e if a the latest version of a module doesn t seem to be loaded for example 3 13 2 Configuring Email Configuring Orchard to send email is done by enabling the Email Messaging module and adding the proper email settings The Email Messaging module adds Email sending functionalities This document will talk about setting up Orchard to be able to send emails using the localhost Required Module In order for Orchard to be able to send emails The Email Messaging Module needs to be enabled Messaging Email Messaging Enable The Email Messaging module adds Email sending functionalities Depends on Workflows Click Enable The SMTP settings need to be configured Email Messaging was enabled Configuring Email SMTP Settings Once the Email Messaging module has been enabled the email settings can be configured To configure the email settings in Orchard select Email under the Se
170. ContentManager contentManager IWorkContextAccessor workContextAccessor TAliasService aliasService _contentManager contentManager WworkContextAccessor workContextAccessor aliasService aliasService public bool IsOnFeaturedProductPage bool isOnFeaturedProductPage false var itemTypeName CurrentContent ContentItem TypeDefinition Name if itemTypeName Equals Product StringComparison InvariantCultureIgnoreCase var dynamicContentiItem dynamic CurrentContent ContentItem var itemProductId dynamicContentItem Product ProductIid Value if Item Product dJkguals SPROCKEISO00 StringComparison InvariantCulture 4 isOnFeaturedProductPage true return isOnFeaturedProductPage Now you have separated out the functionality into a service class This means you can keep your driver clean and also re use it in the future The driver class can now be modified so that the service is injected as a dependency 1 Switch to the driver class again There should be a red squiggly underneath the usage of isOnFeaturedProductPage because it no longer exists In order to pull this information from the ser 338 Chapter 3 Documentation Add Read the Docs Template Documentation Release 1 9 2 vice we need to inject it via the constructor a new private variable to hold the service reference Don t forget we always work with private readonly IFeaturedProductService _featuredProductService The IFeaturedP
171. DR CSS Aside First Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus This Orchard application is set up with a variety of test contents so you can use it to test your theme and layout The content menu items of the most used content types The content of this Orchard site is distributed as an export file as part of the Orchard Dojo Library and is open source If Lorem ipsum dolor sit SETE AOT E AoMOkeem 101 08 cca NI Otor dapibus vestibulum Aliquam vE V ESe ir zur BON Ole Tartine aun welcome to fork the library and edit the Lorem ipsum dolor sit MEET vestibulum Aliquam Before Content tortor dapibus You can log in with the credentials admin password and play with the content ourself Welcome to the qM Saturday Apr 27 010 MAL SU ERR mi ee Re uiro enthusiasts am vel sem nibh Suspendisse vel condimentum tellus am vel sem nibh Suspendisse vel condimentum tellus am vel sem nibh Suspendisse vel condimentum tellus Aside Second Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus
172. Display method by following these steps 1 Open up the FeaturedProductDriver cs file located in the Drivers folder 2 Locate the Display method and replace it with the following protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts FeaturedProduct gt bool isOnFeaturedProductPage false detecting current product code will go here return shapeHelper Parts FeaturedProduct IsOnFeaturedProductPage isOn FeaturedProductPage This has laid the groundwork for us The next piece of code will detect the content type read the product id and update isOnFeaturedProductPage if required Detecting the content type The CurrentContent property that we implemented doesn t exactly return the current content item it returns an TContent This contains a property called Content Item which then gives us access to everything related to the 324 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 current content item You can explore the Content Item class by navigating around the IntelliSense or by navigating to the class itself with F 12 There are lots of interesting properties to use The content type is stored as a string inside a ContentTypeDefinition property called TypeDefinition You can get to it using this notation var itemTypeName CurrentContent ContentItem TypeDefinition Name The itemTypeName var
173. ET9000 into the Product Id 1 Tick the Show on a menu checkbox 2 Leave the menu selection on Main Menu 3 Inthe Menu text enter the product name Sprocket 9000 4 Click Publish Now The page will reload after Orchard has created the new content item in the background You will see a green message saying Your Page has been created Edit Product Your Product has been created If you navigate back to the front end of the website you should see a new menu item called Sprocket 9000 Clicking it will take you to the demo page you just created 3 9 Extending Orchard 317 Read the Docs Template Documentation Release 1 9 2 Orchard Course Gelting Started With Modules Home Sprocket 9000 Featured Product Sprocket 9000 er Sunday September 27 2015 11 55 23 PM 9000 Curabitur non nulla sit amet nisl tempus convallis quis ac lectus Nulla quis lorem ut libero malesuada feugiat Cl Te he re to VIEW It Sed porttitor lectus nibh Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae Donec velit neque auctor sit amet aliquam vel ullamcorper Product Id SPROCKET9000 fered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard If the menu option doesn t appear on the page you probably clicked Save instead of Publish When we created the content type is defaults to being marked as draftable This means that you can save a copy in the system before it s made avail
174. Folder in File Explorer 292 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Fook VPC Vea Up Build perties Rebuild erences Clean View DE resh html Publish b config Configure Azure AD Authentication Add Application Insights Telemetry Scope to This New Solution Explorer View Build Dependencies Add Manage NuGet Packages Set as StartUp Project Debug Source Control Cut Ctrl X Paste Ctrl V Remove Del Rename Unload Project Open Folder in File Explorer s Troperties Alt Enter 4 Open the bin folder 5 Locate orchard exe in the list and double click it to open _ Orchard Core pdb 09 09 2015 02 00 VisualStudio pdb 1 000 KE amp 7 Orchard exe 09 09 2015 02 00 Application LM Orchard Fran rnrk dit nmerna 50WXwm0 Annlicatinn extens 1 20 KR 6 After a short pause while it loads you will then be presented with the Orchard command line 3 9 Extending Orchard 293 Read the Docs Template Documentation Release 1 9 2 8 EA rtpSoftware OrchardCMS OrchardModuleCourse src Orchard Web bin Orch Initializing Orchard session Ihis might take a few seconds 3 ype FU For help exit to exit cls to clear screen rchard 7 We enabled the code generation feature when scaffolding the module but if you have been playing with Orchard or are just using this guide as a reference it can t hurt to run t
175. K KEK KKK KKK ck ck KEK x Misc KK KK KK KK KK EK KK KK KKK KK KK KK KK KK KKK KK KK KK KK KKK KK KEK KK KKK KEKE KE KK Adding a Layout to Your Theme In the Views folder add a layout file Layout cshtml and add the following code and markup Script Require ShapesBase Style Include site css div id header gt lt div id brandaing lt h1l gt T Welcome to the Playground c h1 div lt div gt lt div igd layout navigation olass group o aDisplay Model Navigation lt div gt lt div ids main gt Display Model Content lt div gt This file defines the basic structure of the rendered web page For more information about layout pages see Template Files and their Locations Adding a Theme Image You can provide a thumbnail image that represents your new theme which will be displayed in the Admin Panel The image file must be named Theme png and it must be placed in the theme s root folder The following image represents this new theme Welcome to Orchard Tis m ee Urn sar E ca d atas ad Paez HL De Fea i aie i d iy Pane Ferr qur j brer rep peus cai enn d ie net Lene ih bet aia mar ym Ier aed dara vau deat og ee Vau cat Hanes Ire y poros ao He sie bet bruno rz m eee pe ran Fesi bera brij Yei pesky rap 5s ure p pobre pud genie Curbed de pour Mey Apr iut uou ran Fe pun tr mana feras tr cere pr inge rana hari acm iulii nale 11 sur cus Caci ee
176. LOUD SERVICES SOL DATABASES D STORAGE HDINSIGHT 0 MEDIA SERVICES 0 SERVICE BUS D VISUAL STUDIO ONLINE Creating web site gettingstartedorchard succeeded f NEW Ue BROWSE 1 5 5 Changing The Layout Of The Home Page Out of the box Orchard applies a theme to your website known as the Theme Machine The Theme Machine includes CSS styles and a layout Orchard allows you to selectively include or exclude portions zones of the layout on each page of your website 46 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 The Navigation zone contains a menu with a single tab Home The TripelFirst TripleSecond and TripleThird zones at the bottom of the page are populated with dummy text in the First Leader Aside Second Leader Aside and Third Leader Aside paragraphs In addition to zones every page has a central region In this case the text from Welcome to Orchard to Thank you for using Orchard which for this tutorial will be referred to as the Body of the page 15 Getting Started with Orchard ae Read the Docs Template Documentation Release 1 9 2 My Website Welcome to Orchard You ve successfully setup your Orchard Site and this ts the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with wha
177. Long n Work Item 1234 The parameters 2 and 3 can be found in the modal dialog which appears when clicking on the Accept link of the pull request page on codeplex For instance it will show up a line like this git pull https gitOl codeplex com forks jchenga orchard issues 20797 where e S2ishttps gitO0l codeplex com forks jchenga orchard e 53isissues 20797 Usage git accept pr 1 8 x https gitO0l codeplex com forks jchenga orchard issues 20797 4 20797 If this command results with an error it s probably because the PR is too old and there are some merge conflicts In this case reopen the PR by requesting the user to rebase his changes on the targeted branch or to merge the conflicts clean you local changes then try again If at this point you don t know what you doing or you have a doubt please contact another committer for help Finally push the commits and mark the PR as accepted 498 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 3 13 Additional Topics 3 13 1 Orchard Dynamic Compilation Introduction As a composable CMS Orchard has the ability to load an arbitrary set of modules also known as extensions at run time One of the goals of the 0 5 release was to make the process of installing and updating modules as easy as possible Orchard as any ASP NET MVC application supports loading module compiled as assemblies using Visual Studio Orchard also offers a custo
178. M KA EU E ze Z EE M Qd Ba 2G 0o z Widgets Media Welcome to the website Pellentesque in ipsum id orci porta dapibus Sed porttitor lectus nibh Profiles Mauris blandit aliquet elit eget tincidunt nibh pulvinar a Vivamus magna justo lacinia eget consectetur sed convallis at tellus Navigation Mauris blandit aliquet elit eget tincidunt nibh pulvinar a Quisque velit nisi pretium ut lacinia in elementum id enim Vivamus Taas magna justo lacinia eget consectetur sed convallis at tellus Curabitur non nulla sit amet nisl tempus convallis quis ac lectus ags Vivamus suscipit tortor eget felis porttitor volutpat Curabitur arcu erat accumsan id imperdiet et porttitor at sem Layouts Elements 4 Command line It is possible to script most admin stuff from the command line making it easy to automate certain operations lr E rtoSottware OrchardCMS FirstStepsintoOrchard src Orchard Web bin Orchar 7 Initializing Orchard session This might take a few seconds 3 ype FU For help exit to exit cls to clear screen O rchard feature enable Orchard CodeGeneration Enabling features Orchard CodeGeneration ode Generation was enabled ofechard gt codegen module Orchard LearnOrchard First tepsModule reating Module Orchard LearnOrchard First tepsModule odule rchard Learn rchard First amp 5tepsModule created successfully otc hard gt Designer The designer can modify the look of the web
179. New Item and add a class called ResourceManifest cs 3 Add the IResourceManifestProvider interface to the ResourceManfiest class public class ResourceManifest IResourceManifestProvider 4 Use the Ctrl technique to add the using Orchard UI Resources namespace 5 You will now notice that the TResourceManifestProvider still has its red squiggles underneath it 7 namespace Orchard LearnOrchard FeaturedProduct 1 gU r public class ResourceManifest IResourceManifestProvider g 16 Implement interface E CS0535 ResourceManifest does not implement interface member Implement interface explicitly ResourceManifestProvider BuildManifests ResourceManifestBuilder public class ResourceManifest IResourceManifestProvider public void BuildManifests ResourceManifestBuilder builder throw new MotimplementedException Preview changes Fix all occurrences in Document Project Solution Use the Ctrl technique a second time to implement the interface Choose the first option Implement interface 6 Remove the throw new NotImplementedException line of code 7 In it S space add in the following code var manifest builder Add manifest DefineStyle FeaturedProduct SetUrl FeaturedProduct css Orchard knows to automatically check the Styles folder for this style sheet The name we assign in the DefineStyle callis how we can reference this in the view 8 Open up the front end view
180. Now you can save the form but we are not finished yet After you save now we can bind the form to your content type we created earlier Hover back over the form and click on the angle brackets You should see the Edit Form pop up Make sure to check the Create Content and then select your Subscribe Form from the dropdown Now save the form upload dynamic forms bind form png Almost there now hover on the Email Field and click the angle brackets Click on the Bindings tab and then check the field you want to bind it to which in our case is the Email Text field of the Subscribe Form content type If you do not see the bindings tab then please save your form and go back to edit it upload dynamic forms bind email png These are some example settings upload dynamic forms news letter widget png After saving the widget browse to a page on the site and check out the new feature upload dynamic forms page view png 232 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 NOTE If the input field for the owner is visible remove it by un checking the Show editor for owner option under Documentatio n upload dynamic forms remove owner pn the Common part of the Subscribe Form content type Store Form Submission without a Content Type This is easy to do all you need to do is check the Store Submission option in the form layout Documentation upload dyna
181. Number of days after comments are automatically closed Leave to 0 to have them always available For more information about how to work with comments see Moderating Comments User Settings To access user settings click Users in the Settings panel This opens the following screen Users Users can create new accounts on the site Display a link to enable users to reset their password This option is available when an email module is activated Users must verify their email address This option is available when an email module is activated Users must be approved before they can log in In the user settings you can enable or disable the following settings in order to customize user registration Users can create new accounts on the site Configures the site to let users create a new account Display a link to enable users to reset their password Provides users with a way to reset their password Users must verify their email address Requires users to confirm their email address during registration Users must be approved before they can log in Requires administrative approval of new accounts before users can log in Cache To access caches settings like Default Cache Duration Max Age Vary Query String Parameters Vary Request Headers and Ignored Urls 3 4 Managing Websites 197 Read the Docs Template Documentation Release 1 9 2 Settings Statistics Default Cache Duration 300 Number of seconds
182. Orchard Web project Orchard Web has no dependency on types in the Modules assemblies because the Orchard Web project is not supposed to have a compile time knowledge of which modules are loaded at run time This is not entirely true at the current stage of Orchard development The projects in the Modules folder have a project reference to the Orchard project This allows modules to have access to the base Orchard services About Core Modules This section discuss some of the design decisions that went into creating core modules The first issue is this why are core modules modules Because during the design phase for Orchard it was determined that an extensibility point such as modules was needed Everything else would constitute the core framework For example the Common module introduces the Body part a core concept that is common to many types of content types such as blog posts or pages This could have been implemented as part of the Orchard framework DLL and could have had modules depend on it However then it would not get the benefit of being a module such as being able to hook up handlers drivers views routes and so on This also relates to MVC and areas where everything that belongs to an area is under the same directory It was determined that the correct approach was to get certain core concepts out of the framework DLL into a separate DLL and have them be modules This is similar to non monolithic operating systems wher
183. Orchard Blogs module is implementing basic blogging features Features Blogs Remote Blog Publishing Author The Orchard Team Website http orchardproject net Browse to the local module a nupkg file select it and then click Install This installs the module package to your site the same way that clicking Install does for an online module in the gallery Install a module from your computer User admin Logout Module Package Install Browse 3 4 Managing Websites 191 Read the Docs Template Documentation Release 1 9 2 Working with Module Features When you install a module in an Orchard site the module contains one or more features You can enable or disable each feature individually either when you first install the module or later The Bing Maps module used as an example in the previous section contains a single feature also called Bing Maps Remember that a module can have one or many features and that the features do not have to have the same name as their parent module In this section you ll see how to enable or disable an individual feature the Bing Maps feature and how to add that feature to a content type such as a page Begin by observing how to enable or disable the Bing Maps feature To do this go to the Modules Features tab find the Bing Maps feature Note that it is enabled and that you can disable it by clicking a Disable link on the feature If the feature is disabled then an Enable link
184. Products Applications u 2p Name Downloads Released Install P ua A A ji WordPress 1562538 2 19 2014 Add App Fram zzi J Blogs D DNN Platform 969955 3 20 2014 Add CMS Fi eCommer EA Joomla 646422 A204 Add LJ Forums TT I 5 Umbraco CMS 610969 10 3 2013 Add 51 Galleries i L Tt nopCommerce 337414 4 7 2014 Add B Wiki WET CMS 293446 1 10 2014 Add una al mojoPortal 242173 11 22 2013 Add Ga Acquia Drupal 7 221785 2 19 2014 Add moade Moodle 172540 2 27 2014 Add m vi Items to be installed Options Install Exit Click Install Accept the license terms in order to continue 2 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Web Platform Installer 4 6 PREREQUISITES INSTALL CONFIGURE FINISH Review the following list of third party application software Microsoft products and components to be installed and Windows components to be turned on Third party applications and products are provided by the third parties listed here Microsoft grants you no rights for third party software You are responsible for and must separately locate read and accept these third party license terms X Orchard CMS 25 28 MB Direct Download Link Microsoft WebMatrix 3 Dependency ALLS PS Web Deploy 3 0 without bundled SQL support Dependency By clicking Accept you agree to the license terms for the third party and Microsoft software listed above If you
185. Read the Docs Template Documentation Release 1 9 2 Read the Docs December 08 2015 Getting Started Installing Orchard Manually installing Orchard from a zip file Working with Orchard in WebMatrix Getting Around the Dashboard Getting Started with Orchard Navigation and Menus Adding a Blog to Your Site Adding and Managing Media Content Managing Widgets 1 10 Organizing Content Using Tags 14 1 2 1 3 1 4 1 5 1 6 1 7 1 8 1 9 Tutorial Videos Tutorial Videos About Orchard 2 Documentation Authoring Websites Customizing Websites Using the Orchard Gallery Managing Websites Hosting and Deploying Websites Using shell settings storage Using Microsoft Azure Media Storage Using Windows Azure Cache Extending Orchard Working with Data Creating Themes Developer Tools and Guidelines Additional Topics Getting Involved 2d 3 2 S 3 4 209 3 6 ou 3 8 3 9 3 10 3 11 3 12 3 13 3 14 User Experiences Walkthroughs and UI Mockups 4 1 Archived Specs Archived Specs p Contents CHAPTER 1 Getting Started 1 1 Installing Orchard This topic targets and was tested with the Orchard 1 8 release 1 1 1 Different Ways To Install Orchard There are four ways you can install Orchard You can Install it using the Microsoft Web Platform Installer Install it from Microsoft WebMatrix as shown in Working with Orchard in WebMatrix Download the Orchard zip file and install it as described in Manually Instal
186. Read the Docs Template Documentation Release 1 9 2 So instead of pulling data from three different tables IdentityPart CommonPart and WidgetPart Orchard just selects the single XML block and checks in there The Retrieve and Store methods automatically keep this data and the individual database tables in sync for you Why not just use the XML infoset all the time If you need to sort the data or filter it then its actually quicker to do this all within the SQL database server rather than extracting everything and sorting filtering it after In certain scenario s you might not need one or the other of these data stores There are more advanced approaches that you can take in these situations but that s an advanced topic for a later guide This changeover was implemented in Orchard v1 8 and was known as The Shift Bertrand Le Roy has written more about this on his blog Upgrading using a data migration In the first part of this course we created a Migrations cs class file Inside it we wrote the Create method which returned 1 When Orchard had finished running the method it stored that 1 in the database Now that we want to make some changes to our modules data storage we want to add in a table for the data to be stored in we can add a new method UpdateFroml1 Orchard will automatically find this method the next time the site is loaded and run this updated data migration At the end of the update method we will return 2 T
187. Release 1 9 2 Defining settings for Content Types We re now going to create settings and defaults wired with specific content type like Page User Blog etc This looks much different comparing to the previous one but also requires less coding There are just two classes and one shape involved and that s all As before we ll use the simplified examples taken from the Orchard Sharing project The goal I want all of my Blog Posts to have ShareBar with the same look Imagine that you re writing posts via LiveWriter like me Do you want to log in and edit every post after publishing just to change the share bar I don t I want to have it defined upfront The first thing you have to do is to create a class holding your settings public class ShareBarTypePartSettings public ShareBarMode Mode get set public IEnumerable dynamic AvailableModes get set This class has one property Mode which holds the default mode for all ShareBarParts attached to some content items of a given type ShareBarMode is just an enum type defining the display modes For the sake of brevity I won t paste the code here This could be any type you want The second property is just used for the display purposes holds items for display in drop down list as this class is also used as a ViewModel It is not being persisted The second class can be thought of as a kind of a driver for the settings It s not the Orchard ContentDr
188. Service Filters Add StorageFilter For repository OnRemoved lt TagsPart gt context tags tagService RemoveTagsForContentItem context ContentItem OnIndexing lt TagsPart gt context tagsPart context DocumentIndex Add tags 3 10 5 Data Manipulation String Join Tre tagsPart Currentiags S You can override the following methods to perform actions related to the state of the data GetItemMetadata e BuildDisplayShape BuildEditorShape e UpdateEditorShape For example the BlogPostPartHandler class overrides the Get Tt emMetadata method to add route values using code like the following protected override void GetItemMetadata GetContentItemMetadataContext context var blogPost context ContentItem As lt BlogPostPart gt 432 if blogPost null return context Metadata CreateRouteValues new RouteValueDictionary Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Arca Orchard Blogs j U Conrroller BlogPostAdcmin y Action Create blogid blogPost BlogPart rid Ha m m o c3 4 4 4 4 bi context Metadata EditorRouteValues new RouteValueDictionary Area Orchard Blogs Dontroller BlogPosrtAcdmin Action Edity postid ocontext Ccontentltem rld blogld DlogPosrt BlogPsrt ldoj n m m 4 4 4 bi context Metadata RemoveRouteValues new RouteValueDictionary Area Orc
189. Service _aliasService private IContent currentContent null private IContent CurrentContent geb if currentContent null var itemRoute _aliasService Get _workContextAccessor GetContext HttpContext Request AppRelativeCurrentExecutionFilePath Substring Ls TEIM TYI _currentContent contentManager oaet convert lTorlmt527 itemRoubte rg ciyys return currentContent public FeaturedProductDriver IContentManager contentManager IWorkContextAccessor workContextAccessor TAliasService aliasService _contentManager contentManager WworkContextAccessor workContextAccessor aliasService aliasService 1 The private variables need several namespaces adding to be valid code Use the Ctr1 technique to add in the required using statements 2 The constructor now has the wrong name update it from FeaturedProductDriver to FeaturedProductService Go back to the driver class and look at the Display method We want to pull the business logic code out into the service This means the code from the bool isOnFeaturedProductPage to the start of the return statement can be moved 1 Cut the following code and paste it into the TsOnFeaturedProductPage method of the service class bool isOnFeaturedProductPage i false var itemTypeName CurrentCon tent ContentItem TypeDefinition Name if itemTypeName Equals Product StringCompari son InvariantCultureIgnoreCase var dynamicContentItem
190. Settings part Settings GetModel ShareBarTypePartSettings 3 9 Extending Orchard 425 Read the Docs Template Documentation Release 1 9 2 You can retrieve and use the settings wherever you have access to your part particularly in the driver Display Editor methods but also shapes handlers and so on I used it in the ShareBarPart driver Display method to change the look of a share bar part 3 9 15 Web Api in Orchard Web Api is available in Orchard You can implement a web api to fit your needs in a custom module Creating Api Controllers The process of creating an Api Controller in Orchard is very similar to how you would do so in a standard NET Web Api application Create your controller class and have it inherit from ApiController namespace MyCustomModule Controllers Api public class MyApiController ApiController public IHttpActionResult Get var itemsList new List lt string gt vvlbtem Ih Ss bem T Item 3 13 return Ok litemsLhisc The above code sample will return the 3 item list shown in code when you hit the endpoint api MyCustomModule MyApv Declaring custom Api Routes To generate more friendly Api routes you follow a similar process to declaring custom MVC routes in Orchard Implement the IHttpRouteProvider interface like so namespace MyCustomModule public class ApiRoutes IHttpRouteProvider public IEnumerable lt RouteDescriptor gt GetRoutes return new RouteDescr
191. Show an main menu Owner admin E oo mm Updating an Installed Module Occasionally modules will be updated with fixes or new features You can update an installed module by clicking Modules on the dashboard and then clicking the Updates tab If there are no updates available for your installed modules the Updates tab is empty If there are updates available you can install or download the updates the same way that you installed the module originally 3 4 Managing Websites 193 Read the Docs Template Documentation Release 1 9 2 Modules User admin Logout Features Installed Gallery Updates 0 No module updates available Change History Updated for Orchard 1 1 3 23 11 Reordered sections of the topic added new section on enabling and disabling features plus another section on updating a module Updated screens and text in existing sections 3 4 4 Modifying Site Settings You can configure the general global and feature specific settings for your site in the Settings panel the menu items contained in the Settings section of the Orchard dashboard This topic describes these site level settings In the Settings panel in the dashboard the settings are arranged into categories including General Gallery Com ments Media Users and Cache Settings General Settings To access general settings click Settings in the Settings panel This opens the following screen Note The general settings screen also d
192. Template TemplateName Parts FeaturedProduct Model part Prefix Prefix protected override DriverResult Editor FeaturedProductPart part IUpdateModel updater 3 9 Extending Orchard 309 Read the Docs Template Documentation Release 1 9 2 updater TryUpdateModel part Prefix null null return Editor part shapeHelper Add the EditorTemplate view The editor template view uses the same underlying technology as the front end view a Razor view template Orchard keeps all of its editor templates inside the EditorTemplates folder of the Views folder When you re building the administration form you will normally use many of the ASP NET MVC helper methods such as Html CheckBoxFor model gt model IsOnSale For this reason you will find that editor template views are strongly typed views and start off with the model command This will mean that you get the IntelliSense while using model to build the forms The editor form for this module will have a single section to represent the Boolean value that we have added to the model When building the view you should wrap each form item inside a lt fieldset gt tag Add the EditorTemplate view by following these steps 1 Add a new folder inside the Views folder called EditorTemplates Right click on the View folder in the solution explorer click Add New Folder andtype EditorTemplates 2 Add another folder inside that called Parts 3 Add a new cshtml Razor view with
193. Template Documentation Release 1 9 2 var sponsorPart item As lt SponsorPart gt sponsorPart Sponsor _contentManager Get model SponsorId public string GetCustomerName IContent customer return customer ContentItem Parts SelectMany p gt p Fields Where f gt f Name Name PEirer Storage Get string null public IEnumerable lt CustomerViewModel gt GetCustomers return contentManager Query Customer nist Select ci gt new CustomerViewModel Id ci Id Name GetCustomerName ci ie The only notable thing here is the way we are assuming the content type has a Name field that we ll use to build the list of customers that will be used to build the UI to select the sponsor The GetCustomerName is implementing this assumption Of course you could also have a Customer part that has a Name property or you could use Routable and its Title Building the Views The editor and front end views should by now look fairly familiar model RelationSample ViewModels EditSponsorViewModel lt fieldset gt lt legend gt Sponsor lt legend gt div class editor field gt Html DropDownListFor model gt model SponsorlId Model Customers Where c gt c Id Model CustomerId Select c gt new SelectListItem Selected c Id Model SponsorId Text c Name Value co id Tos tring i Choose a customer aHtml ValidationMessageFor model gt model Sponso
194. TemplateName Parts Product Model part Prefix Prefix 7 POST protected override DriverResult Editor ProductPart part IUpdateModel updater dynamic shapeHelper updater TryUpdateModel part Prefix null null return Editor part shapeHelper 3 9 Extending Orchard 355 Read the Docs Template Documentation Release 1 9 2 The code in the Display method creates a shape to use when rendering the item in the front end That shape has Sku and Price properties copied from the part Update the csproj file to include the following line lt Compile Include DriversNProductDriver cs gt The Editor method also creates a shape named EditorTemplate The shape has a TemplateName property that instructs Orchard where to look for the rendering template The code also specifies that the model for that template will be the part not the shape which would be the default The placement of those parts within the larger front end or dashboard must be specified using a placement info file that is located at the root of the module That file like a view can be overridden from a theme Create the placement info file with the following contents lt Placement gt Place Parts Product Edits cContenbtss 4s Place Parts Products Conternt 3 5 lt Placement gt Add the placement info file to the csproj file using the following line Content Include 2 placement info Building the Templates The last thi
195. Unapprove Filter All Comments r Comment Commented On Actions Mark as Spam Deleie TEE appro ayer Apr ii 2011 243 PM My next Blog Spam Unapprowe Edit Delete Abbas What a cool blog post past Approved Brenda Apr 11 2011 242 PM My first post Spam Unapprowe Edit Delete Diaz Here s a comment on your blog Approved admin Apr 1i 2011 2 40 PM My first post Spam Unapprowe Edit Delete An admin comment on your first blog post Aporoved admin Apr 1i 2011 240 PM My next blog Spam Unapprowe Edit Delete Here s a comment an a blog post past Showing tems 1 4o 4 The Comments screen lists the comments across all content items in your site It can also display a filtered list that shows all comments by administrative category pending approved or spam If you want to carry out a bulk administrative task that applies to many comments select the comments you want and then use the Actions drop down list to apply an action such as Approve or Unapprove Note If you want to manage just the comments for a specific content item such as a page or a blog post edit the content item In edit mode there is an option to display and manage comments for that item The screen for editing comments that are linked to a content item is identical to the Comments screen except that it only shows comments from the specific content item In the Comments screen click Edit next to an approved comment A screen for editing t
196. Windows Azure This has a number of benefits We now have one click publishing to Windows Azure from directly within Visual Studio like the Azure gods intended Newer releases of the Visual Studio Tools for Windows Azure automate things like creating and connecting to a Windows Azure subscription creating and provisioning the necessary certificates and downloading subscription IDs and access keys This functionality can now be utilized seamlessly With the old deployment solution this had to be done manually e Newer SDK features such as role content folders can now be utilized 3 5 Hosting and Deploying Websites 243 Read the Docs Template Documentation Release 1 9 2 Adding more roles to your deployment besides Orchard Azure Web is now as easy as right clicking and selecting Add New Role in Solution Explorer Before they also had to be carefully worked into the AzurePackage proj file which was far from trivial Publish can now be done for either Debug or Release build configurations Previous hard coded assumptions no longer apply This can be very useful for things like collecting IntelliTrace logs from your cloud service deployment or to simply get line numbers in exception stack traces Continuous deployment from TFS to Windows Azure should now just work although this has not yet been tested Additionally when building and publishing using Release build configuration configuration file transformations are n
197. XOrchar E rtpSoftware Orchar E rtpSoftwareVOrchar E rtpSoftwarekOrchar E rtp Software Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftwareXOrchar E rtpSoftwarekOrchar E rtpSoftwareVOrchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar Search Projects Ctrl E Name Lucene D N Orchard Widgets EArtpSoftware Orchar Y 4 3 Now you can try resolving the red squiggly lines under WidgetPart again ok m WEL Gal Y wf Few 1 tees Lo Lai wg m ELIN P 28 MithPart typenof CommonPart Name WithPart typeof WidgetPart Name using Orchard Widgets Models Change WidgetPart to Widgets Models WidgetPart You will now have the correct using Orchard Widgets Models option presented to you Select it 4 Save your progress so far by clicking the Save all button or press Ctr1 Shift S That s all for the data migration your Migrations cs should now look like this using Orchard ContentManagement MetaData using Orchard Core Common Models using Orchard Data Mrgratron using Orchard LearnOrchard FeaturedProduct Models using Orchard Widgets Models namespace Orchard LearnOrchard FeaturedProduct public class Migrations DataMigrationImpl public int Create ContentDefinitionManager AlterTypeDefinition FeaturedProductWidget c
198. You can read and write C code e You have some experience with ASP NET MVC This doesn t need to be deep but you should be aware of Razor templates views strongly typed models and similar basics The course was written and tested against Orchard v1 9 2 It should work in new 1 x branch releases as they come out Getting help If you get stuck or need some support at any point in the course there are several places you can turn 1 Post a question in the official support forums on CodePlex 2 Post a question on Stack Overflow tagged with OrchardCMS 3 Open an issue on the Orchard Doc GitHub repo Setting up First things first you need to follow the setting up for a lesson guide This will take you through the initial steps to set up your dev environment and pull a fresh copy of the source code down When you ve completed it please use your back button to come back to this course 3 9 Extending Orchard 285 Read the Docs Template Documentation Release 1 9 2 Getting the most out of this course Writing an Orchard module that actually does something is going to contain a minimum of 9 different files You will need to do a lot of development before you can run your module code and see it working in Orchard At first you might be overwhelmed by this but here is a little tip don t be Just forge ahead with the tutorial and don t worry if terms like drivers content parts or placements seem unfamiliar at the moment As you c
199. a placement info file at their root This is an XML file that specifies the placement of each part of a content item The following example shows an example of a placement file It s based on the placement info file that comes with Orchard Tags Placement Place Parts Tags Edit 2 Content 7 Match DisplayType Detail gt Place Parts Tags ShowTags Header after 7 Match Match DisplayType Summary Place Parts Tags ShowTags Header after 7 Match Match DisplayType SummaryAdmin Place Parts Tags ShowTags Match lt Placement gt Placement Scope A placement file acts at the Content Item level This means that you can use it to reorder the display of the parts of anything that is a content item blog posts pages comments custom items widgets elements etc but not necessarily arbitrary shapes If a shape that is not representing a content part needs placement it is up to you to provide a placement mechanism for that shape Comments Comments can be included in the placement info using normal comment syntax The Placement Element The Placement element must be present at the root of the placement info document It is a simple container Place Element The Place element is the main entity ina placement info file It can have any number of attributes although it s recommended for readability to have only one shape place defined p
200. able publically Until you click the Publish Now button it won t show on the website That s all the preparation we need to do before we can dive back into the code Bonus Exercise Go back to the admin dashboard and add in another product It s not required but will mean that you can demonstrate the code is correctly identifying the product id later on All of this could also have been done through code We developed this content type via the admin dashboard to show that it s possible to work with content types via code whether created through classes in a module or in the admin dashboard Bonus Exercise Using the techniques learned in the first parts of this course go back and create a clone of the Product content type but create it through code Name the new content type ProductViaCode so that it doesn t clash with the Product we have just created Hint The creating types from code documentation should point you in the right direction if you get stuck Writing code against the Orchard API At the moment the widget is displayed site wide with a big green Click here to view it link When the user is on the featured product page it doesn t make sense to show a link back to itself We re going to use Orchard s API so that when the widget is asked to display itself in the driver it will examine the current page that s being displayed the content item check if it s on a product page content type of Product and then check the product i
201. able the Import Export module upload dynamic forms import export enabled png The Import Export functions are now available in the admin via the left navigation Selecting the Export tab at the top of the Import Export section of the admin shows all of the available content types in Orchard To export the list of emails that have been submitted check the box next to the Subscribe Form content type Towards the bottom of the page there are a few options for export The first option Metadata will include the definition of the content type One use for this option would be an easy way to copy a content type and it s records from one Orchard CMS site to another A prime example of this would be to move a new content type and data from a development site to a production site When importing an XML file that contains both the metadata and data Orchard will create the content type copy in the included data In the current situation we are only interested in exporting the data so there is no need to check the Metadata option Also be sure to bullet Draft Only since none of the items submitted from the front end would have a published state upload dynamic forms export png The exported file is and XML file that can be opened in MS Excel and manipulated to be made ready for the email campaign platform of your choice And that s it The site is now able to collect visitor s email addresses and save them for export later for a n
202. accessible in the view as model IsOnFeaturedProductPage In the last section of this lesson we will update the view to make use of this information Updating the view Once you have done the work in the driver it s simple for you to make decisions based on the value passed to the model In part two we looked at using conditionals and reading values from the Mode 1 Now we are going to re use these skills 1 Open up the view file located at Views Parts FeaturedProduct cshtml 326 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 2 Copy this CSS snippet into the lt style gt block at the top of the view box purple padding lem text align center color fff background color 7b4f9d font size 2em display block 3 Find this line of markup it should be the last line in the view And replace it with if IModel IsOnFeaturedProductPage Click here to view it else Read more about it on this page 4 Save and close the file For reference your complete FeaturedProductDriver cs class should now look like this using System using Orchard Alias using Orchard ContentManagement using Orchard ContentManagement Drivers using Orchard LearnOrchard FeaturedProduct Models namespace Orchard LearnOrchard FeaturedProduct Drivers public class FeaturedProductDriver ContentPartDriver lt FeaturedProductPart gt private readonly IContentManager _contentManager private readonly
203. addition to using the automatically generated alternates you can manually specify an alternate In a placement info file you can specify which alternates are available for a content type For example to specify a different template identified as Parts Tags ShowTags BlogPost for rendering the tags for blog posts you can revise the placement info file for the Orchard Tags module to include an element that matches BlogPost types The fol lowing example shows the revised file Placement Place Parts Tags Edit 2 Content 7 Match ContentType BlogPost Place Parts Tags ShowTags Header after 7 Alternate ShowTags BlogPost Match Match DisplayType Detail gt Place Parts Tags ShowTags Header after 7 Match Match DisplayType Summary Place Parts Tags ShowTags Header after 7 Match lt Placement gt The ordering of the Match elements is significant Only the first matched element is used to render the item In the example placing the element for BlogPost below Detail and Summary means that ShowTags_BlogPost will not be used even for BlogPost items because the earlier elements match the item For more information about the placement info file see Understanding placement info Alternates for MVC views Some modules in Orchard use regular MVC views to render the results of an action that was invoked on a custom controller To customize the look of the pages produced by custom MVC c
204. ads Our Blog Download Tags download Orchard Ceci est la page de t l chargement de mon site Orchard To enable localization for custom content types add the Localization part to the content type For example to add localization to a custom content type named MyEvent click Content on the dashboard and then click the Content Types tab Click Edit on the MyEvent type this example assumes the custom type already exists Click Add in the Parts section of the type The Add screen is displayed and you can select Localization or other parts to add Add Parts To MyEvent Admin Menu Comments Common Containable Container oO E3 o o ES ES p Custom Properties irik Localization Publish Later Route L3 E For more information about creating and working with custom content types refer to the Creating Custom Content Types topic Note The localization feature is a work in progress and not all parts of the Orchard application are yet localizable For example Orchard does not yet provide an automatic way to filter and display only content items in a given culture one instance of this is the browser s default culture We will address this in a future release In the meantime you can provide your own implementation of ICultureSelector in a module If you want to give us feedback on localization support in Or 3 1 Authoring Websites 125 Read the Docs Template Documentation Release 1 9 2 chard for example to help us un
205. age but another layout file for subpages or you can use alternates to render elements one way when the elements are in a page but a different way when they are in a blog post For more information see Alternates 3 11 Creating Themes 445 Read the Docs Template Documentation Release 1 9 2 Widget Overrides The rendering for widgets can also be overridden by creating a template in Views named widget widget type For example you can override the rendering of the HTML widget and add a red frame around the content by putting the following widget htmlwidget cshtml file into the Wiews folder of your theme div style border lpx red solid gt Display Model Content lt div gt you so if you feel up to it please consider participating XOXO The First Leader Aside orem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum liquam vel sem nibh Suspendisse vel condimentum tellus Powered by Orchard The Theme Machine 2010 elcome Adm Note that this is just a simple example and normally adding a frame would be better done using CSS Placement Files A theme can modify where shapes are rendered by including a placement info file at the root of the theme folder The placement info file is an XML file Here is an example Placement lt l widgets gt Place Parts Blogs BlogArchives Content before Place Parts Blogs RecentBlogPosts Content after
206. age for managing the blog is displayed Note You can have several blogs in the same Orchard site 1 7 Adding a Blog to Your Site 79 Read the Docs Template Documentation Release 1 9 2 Manage Our Blog User admin Lage Blog Properties A blog for your website New Post There are no posts for this blog 1 7 2 Add a post to the Blog Click New Post to create a new blog entry The New Blog Post screen is displayed Enter a title for your post and the post contents New Post User admin Lo Title My first past You must provide a title for this content item Permalink http lacalhost 30321 OrchardLacal Save the current item and leave the input empty to have it automatically generated using the pattern Blog and Title e g my blog my post O Set as home page Check to promote this content as the home page Body d n A S3 wy m Le B Z Paragraph emm E This is my first post Enter tags separated by commas to your blog post in the Tags field Check Show comments Allow new comments and Allow threaded comments Click Save to save it as a draft 80 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 first post Orchard team Separate multiple tags with commas Comments I Show comments Enable to show the existing comments 4 Allow new comments Enable to show the comment form Disalling still allows the existing co
207. am Downloads 1944 Website http orchardpraject net Rating Lucene Version 1 0 20 Install Download The Lucene module enables the site to be indexed using Lucene MET The index generated by this module can then be used by the search module to provide an integrated full text search experience to a web site Last Updated 1 13 2011 9 40 23 AM Author The Orchard Team Downloads 1855 Website http orchardproject net Rating Proc fce Messaging Version 1 0 20 Install Download The Messaging module adds messaging functionalities Last Updated 1 13 2011 9 42 27 AM Author The Orchard Team Downloads 1823 Website httpz orchardproject net Rating Bere ae As with themes if you install a module it becomes available to use on your site If you download a module you save the module package file to your local computer You can then go to the Modules screen on the dashboard click the Installed tab and then click Upload to install the module in an Orchard site For more information about how to activate a module after installing it see Installing and Upgrading Modules and Enabling and Disabling Features On the dashboard Modules screen click the Installed tab This tab displays all the modules that are installed in an Orchard site 160 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Modules User admin Logout Features Installed Gallery Updates 0 Search Ar
208. ame part gt part WithDescrip tion Renders information about the featured product The WithDescription method is an extension method in it s own namespace If you have cleaned up your using statements in one of the previous parts you will need to use Ct r1 to add the using in Your Migrations cs file should now look like this using Orchard ContentManagement MetaData using Orchard Core Common Models using Orchard Core Contents Extensions using Orochard Data Mrgrfsgtrron using Orchard LearnOrchard FeaturedProduct Models using Orchard Widgets Models namespace Orchard LearnOrchard FeaturedProduct public class Migrations DataMigrationImpl 3 9 public int Create ContentDefinitionManager AlterTypeDefinition UReaturedProductWridget CLO e CLG WithSetting Stereotype n Wrdget WithPart typeof FeaturedProductPart Name WithPart typeof CommonPart Name WithPart typeof WidgetPart Name return s public int UpdacteRromLbtyry 4 SchemaBuilder CreateTable typeof FeaturedProductPartRecord Name table gt table ContentPartRecord Columusesbool TIsOnssaLle yys return 2 public ant UpdateRrom2t 4 ContentDefinitionManager AlterPartDefinition typeof FeaturedProductPart Name part gt part WithDescription Renders information about the current featured product return 3 Extending Orchard 341 Read the Docs Template Documentation Release 1 9 2
209. and returns a string that relates the value to the current time public class DateTimeShapes IDependency private readonly IClock clock public DateTimeShapes IClock clock Glock clock T NullLocalizer Instance public Localrzer T 4 get Set Jj Shape public IHtmlString DateTimeRelative HtmlHelper Html DateTime dateTimeUtc var time _clock UtcNow dateTimeUto if time TotalDays 7 return Html DateTime dateTimeUtc T on MMM d yyyy at h mm tt if time TotalHours 24 return T Plural 1 day ago 0j days ago time Days if time TotalMinutes 600 return T Plural 1 hour ago 10 hours ago btime Hours if time TotalSeconds gt 60 return T Plural 1 minute ago 0j minutes ago time Mrinutes if time TotalSeconds 10 return T lt Plural 1 second ago 10 seconds ago time Seconds return T a moment ago 3 11 5 Alternates Alternates are optional variations of a shape that you can implement in a theme in order to customize the rendering of the shape for specific cases By using alternates you can override which template is used to render content based on the type or other characteristic of that content For example you can use alternates to apply one layout file for the home page but another layout file for subpages Or you can use alternates to render tags one way when the tags are in a page but a different way when the tags are
210. answer yes to all prompts to overwrite e Remove the app offline html file The site should be running now Log in and go into admin 236 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Go into the dashboard Modules should have already upgraded themselves automatically In rare cases you may be prompted to upgrade features Click Modules and upgrade each of the modules one by one until they are all up to date If this doesn t work it means that something is wrong with your install and or one of the modules you re using and you should investigate further in App_Data logs Go to the Orchard Gallery and get the latest version of all the modules you have on your site Some versions of Orchard come with version specific upgrade features Go to Modules and locate the Upgrade feature Enable it then click on the new upgrade menu entry that was added to the admin menu Visit all the relevant tabs and execute the required upgrade actions they present Once you re done the feature can be disabled which will remove the menu entry You are done Upgrading an Azure Instance of Orchard You should already have the full source code with your modifications if you had any additional modules or themes Upgrade that by copying the source of the new version over it overwrite whenever asked or by doing a Mercurial update to the desired version If you do not already have the full source code then that means
211. ape attribute Orchard DisplayManagement ShapeAttribute that enables you to write code that creates and displays the shape without using a template Creating Shapes For module developers the most common need for shapes is to transport data from a driver to a template for ren dering A driver derives from the Orchard ContentManagement Drivers ContentPartDriver class and typically overrides that class s Display and Editor methods The Display and Editor methods return a Content ShapeResult object which is analogous to the ActionResult object returned by action methods in ASP NET MVC The Content Shape method helps you create the shape and return itina Content ShapeResult object Although the Content Shape method is overloaded the most typical use is to pass it two parameters the shape type and a dynamic function expression that defines the shape The shape type names the shape and binds the shape to the template that will be used to render it The naming conventions for shape types are discussed later in Naming Shapes and Templates The function expression can be described best by using an example The following example shows a driver s Display method that returns a shape result which will be used to display a Map part 3 11 Creating Themes 453 Read the Docs Template Documentation Release 1 9 2 protected override DriverResult Display MapPart part string displayType dynamic shapeHelper return ContentShape Parts Map
212. appears Orchard Home Other Blog Name Douglas 4 Main Street Orchard City WA 98052 Rewards Customer sponsored by Robert Accessing NHibernate Configuration directly For most relationships these conventions should create and auto map your data model appropriately However for more complex data models you may find that it s necessary to access the NHibernate configuration directly in order to appropriately map classes You can do this by implementing the ISessionConfigurationEvents interface like so using FluentNHibernate Automapping using FluentNHibernate Cfg using NHibernate Cfg using Orchard Data Using OrchnardgUErzlr tys namespace DataMapping Example public class Mappings ISessionConfigurationEvents public void Created FluentConfiguration cfg AutoPersistenceModel defaultModel Many to many mapping example defaultModel Override ClassA x gt x HasManyToMany y gt y ClassB Cascade All Table DataMapping Example ClassAClassBCrossReferenceTable One to One example defaultModel Override lt ClassA gt x gt x HasOne y gt y ClassB public void Prepared FluentConfiguration cfg public void Building Configuration cig 1j 416 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 public void Finashed Contiguration cro public void ComputingHash Hash hash Conclusion This topic should show the way for the creation of comple
213. approval of comments before they become visible on the site As the previous illustration for editing comments shows by default comments are approved and visible However if you enable the site level setting to require approval of comments new comments will default to the pending category and will not be displayed until they are approved To require approval of comments click Settings gt Comments in the dashboard A screen appears for managing site level comment settings Comments Comments must be approved before they appear Check if you want to manually approve comments before they can be displayed Automatically close comments after 0 days Number of days after comments are automatically closed Leave to 0 to have them always available Select Comments must be approved before they appear and then save the settings After you have enabled this setting you will need to review all new user comments in the Comments screen and for the comments that you want to allow on the site change their status from pending to approved Enabling Spam Protection The spam protection feature helps to automatically categorize certain comments as spam so that you can prevent them from being displayed in your site Filter spam Actions Choose action ESI Security Akismet Anti Spam Disable Anti Spam Disable TypePad Anti Spam Enable Filter Provides anti spam services to protect Filter Provides an anti spam filter based on
214. ar settings field PartFieldDefinition Settings GetModel DateTimeFieldSettings if settings Display DateTimeFieldDisplays DateOnly viewModel Time DateTime Now ToShortTimeString if settings Display DateTimeFieldDisplays TimeOnly viewModel Date DateTime Now ToShortDateString if DateTime TryParse viewModel Date viewModel Time out value field DateTime value ToUniversalTime else updater AddModelError GetPrefix field part T 1 0 is an invalid date and time field Name field DateTime null return Editor part field shapeHelper protected override void Importing ContentPart part Fields DateTimeField field ImportContentContext context var TMpOrcedlext vontext Attribute CertPreTtix rielg part Dateline if importedText null 4 field Storage Set null importedText protected override void Exporting ContentPart part Fields DateTimeField field ExportContentContext context context Element GetPrefix field part SGetAttributeValue DateTime field Storage Get lt string gt null j Let s enumerate a few things we re doing in this code in order to explain how it works The driver derives from ContentFieldDriver lt DateTimeField gt in order to be recognized by Orchard and to give strongly typed access to the field value from the driver s code We start by injecting the localizer dependency the T property so that we can create localizab
215. arch 2 fdt Add November 02 10 49 AM 844 B v App Data Sites Default Indexes Search segments 4 Add Movember 02 10 49 AM 259 B v App Data Sites Default Indexes Search 2 frq Add November 02 10 49 AM 1 KB App Data Sites Default Indexes Search 2 prx Add Movember 02 10 49 AM 2 KB App Data Sites Default Indexes Search 2 tis Add November 02 10 49 AM 6 KB Delete files on the remote server that are not on my computer Continue Cancel Once you have published your website you can view the files in the remote site by opening the Remote View a _ NEFEEEIT y J Publish Download Check Settings ompatibility More information about using WebMatrix to publish websites can be found here Change History Updates for Orchard 1 6 11 14 12 Updated screens and workflow 1 4 Getting Around the Dashboard This topic targets and was tested with the Orchard 1 8 release The Orchard dashboard lets you manage your website change its appearance add content and enable and disable Orchard features When you are logged into your website you can access the dashboard by clicking the Dashboard 1 4 Getting Around the Dashboard 37 Read the Docs Template Documentation Release 1 9 2 link at the bottom of your default home page When you open the dashboard you see a list of application features and settings on the left side of the page This list is divided into sections of related features Each
216. ard jQuery module If you looked in the Orchard Layouts module txt then you would find that it specifies a dependency on the Orchard jQuery module 3 9 Extending Orchard 333 Read the Docs Template Documentation Release 1 9 2 This kind of external dependency shows off some more of the resource manager features 1 You can share the resource strings between different modules so that dependencies for common scripts can be centrally managed 2 If you look in the views of the Orchard Layouts module you won t find any includes for the jQuery script When the Layouts Lib resource sets a dependency on the jQuery resource Orchard automatically knows to generate a jQuery script tag before the Layouts Lib script tag So you will find some code like Script Require Layouts Lib AtFoot in the view but Script Require jQuery AtFoot isn t needed 3 You will also just find jQuery included just once no matter how many modules have requested the script This is because Orchard recognizes the resource It pools the requests together and knows how to order the scripts correctly The second Def ineScript in the example above is included just to show that you can include multiple dependencies in your SetDependencies call Now that its clear what service the resource manifest provides let s upgrade the module to use this feature of Orchard 1 In the Solution Explorer right click on the module s project name 2 Select Add
217. arkable with the driver for this part which is just wiring the repository Using Orchard Deta using Orchard ContentManagement Handlers using RelationSample Models namespace RelationSample Handlers public class RewardsPartHandler ContentHandler public RewardsPartHandler IRepository lt RewardsPartRecord gt repository Filters Add StorageFilter For repository The Reward Driver The driver is also surprisingly unsurprising given the requirement to persist the n n relationship using System Ling using JetBrains Annotations using Orchard ContentManagement using Orchard ContentManagement Drivers using RelationSample Models using RelationSample Services using RelationSample ViewModels namespace RelationSample Drivers UsedImplicitly public class RewardsPartDriver ContentPartDriver lt RewardsPart gt private readonly IRewardService rewardService private const string TemplateName Parts Rewards public RewardsPartDriver IRewardService rewardService _rewardService rewardService protected override string Prefix get return Rewards protected override DriverResult Display RewardsPart part string displayType dynamic shapeHelper return ContentShape Parts Rewards gt shapeHelper Parts Rewards CODLentPart party Rewards part Rewards 3 9 Extending Orchard 401 Read the Docs Template Documentation Release 1 9 2 protected override DriverResult Editor
218. arted with Orchard ig Read the Docs Template Documentation Release 1 9 2 Try Orchard Check out a demo site Freshest demo site http demo3 tryorchard net Log in with admin password Other demo sites http demo1 tryorchard net http demo 2 tryorchard net htip demo4 tryorchard net htip demos5 tryorchard net There s a countdown on the home page of the demo sites showinc About Try Orchard Try Orchard is a showcase for the Orchard content managemen Orchard as you wish You can log in to the admin site with the adi Try Orchard demo sites are re installed hourly There are five de recently site Demo sites run on DotNest the Orchard Saas Powered by DotNest the Orchard Saas platform fueled by Lombid 40 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 DotNest Demo Site Home Blog Typography Test custom ink Blogposts Projecton content ink Media Test html ink Countdown 47 minutes 14 seconds left until this demo site is re installed Featured Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Lorem ipsum dolor sit amet consectetur adipiscing eli kahh sui LN iL Ls ML Before Main Lorem ipsum dolor sit amet consectetur adipiscing clipes ER C ze Nu iB ele ok Ro Lorem ipsum dolor sit amet consectetur adipiscing elim ui ree EE BUT eere LETS
219. as Myblog or MyBlog FirstPost Overriding Placement A module should define default placements for the parts and fields it provides by having a placement info file at the root of the module s directory Without a placement your parts and fields will not appear on the page By supplying a default you take the burden away from theme developers to configure your module and you make it easy for them to copy sections over to customise them Consider the various DisplayTypes your parts and fields may be viewed and provide sensible defaults That default placement can be overridden by any theme by placing a placement info file in the root of the theme directory The current theme s placement will win over that of any module 452 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 3 11 4 Accessing and Rendering Shapes A shape is a dynamic data model The purpose of a shape is to replace the static view model of ASP NET MVC by using a model that can be updated at run time that is by using a dynamic shape You can think of shapes as the blobs of data that get handed to templates for rendering This article introduces the concept of shapes and explains how to work with them It s intended for module and theme developers who have at least a basic understanding of Orchard modules For information about creating modules see the Getting Started with Modules course For information about dynamic objects see Creating and Us
220. as multi ple features and doesn t define a default feature then leave this field out and follow the instructions in its description down in the Features table below Features OptionalA special repeating section of the manifest which allows a module to define multiple features within a module Supports several sub fields as described by the table in the next section The features section should be placed at the end of the manifest Module txt Features sub section fields If a module provides multiple individual features within a single module then the repeating Features sub section should be used It allows module developers to specify separate manifest fields for each individual feature These individual features can then be enabled and disabled separately by end users The Features field doesn t have any assigned value It is a placemarker field that indicates the beginning of a repeating list of features Examples of the formatting to be used for this part of the manifest can be found in the next section Field Name Description Featureld RequiredBecause the feature is already contained within the module ID module developers need to supply a unique ID for Orchard to use internally as a reference The FeatureId should take the form of the name of the feature with no punctuation and full stops where spaces would be This is a sp
221. as small large quiet and highlight Creating a Child Theme You can create your own theme by customizing the Theme Machine However you should not edit the Theme Machine files directly Instead you should create a child theme and copy any files that you intend to change into the child theme You don t need to copy any files that you do not intend to change a child theme inherits from its parent theme and overrides just the files from the parent theme that you have customized When your child theme is active as the current theme Orchard first looks to that theme to resolve files and if not found it will look to the parent BaseTheme to find the files instead and so on even your parent theme can have it s own parent The process of creating a child theme is this 1 Generate the child theme s code structure using the command line CodeGen utility 2 Copy the files you want to change from the Theme Machine to your child theme 3 Edit the files in the new child theme 4 Apply the new theme to your website Generating the Theme Structure To generate the code structure for your new theme we are going to use the Code Generation feature which can be obtained from the Gallery Modules page in the admin panel Once you have installed and activated the code generation feature you will be able to generate a new theme from the Orchard command line Refer to the Using the command line interface topic if you need to know more about us
222. ase 1 9 2 Users Actions Delete y3 Name Administrator Anonymous Authenticated Author Contributor Editor Moderator Edit Edit Delete Edit Delete Edit Delete Edit Delete Edit Delete Edit Delete By default Orchard includes a number of roles with default permissions Administrator Can perform any operation has all permissions Editor Can author publish and edit his own and others content items Moderator Can moderate comments and tags only No authoring permissions Author Can author publish and edit his own content items Contributor Can author and edit his own content items but not publish them save draft only Anonymous Can view the front end of the site only PX le E mre G Authenticated Can view the site front end and perform other operations depending on the site and other role permission settings To edit the permission for a given role click Edit next to the role name 3 4 Managing Websites 205 Read the Docs Template Documentation Release 1 9 2 Edit Role User admin Logout Information Role Name Administrator Permissions Settings Feature Permission Allow Effective Manage Settings v Orchard Autoroute Feature Permission Allow Effective Set Home Page 4 Orchard MediaLibrary Feature Permission Allow Effective To permit a limited number of self management options expand the Settings tab and click Users Users ca
223. asions where using a field is appropriate If you look in forums and chat rooms you will find that they ve been known to confuse first time users It s not that they are complicated to use far from it It s just that the correct way to access them isn t discoverable through IntelliSense so developers hit a brick wall We are going to cover the two important things you need to learn about fields so that you find them just as easy to work with in code as you have done in the admin dashboard The first important thing to understand is Fields are always ina ContentPart To be fair it looked like you had just created the field loose in the content type Add Field Fields gt Product Id Input Field Edit Remove But in truth Orchard created an invisible ContentPart for you and attached those fields to that The name of that content part is the name of the content type So for our Product content type the content part would be Product For a HtmlWidget it would be HtmlWidget if you added a field to the Page you would access it with Page So the way to access our Product Id field which is on the Content Type of Product we would write 3 9 Extending Orchard 325 Read the Docs Template Documentation Release 1 9 2 var productId CurrentContent ContentItem Product ProductId Value Where did the Value come from Well your field is not just a simple string You defined itasa Text Field when you filled out the form Th
224. assembly Note This loader is the only one in the system performing what is often referred to as dynamic compilation and is indeed optional 1f modules have been pre compiled Loader Disambiguation Since there is potentially more than one loader able to load a given module Orchard has to have a way to resolve the ambiguity i e pick the right loader Each loader has the ability to return a date of last modification for each module they can load For a given module if there are multiple candidate loaders Orchard will pick the loader which returns the most recent date of last modification For example a given module can be distributed with both full source code including csproj file and compiled into an assembly in its bin directory The first time the module is loaded Orchard will pick the loader for the assembly in bin since it s very likely the assembly was compiled after the last source code change was made However if any change was made to the source code afterward the Dynamic Module loader will return the date of the most recently modified file either the source file or csproj and Orchard will pick that loader for the given module Note that the Core Module loader is never ambiguous because there is only one way to load these modules The ambiguity can only arise for modules in the Modules directory Example RootFolder Bin Orchard Web dll Orchard Core d i Fogd Core Common lt Co
225. at looks like this Placement Place Parts FeaturedProduct Content 1 gt Place Parts FeaturedProduct Egdits Content 7 5 75 lt Placement gt Trying the module out in Orchard Great You have completed another stage of the development Now its time to load the website up in the browser and play with the new feature you just built 1 Within Visual Studio press Ctr1 F5 on your keyboard to start the website without debugging enabled its quicker and you can attach the debugger later if you need it 2 Navigate to the admin dashboard 3 Click Widgets in the side menu 312 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 4 If you follow the guide correctly in part 1 you should see your Featured Product Widget in the list under AsideFirst Click on the word Featured Product this may vary depending the title you entered when you set the widget up Attachments getting started with modules part 2 testingl editwidget png 1 The Edit Widget page will be displayed Scroll down to the bottom to find the setting we added Ll ZAbtachments getting started with modules part 2 testingl configure png Tick the checkbox 1 Click Save 2 Navigate back to the homepage of the website by clicking on the site title in the top corner of the admin dashboard Attachments getting started with modules part 2 testingl gotohomepage png You should now see your product is marked as
226. ata migration and we will look into it in more detail later in this course As discussed earlier the Widget is just a Content Type with a Stereotype of Widget A ContentType is 294 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 basically just a collection of ContentParts Every ContentType should contain the CommonPart which gives you the basics like the owner and date created fields We will also add the WidgetPart so it knows how to widget Finally we also include the content part we are building FeaturedProductPart Let s update the Create method to implement these plans 1 Open Migrations cs from within your module project if you don t already have it open 2 Replace the Create method with the following public int Create ContentDefinitionManager AlterTypeDefinition FeaturedProductWidget cfg gt cfg WithSetting Stereotype Widget WithPart typeof FeaturedProductPart Name With Part typeof CommonPart Name WithPart typeof WidgetPart Name return 1 Orchard doesn t have a CreateTypeDefinition method so even within the create we still used AlterTypeDefinition If it doesn t find an existing definition then it will create a new content type 3 Press Ctrl on the red squiggles under FeaturedProductPart and CommonPart then let Visual Studio add the required using statements 4 Try the same under the WidgetPart you will see Visual Studio doesn t understand wh
227. atabase that will be used to store Orchard data You will configure Orchard to use this database later during setup With that out of the way let s start by opening the Orchard Azure sin solution in Visual Studio NOTE If you have AppFabric installed on your local machine or have AppFabric related as semblies in the GAC for some other reason you need to make sure all the following assem bly references in the Orchard Azure Web project have Copy Local set to True before publish ing Microsoft ApplicationServer N Microsoft Data Microsoft Web Nx Microsoft WindowsAzure N andMicrosoft WindowsFabric Nx The only thing you have to configure before starting the deployment process is the storage account to use for shell settings To do this in Solution Explorer navigate to Orchard Azure CloudService project double click the Orchard Azure Web role and navigate to the Settings tab Configure the connection string of the storage account you want to use 246 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Orchard Azure Web Role P X Configuration Service Configuration All Configurations Endpoints D Add Setting JX Remove Setting Local Storage Add configuration settings that can be accessed programmatically and dynamically updated Certificates Name Type Value Gating Orchard Azure Settings StorageConnectionst Connection String UseDevelopmentStorage true Orchard Azure Media
228. ate Documentation Release 1 9 2 var model new EditSponsorViewModel updater TryUpdateModel model Prefix null null if part ContentItem Id 0 customerService UpdateSponsorForContentItem part ContentItem model return Editor part shapeHelper private EditSponsorViewModel BuildEditorViewModel SponsorPart part var itemSponsor new EditSponsorViewModel CustomerId part ContentItem Id Customers customerService GetCustomers by if part Sponsor null itemSponsor SponsorId part Sponsor Ig return itemSponsor The Service Class The driver is also using the following helper service using using using using using using using using SYstem System Collections Generic System Ling Orchard Orchard ContentManagement Orchard Data RelationSample Models RelationSample ViewModels namespace RelationSample Services public interface ICustomerService IDependency void UpdateSponsorForContentItem ContentItem item EditSponsorViewModel model string GetCustomerName IContent customer IEnumerable CustomerViewModel GetCustomers public class CustomerService ICustomerService 412 Chapter 3 Documentation private readonly IContentManager contentManager public CustomerService IContentManager contentManager ContentManager contentManager public void UpdateSponsorForContentItem ContentItem item EditSponsorViewModel model Read the Docs
229. ateTime if System DateTime TryParse value CultureInfo InvariantCulture DateTimeStyles AdjustToUniversal out parsedDateTime return parsedDateTime return null set Storage Set value null String Empty value Value ToString CultureInfo InvariantCulture 3 9 Extending Orchard 371 Read the Docs Template Documentation Release 1 9 2 The field is defined as a class that derives from ContentField which gives us a few services for free such as the storage of the value of the field The fields will be stored as strings The conversion of dates to and from strings could be handled automatically but we are doing it explicitly here to give a good idea of how you would do things for more complex field types Creating a View Model It is good practice although not mandatory to create one or several view models that will be used as the model in the admin template that we will use to render instances of our field Let s create the following DateTimeField View Model cs file in a new ViewModels folder namespace CustomFields DateTimeField ViewModels public class DateTimeFieldViewModel public string Name get set public string Date get set public string Time get set public bool ShowDate get set public bool ShowTime get set j This not only exposes the date and time as separate properties it also has some parameters that can be passed into the view to customize the rendering Creat
230. ates the dependencies used in the Orchard project with a brief description of what Orchard makes use of A copy of a dependencies is located in the lib directory of the source repository along with their respective licenses You can also view the attributions for our library dependencies in the CREDITS txt file at the root of the Orchard source tree 3 12 Developer Tools and Guidelines 493 Read the Docs Template Documentation Release 1 9 2 Akismet This is the default spam protection service in Orchard ANTLR v3 This is a language recognition tool which provides a framework for constructing recognizers interpreters compilers and translators from grammatical descriptions containing actions in a variety of target languages ASP NET MVC 4 ASP NET MVC is used as the web programming model Autofac 2 amp Autofac contrib Dependency Injection is used heavily internally mainly for publishing and consuming services between the Or chard Web host and the Orchard packages Castle Windsor 2 0 Orchard uses Castle Winder 2 0 for type proxy generation and logging support Clay The Clay library offers a flexible implementation of dynamic objects that is used in UI composition CodeMirror Client side code colorization DLR The DLR can be optionally used to script certain aspects of Orchard currently widget layer rules Eric Meyer s Reset CSS This is used to even the CSS rendering playing field across browsers
231. background 154 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 widgets amp content items have a red border and a gradual lightening from black indicates the topography e You can click through the menu to view zones collapse when they lack content You will typically provide content for zones by using the Admin Panel Overview of the CSS Styles The style sheet Site css for the Theme Machine provides an extensive set of styles for fine grained control of the look and feel of your website The style sheet groups styles to make it easier for you to locate a style that you want to customize The following table shows the groupings and describes the type of styles available to you Grouping Description mmm General Contains the default styles for the body headings lists and text elements Forms Contains styles related to HTML forms such as form legend fieldset label and input Structure Contains page layout styles for each of the zones defined in the Theme Machine Main Contains styles defined for blog posts comments tagged search and search results Secondary Contains additional layout styles for secondary content in aside zones tripel zones and footer quad zones Widgets Contains styles for selected widgets such as the search widget edit mode widgets and content mode Pager Contains styles related to a pager shape Misc Contains styles for miscellaneous formatting such
232. base automatically by Orchard It then calls the original POST version of the Editor method with the form data already included in the model This means that after the form has been submitted and the page loads up again it will have the form fields pre populated with the data that has been entered In more complicated projects you will see further processing being completed after the TryUpdateModel call Don t forget browsing the Orchard source code is an invaluable tool to learn more about its inner work ings A good reference module for both this and the last tip is the WidgetPartDriver located in Orchard Web Modules Orchard Widgets Drivers WidgetPartDriver cs lt shows both the combining of shapes and extra validation in the editor update method You should now end up with a FeaturedProductHandler cs file that looks like this using Orchard ContentManagement using Orchard ContentManagement Drivers using Orchard LearnOrchard FeaturedProduct Models namespace Orchard LearnOrchard FeaturedProduct Drivers public class FeaturedProductDriver ContentPartDriver lt FeaturedProductPart gt protected override DriverResult Display FeaturedProductPart part string displayType return ContentShape Parts FeaturedProduct gt shapeHelper Parts FeaturedProdu protected override DriverResult Editor FeaturedProductPart part dynamic shapeHelper return ContentShape Parts PFeadgturedProduct Edrt gt shapeHelper Editor
233. being on sale Home Featured Product Todays featured product is the Sprocket ON SALE 9000 Click here to view it Bonus Exercise Go back into the admin dashboard uncheck the setting save and come back again to see how the it no longer shows as being on sale Download the code for this lesson You can download a copy of the module so far at this link Download Orchard LearnOrchard FeaturedProduct Part2 v1 0 zip To use it in Orchard simply extract the archive into the modules directory at src Orchard Web Modules If you already have the module installed from a previous part then delete that folder first For Orchard to recognize it the folder name should match the name of the module Make sure that the folder name is Orchard LearnOrchard FeaturedProduct and then the modules files are located directly under that Conclusion This part of the course has expanded your knowledge to touch on some of the data storage and content management features in Orchard 3 9 Extending Orchard 313 Read the Docs Template Documentation Release 1 9 2 You have added in the common module development classes that we didn t cover in the first part You ve experienced using the data migrations to incrementally update your data You ve also seen the basics of creating an admin interface and using it to update the configuration settings of a widget You can now see the core process of adding a variable to your module and then implem
234. bool and a name I sOnSale which matches our property on the record class NHibernate will automatically match the name of the property on the record class with the column in the database Bonus Exercise Look around in the Migrations cs files located in the other built in modules for many examples of the things you can do with this class To do this just select the Search Solution Explorer textbox at the top of the Solution Explorer or press Ctrl When it s selected just type Migrations cs in and it will filter out all of the migrations cs files in the solution 306 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 You should now end up with a Migrations cs file that looks like this using Orchard ContentManagement MetaData using Orchard Core Common Models using Orchard Data Migration using Orchard LearnOrchard FeaturedProduct Models using Orchard Widgets Models namespace Orchard LearnOrchard FeaturedProduct public class Migrations DataMigrationImpl public int Create ContentDefinitionManager AlterTypeDefinition FeaturedProductWidget cfg gt cfg WithSetting Stereotype Widget WithPart typeof FeaturedProductPart Name WithPart typeof CommonPart Name WithPart typeof WidgetPart Name return s public int UpdateFroml SchemaBuilder CreateTable typeof FeaturedProductPartRecord Name table table ContentPartRecord Column bool IsOnSale
235. but it might be worth the investment if your business depends on your application responding immediately to any request A dedicated computer or a dedicated virtual machine offers the advantage of being configurable in exactly the way you want You get guaranteed processing and bandwidth instead of sharing it with a varying load on other applications running on the same computer and you get the opportunity to fine tune all the parameters for the application Cloud Hosting Cloud hosting such as Microsoft Azure offers most of the advantages of dedicated hosting plus the ability to scale to increased loads with the flip of a switch If you are building a business that is expected to grow considerably this might be the most secure way of ensuring the scalability that you need SQL Server Compact Versus SQL Server An Orchard instance can either run on SQL Server Compact or on full versions of SQL Server or SQL Server Express SQL Server Compact is an embedded version of SQL Server that has the advantage of being deployable by simply copying its DLLs and database files While SQL Server Compact is extremely lightweight and easy to use and deploy full versions of SQL Server offer the guaranteed performance that you might need on your site It might therefore be worth the cost of investing in a hosting solution that gives you access to a full edition of SQL Server File System The file system itself can be a drag on application performance Possible bo
236. c Git concept behind this process is to commit your local changes and then push the branch to your remote copy on GitHub This can be done in many ways Using GitHub Desktop From within Microsoft WebMatrix 3 From within Microsoft Visual Studio Using Git Extensions Using Git on the command line If you re just starting out with Git then you should use GitHub Desktop to make this process simple for yourself Once this is done your changes are on GitHub but not yet in the project s official repository To get it there you ll need to ask us to pull the changes in In order to do that send us a pull request Submitting a pull request When you have finished your work on the issue you can create a pull request A pull request opens a dialog with the community to review your work and provide feedback Creating a pull request is best done from within the GitHub com website You can create pull requests using other techniques but using the GitHub com has a clear interface so that you can make sure you are creating a pull request with the correct branch and you can have one final check of the files before you initiate it Navigate to your forked copy of the OrchardDocs repo Is url will be https github com YourUserName OrchardDoc You should see a create pull request bar along the top of your repos page Your recently pushed branches D update contributing patches less than a minute ago i Compare amp pull request Branch master
237. cally creates many alternates that you can use in your application However you can create templates for these alternate shapes The patterns for creating alternates are shown below with examples of matching templates in parenthesis For Content shapes e Content DisplayType Example template Content Summary e Content ContentType Example template Content BlogPost e Content Id Example template Cont ent 42 e Content DisplayType ContentType Example template Content BlogPost Summary e Content DisplayType Id Example template Content 42 Summary For Zone shapes e Zone ZoneName Example template Zone SideBar For Navigation shapes the new menu system since version 1 5 e MenultemLink MenuName Example template MenuItemLink main menu 3 11 Creating Themes 459 Read the Docs Template Documentation Release 1 9 2 e MenultemLink__ ContentType Examples template MenuItemLink ContentMenuIltem MenuItemLink HtmlMenuItem MenuItemLink Blog For menu and menu item shapes e Menu MenuName Example template Menu main e Menultem MenuName Example template MenuItem main For local menu and local menu item shapes e LocalMenu MenuName Example template LocalMenu main e LocalMenultem__ MenuName Example template LocalMenuItem main For styles and resources Style FileName e Resource FileName For widget shapes e Widget ZoneName Example template Widget SideBar e Widget Co
238. chard exe command shell is extendable The total numbe 1 Scaffold the module by entering the following command codegen module Orchard LearnOrchard FeaturedProduct If you read the help in the last step you might be wondering why we didn t include the IncludeInSolution true argument This defaults to true so you don t need to add it 2 Close the Orchard command line window 3 This has now created a new empty module in the file system Switching back to Visual Studio should show you theFile Modification Detected dialog Attachments getting started with modules part 1 reload solution pnog Click Reload 3 9 Extending Orchard 289 Read the Docs Template Documentation Release 1 9 2 gt xxNote If you had unsaved changes in your Solution file then click the Dismiss The basic framework for a module now exists inside the modules section of your solution Solution Explorer ix le 685m Search Solution Explorer Ctri pP gt agg Orchard Layouts 81 Orchard LearnOrchard FeaturedProduct P J Properties gt B References b 7 Assets Controllers Models P CU Scripts b cU Styles p Views LT Assets json B Module txt Web config gt gas Orchard Lists Core concepts refresher If you are at the stage of wanting to build modules for Orchard then you should already be familiar with the concept of Content Types Widgets Content Items and Content Parts Thes
239. chive Later Version 1 0 20 The ArchiveLater module introduces scheduled archiving functionality Features Archive Later Author The Orchard Team Website http orchardproject net Eg Blogs Version 1 0 20 The Orchard Blogs module is implementing basic blogging features Features Blogs Remote Blog Publishing Author The Orchard Team Website http orchardproject net im Code Generation Version 1 0 20 Tools to create Orchard components Features Code Generation Author The Orchard Team Website http orchardpraject net Comments Version 1 0 20 The comments system implemented by this module can be applied to arbitrary Orchard content types such as blogs and pages It includes comment validation and spam protection through the Akismet service Features Comments Author The Orchard Team Website http orchardproject net E Common Version 1 0 20 The common module introduces content parts that are going to be used by most content types common body and routable Features Common Author The Orchard Team Website http orchardproject net Notice that on every page in the Installed tab there is a link that lets you upload a module package to the site Displaying Additional Gallery Feeds The Gallery tabs on the Modules page and the Themes page of the dashboard together display the aggregated list of themes and modules exposed by all feeds registered on your site On the Gallery tabs for both themes a
240. class Within the handler you add any logic that you need to specify when the alternate is used The following example first shows how to specify an alternate for shape named Content but only when the user is on the home page It also shows how to specify an alternate for a shape named Parts_Tags_ShowTags when the DisplayType is Summary using Orchard using Orchard ContentManagement using Orchard DisplayManagement Descriptors namespace MyTheme ShapeProviders public class ExampleShapeProvider IShapeTableProvider private readonly IWorkContextAccessor workContextAccessor public ExampleShapeProvider IWorkContextAccessor workContextAccessor _ workContextAccessor workContextAccessor public void Discover ShapeTableBuilder builder builder Describe Content OnDisplaying displaying gt if displaying ShapeMetadata DisplayType Detail ContentItem contentItem displaying Shape ContentItem if workContextAccessor GetContext CurrentSite HomePage Endswithi contentrlItem Id ToStrinq 4 displaying ShapeMetadata Alternates Add Content HomePage 462 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 builder Describe Parts Tags ShowTags OnDisplaying displaying gt if displaying ShapeMetadata DisplayType Summary displaying ShapeMetadata Alternates Add Tags Showrags Summary 3 11 6 Template File Syntax Guide Orchard u
241. cord blueprints 3 9 Extending Orchard 277 Read the Docs Template Documentation Release 1 9 2 The list of ShellSettings that are per tenant and the ShellBluePrint are then thrown into ShellContainerFac tory CreateContainer to get an ILifetimeScope which is basically enabling the IoC container to be scoped at the tenant level so that modules can get injected dependencies that are scoped for the current tenant without having to do anything specific Dependency Injection The standard way of creating injectable dependencies in Orchard is to create an interface that derives from IDepen dency or one of its derived interfaces and then to implement that interface On the consuming side you can take a parameter of the interface type in your constructor The application framework will discover all dependencies and will take care of instantiating and injecting instances as needed There are three different possible scopes for dependencies and choosing one is done by deriving from the right interface Request a dependency instance is created for each new HTTP request and is destroyed once the request has been processed Use this by deriving your interface from IDependency The object should be reasonably cheap to create Object a new instance is created every single time an object takes a dependency on the interface Instances are never shared Use this by deriving from ITransientDependency The objects must be extremely cheap to create
242. creates a nupkg file For more information see NuGet org The name of the nupkg file is the name of your theme plus its version number as in the following example Orchard Theme lt nameOfYourTheme gt lt version gt nupkg Uploading Your Theme to Gallery After creating your package you can share your theme by giving someone the package file You can also contribute your theme to the Orchard Gallery For information about how to contribute your theme see Contributing a Module or Theme to the Gallery Installing a Packaged Theme To install a packaged theme in Orchard open the Orchard dashboard Click Themes and then click Install a theme from my compter 470 Chapter 3 Documentation Themes Installed Gallery Updates Current Theme Mesy Marke Tei n Available There are no additional themes installed Read the Docs Template Documentation Release 1 9 2 User admin Logout The Theme Machine By jowall mibach loudej heskew Version 1 0 20 http orchardproject net Orchard Theme Machine is a flexible multi zone theme that provides a solid foundation to build your site It features 20 collapsible widget zones and is flexible enough to cover a wide range of layouts Click Choose File Browse to and select the theme package nupkg file and then click Open Then click Install If Orchard is running on a remote server you will be browsing your local computer you do not need to put the nupkg file on
243. cs Scripts Styles Views Migrations cs Module txt The migration class added by the codegen command contains a single Create method that defines a database table structure based on the Record classes in project Because we only have a single MapRecord class with latitude and longitude properties the migration class is fairly simple Note that the Create method is called at the time the feature is activated and the database will be updated accordingly oOVSLem System Collections Generic oystem Dsta Maps Models Orchard Orchard Orchard Orchard Orchard ContentManagement Drivers ContentManagement MetaData ContentManagement MetaData Builders Core Contents Extensions Data Migration namespace Maps DataMigrations public class Migrations DataMigrationImpl 364 public int Create Creating table MapRecord SchemaBuilder CreateTable MapRecord table gt table E ContentPartRecord Column Latitude DbType Double Column Longitude DbType Double ContentDefinitionManager AlterPartDefinition typeof MapPart Name cfg gt cfg Attachable return 1 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Add the AlterPartDefinition lines to the migration in order to make the part attachable to any content type Also add using Maps Models to the top of the file Now let s add the handler for the Map part A handler in Orchard is a class that d
244. ct Orchard Blogs dj New Folder A Cut Culex Vasca paid i Orchard ContentTypes Add ASP NET Fold P Ctrl c ASP eto Copy cont Orchard DevTools y Paste Ctrl V a Orchard Indexing EN X Delete Del Orchard Media T S Orchard Modules ename Orchard MultiTenancy Open Folder in Windows Explorer Orchard Packaging E gt properties Alt Enter i Orchard Roles Propert a Orchard Sandbox 5B Dun Caserh In Orchard content part data is represented by a Record class which represents the fields that are stored to a database table and a ContentPart class that uses the Record for storage Add the MapRecord ContentPartRecord and MapPart ContentPart classes as follows using System ComponentModel DataAnnotations using Orchard ContentManagement using Orchard ContentManagement Records namespace Maps Models public class MapRecord ContentPartRecord public virtual double Latitude get set public virtual double Longitude get set public class MapPart ContentPart lt MapRecord gt Required public double Latitude Get return Retrieve r gt P latitude j set Store r gt r Latitude value Required public double Longitude 362 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 get return Retrieve r gt r Longitude set Store r gt r Longitude value Now build the Maps project to ensure your Record class compiles success
245. ct net Enable Uninstall Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 3 11 8 Ul Guidelines for Theme Authors This topic was updated for the Orchard 1 0 release This article presents recommendations for coding and formatting HTML markup and CSS that will help you keep your themes organized General Guidelines This section contains guidelines for a number of design topics such as browser testing file names HTML elements JavaScript and images Browser Testing You should test all templates using the latest versions of the following browsers For older versions of browsers such as Internet Explorer 6 you should ensure that your site and templates remain functional but don t attempt to resolve rendering issue that do not affect the user s ability to consume the content Microsoft Internet Explorer Google Chrome Mozilla Firefox Apple Safari Opera File Names The following lists file naming rules followed by the Orchard development team Include files use an underscore _ as a prefix e cshtml vbhtml HTML and CSS files should be named using camel casing HTML doctype Directive Use the HTML5 doct ype declaration because it lets you use HTMLS markup but is also compatible with existing markup that complies to HTML 4 01 and XHTML IDOCTYPE html HTML Elements Orchard assumes the use of HTMLS5 Although you are not required to use HTMLS it is a strong recomm
246. ctual contents of the document should all be under section headers and the top section headers should be in header 1 style This Is A Top Header Headers should use capital letters to begin each word see capitalization capitalization capitalization Capitalization Subsections should be one level deeper than their parent section Do use explicitly named anchors when building links to a specific section of the document Anchors are automatically created for all headers from their title by removing spaces Anchors can be linked to using the following syntax How To Build Awesome Documentation link1 link1 HowToBuildAwesomeDocumentation If the anchor is in another document use the file name and the anchor name like this 506 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Follow this link to learn how to build awesome documentation linkl linkl name of the linked document4HowToBuildAwesomeDocumentation Please note that anchor names are case sensitive The text within a section should be structured in short paragraphs Don t forget to include an empty line in wiki markup between paragraphs Markup and Styles Topics should use standard Markdown and should avoid inline HTML including styles Bolding And Italics Do not use header styles for emphasis Use surrounding asterisks for emphasis which will be rendered as italics Use xdouble asterisksx for strong emphasis which
247. cumentation Release 1 9 2 9 Actions Machine Key Ey Apply Use this feature to specify hashing and Ex Cancel encryption settings for application services such Generate Keys as view state Forms authentication Hel p membership and roles and anonymous Online Help identification Encryption method SHA1 Decryption method Auto Validation key _ Automatically generate at runtime Generate a unique key for each application IsolateApps Decryption key Automatically generate at runtime Generate a unique key for each application IsolateApps Uncheck Automatically generate at runtime for both the validation key and the decryption key Click Generate Keys under Actions on the right side of the panel Click Apply 268 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Setting Up the Machine Key Directly in the Web config File If you do not have access to the IIS management console it is still possible to set up a machine key for an Orchard application To do so open the web config file that is at the root of the Orchard web site The machine key settings can be found or created under configuration system web conriguration lt system web gt lt machineKey decryptionkey Decryption key goes here IsolateApps validationKey Validation key goes here IsolateApps gt lt system web gt donftigurstion To create the keys that go into the place
248. d Although the Theme Machine has many possible zones defined on a given page the only zones visible will be zones that have had widgets added to them you can learn more about widgets here The Navigation TripelFirst TripelSec ond and TripelThird zones are visible on the home page because they contain widgets 1 Select Widgets from the Dashboard The Widgets management page opens with the Default layer selected Any zone that is visible in the Default layer will appear on all pages Therefore the Navigation zone is visible on all web pages and has a Main Menu widget The Main Menu widget is annotated in green because it has been added to a zone in the current layer 48 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 9 Your Site Widg ets User admin Log Current Layer Default zuga Add a new layer yer are displayed on all pages All Layers Add Default Header Authenticated empty Navigation Anonymous empty Disabled empty TheHomepage Featured Add e Download empty amp Widgets BeforeMain Add AsideFirst Add Messages Add BeforeContent Add Content Add AfterContent Add AsideSecond Add Add AfterMain 2 Select the HomePage layer to see which zones are visible for the home page Widgets which have been added to zones in the selected layer will be annotated in green FirstLeaderAside Sec ondLeaderAside and ThirdLeaderAside Widgets which have b
249. d Summary conversely does not belong to that group and would correspond toaHello World Shape shape not to a He11o World shape Notice the difference between A and Which Alternate Will Be Rendered Even if it has alternates a shape is always created with the base name such as He11o World Alternates give addi tional template name options to the theme developer beyond the default such as hello world cshtml The system will choose the most specialized template available among the alternates so Aello world orange cshtml will be preferred to hello world cshtml if it exists Built In Content Item Alternates The table above shows possible template names for content items It should now be clear that the shape name is built from Content and the display type for example Content Summary The system also automatically adds the content type and the content ID as alternates for example Content Summary Pageand Content Summary 42 For more information about how to use alternates see Alternates Rendering Shapes Using Templates A shape template is a fragment of markup that is used to render the shape The default view engine in Orchard is the Razor view engine Therefore shape templates use Razor syntax by default For an introduction to Razor syntax see Template File Syntax Guide The following example shows a template for displaying a Map part as an image 456 Chapter 3 Documentation Read the Docs Template Documentation Re
250. d The small gt will expand out to show configuration properties for that field Fields gt Product Id Input Field Edit Remove Click the gt to expand the field configuration pane 3 Tick the Required check box Check if the field is required This will flag the field as requiring content when you create a new content item based off the Product content type Orchard will automatically handle the validation for you and show a notification if the requirement is not met 4 To demonstrate the power of the configurable fields in Orchard we will also add a Pattern constraint The ProductId should be in all caps with only letters or numbers no spaces or other punctuation To describe this pattern to the system we will use something called a regular expression To meet the requirement described above the regex will be A Z0 9 S In the Pattern field enter the pattern A Z0 9 S 1 Click Save In the next section we will create a demo product using this new content type Regular Expression breakdown If you re curious as to what different sections are in the regex we just used it breaks down into this e means match the start of the string nothing before it e means match the pattern of characters inside these brackets e A Z means match any character between uppercase A to uppercase Z e 0 9 means match any character between 0 to 9 means match one or more repetitions of this character set This m
251. d zones that you can use if you want four columns All zones in TheThemeMachine theme are collapsible which means that they will only be rendered if there is content in them Icon or Thumbnail A Theme png file should be included with all Orchard themes This image should be at least 400x400 pixels and is meant to represent the theme in the gallery or in the theme administration page It usually is a thumbnail image of a page of a site rendered using that theme Widget Zones Preview Image Optionally a preview image for the widget zones can be added to the theme The image should be placed at the root of the theme and be called ThemeZonePreview png This image should be 400 pixels wide and should show the different zones and their names An example can be found in TheThemeMachine Widgets User admin Logout Current Layer Default EES Add a new layer El All Layers Default empty Header Add empti Authenticated empty Navigation Add Anonymous empty Featured Add Disabled empty TheHamepage BeforeMain Acid AsideFirst Add it Messages Add BeforeContent Add Content Add Afterlontent oe AsideSecond Add AfterMain Add 3 11 Creating Themes 443 Read the Docs Template Documentation Release 1 9 2 Static Resources A theme typically contains a number of static resources such as CSS style sheets JavaScript files or images Those files must be in the following folders CSS style sheets
252. d On Owner admin Save Publish Now Publish Later When you now Save your page and navigate to the Navigation menu item on the left side you will see that the new menu item that you created was added to the Main Menu 1 6 3 Creating A Submenu Creating a submenu is very easy Navigate to the Navigation section If you hover over an already added Menu Item with your mouse you ll see that you can drag and drop the Menu Item Simply drag the Menu Item a bit to the right until it snaps to a sub container Remember that changes you made here won t be updated until you click the Save All in the bottom right side of the page 1 6 Navigation and Menus 75 Read the Docs Template Documentation Release 1 9 2 Current Menu Main Menu Y Add a new menu Home Custom Link Edit Delete Download Content Menu Item Edit Delete About Us Page Edit Delete Current Menu Main Menu Y Add a new menu Home Custom Link Edit Delete gt Download Content Menu Item Edit Delete About Us Page Edit Delete 1 6 4 Older Versions Of Orchard Before 1 5 Managing menus in older versions of Orchard was quite different Orchard lt 1 5 has a very simple main menu feature that is a list of menu item text and links to display accessible from the Navigation link in the Orchard admin panel When you add an item to the main menu using the page or blog post editor screens a new entry is added here You can use this screen to rename
253. d by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard 1 7 5 Change History Updates for Orchard 1 8 4 25 14 New Screenshots Comment settings are different You can add many blogs Updates for Orchard 1 6 11 25 12 Broke into multiple sections 1 8 Adding and Managing Media Content When you upload images using the rich text editor in Orchard or using an XML RPC client such as Windows Live Writer the images are saved in a Media folder under the root of your Orchard installation The Media folder must be writable by the user process that s running the website in order for image uploads to succeed If you installed Orchard using the Web Platform Installer the Media folder write permissions are configured automatically To add and delete media folders click Media in the dashboard e Your Site Med la User admin Logout Actions Delete Add a folder l Name Author Last Updated Type size lai la HimiWidget 4 6 2011 1 50 56 PM Folder OB tf Media Wav 86 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Browse to a media image file and view the details The properties of a media file are Screenshot A thumbnail preview of the image content e Size and Added on Properties of the media file Embed The URL of the media file which you can copy to the HTML view of the rich text editor in order to embed the media image into content e Name The name o
254. d by the Module txt or Theme txt file in your module or theme Many of the fields on this form are optional but allow you to specify tags license information a project web site and other information that will help visitors of the gallery to find and learn more about your package 3 3 Using the Orchard Gallery 173 Read the Docs Template Documentation Release 1 9 2 ORCHARD HOME Jom us on Ea E m Orchard gallery brada MY ACCOUNT SIGN OUT Home Modules Themes Contribute New Contribution scs dicc diu Verify the details of your contribution sem Package ID Version 7 Orchard Module TestPackage 1 0 Submit your theme ar module for others to enjoy Only detail inFarmatian can be edited on packages F you have a newer veran of your contributien that you d libe to submit in place of this ome click hereto add a new conbribution Ensure that the mew version hes the came Package ID but a new Version number Title TestPackage Summary Description for the madule Description Description for the module Authors The Orchard Team License URL Tags Package Type Module Primary Category Administration z Project URL http orchardproject net Copyright 174 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 There are a couple key fields worth calling out Package ID is the unique name for your package It is obtained from the package when you
255. d files For example you may open the module txt manifest file and modify it 370 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Name CustomFields AntiForgery enabled Author Me Website http orcharddatetimefield codeplex com Version 0 6 lt 1 OrchardVersion 0 8 0 Description A bunch of custom fields for use in your custom content types Featuren CustomFields Description Custom fields for Orchard Category Fields DateTimeField Description A date and time field with a friendly UI Category Fields Dependencies CustomFields Orchard jQuery Common Settings We are defining two features here because this module will eventually contain more fields and we want to distinguish between the default feature of the module which has the same name as the module itself and has to exist in any module and the date field feature This also demonstrates categories and dependencies Modeling the Field Let s now create a Fields folder inside of our CustomFields folder and create the following DateTimeField cs file in there using System using System Globalization using Orchard ContentManagement using Orchard ContentManagement FieldStorage using Orchard Environment Extensions namespace CustomFields DateTimeField Fields OrchardFeature DateTimeField public class DateTimeField ContentField public DateTime DateTime get var value Storage Get lt string gt DateTime parsedD
256. d list content items of some of these types such as Page whereas others only allow you to edit the definition of the type here such as Comments and Widgets since these have a dedicated custom admin experience for creating and listing these items instead Documentation Upload screenshots_675 ContentTypes_manage2 png If you click List Items to list the items of the Page type you can see the available content items of this type Page in the site similar to the Manage Content screen in the admin menu Manage Page Content Actions Choose action Show Page ordered by recently modified filter by latest Scheduled Page Page Q Published No Draft Published 1 day ago Last modified 3 days ago By admin New Page Page Q Published No Draft Published 3 days ago Last modified 3 days ago By admin Welcome to Orchard Page Published No Draft Published 4 days ago Last modified 4 days ago By admin You can also edit the definition of the Page type by clicking Edit for this type 3 1 Authoring Websites User admin Logout D nA View Unpublish Clone Edit Delete View Unpublish Clone Edit Delete View Unpublish Clone Edit Delete 131 Read the Docs Template Documentation Release 1 9 2 Edit Content Type Page User admin Log Edit Placement Display Name Creatable v Draftable Stereotype Add Field Fie
257. d of the product page to see if it s the current featured product the Product Id field contains the product For the sake of visual comparison we will swap the green Click here to view it button out with a purple box that says Read more about it on this page Expanding out the display shape lambda So based on this blueprint of our plans how do we take the first step The decision about what the module should display when it s asked to comes from the code within the driver class The Display method in the FeaturedProductDriver cs class currently looks like this protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts FeaturedProduct 318 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 gt shapeHelper Parts FeaturedProduct The shapeHelper takes a lambda as it s parameter gt shapeHelper Parts FeaturedProduct and because the code being run at the moment is just a single line statement it is using a short form version of it To give ourselves some room to code we can expand out the lambda so that it wraps the code in curly braces and returns a shape at the end In the case of our current Display method the code would go from this return ContentShape Parts FeaturedProduct gt shapeHelper Parts FeaturedProduct To this return ContentShape Parts FeaturedProduct gt c
258. d use the first solution above It keeps all the setup code inside the curly braces of the lambda and only runs it when the shape is actually being displayed Let s implement what we have discussed so far 1 Open up the FeaturedProductDriver cs file located in the Drivers folder 2 Replace the Display method with the following protected override DriverResult Display FeaturedProductPart part string display Type dynamic shapeHelper return ContentShape Parts FeaturedProduct gt extra space to write additional lines of code here return shapeHelper Parts FeaturedProduct Getting the current Contentltem being displayed Getting the current Content Item from within the widget driver means using some of the built in Orchard classes To look up the Content Item we need to get the Id of the content out of the ASP NET MVC route data then convert this into a content item by requesting it via the content manager 3 9 Extending Orchard 319 Read the Docs Template Documentation Release 1 9 2 We could add a public property to the driver which looked like this private IContent currentContent null private IContent CurrentContent get q if currentContent null var itemRoute _aliasService Get _workContextAccessor GetContext HttpContext Request AppRelativeCurrentExecutionFilePath oubstringit l rrim 7 2 3 currentContent contentManager Get Convert ToInt32 itemRoute Id return curren
259. dEditorEvents ContentDefinitionEditorEventsBase public override IEnumerable TemplateViewModel PartFieldEditor ContentPartFieldDefinition definition if definition FieldDefinition Name DateTimeField var model definition Settings GetModel lt DateTimeFieldSettings gt yield return DefinitionTemplate model public override IEnumerable lt TemplateViewModel gt PartFieldEditorUpdate ContentPartFieldDefinitionBuilder builder IUpdateModel updateModel var model new DateTimeFieldSettings if builder FieldType DateTimeField yield break 3 9 Extending Orchard 377 Read the Docs Template Documentation Release 1 9 2 if updateModel TryUpdateModel model DateTimeFieldSettings null null builder WithSetting DateTimeFieldSettings Display model Display ToString yield return DefinitionTemplate model This is the equivalent of a driver but for field settings The first method gets the settings and determines the template to render and the second updates the model with the values from the submitted form and then calls the first The editor template for the field is defined by the following DateTimeFieldSettings cshtml that you should create in a new DefinitionTemplates folder under Views model CustomFields DateTimeField Settings DateTimeFieldSettings using CustomFields DateTimeField Settings lt fieldset gt label for Html FieldIdFor m gt m Display class f
260. dded the version number is 2 If you have to add another update method that method would be called UpdateFrom2 After you add the update method and run the project the module will be silently amp automatically upgraded Content Handlers A content handler is similar to a filter in ASP NET MVC In the handler you define actions for specific events In a simple content handler you just define the repository of record objects for the content part as shown in the following example namespace Map Handlers public class MapHandler ContentHandler public MapHandler IRepository lt MapRecord gt repository Filters Add StorageFilter For repository In more advanced content handlers you define actions that are performed when an event occurs such as when the feature is published or activated For more information about content handlers see Understanding Content Handlers Content Drivers A content driver is similar to a controller in ASP NET MVC It contains code that is specific to a content part type and is usually involved in creating data shapes for different conditions such as display or edit modes Typically you override the Display and Editor methods to return the ContentShapeResult object for your scenario For an example of using a content driver see Accessing and Rendering Shapes This topic has been updated for the Orchard 1 9 1 release A content handler defines what happens with a content part in response to s
261. der the field when authors are editing the content item Now that we have defined our custom content type let s create a new item of this type Notice the Create New Event link in Manage Content Types Event List Items Edit Create Mew Event similarly there is a new admin menu link entitled Event under New Click either one of these links to create a new Event content item 3 1 Authoring Websites 139 Read the Docs Template Documentation Release 1 9 2 UBBELeer i New EV Page Projection We can see that the editor for our Event type has all the fields and parts we defined It has a Title because of the TitlePart and Permalink because of the AutoroutePart a Location because of the fields we added a Tags input from the Tags part a Show on main menu checkbox from the Menu part and the ability to enable comments from the Comments part The fact that we can Publish Now Publish Later or Save As Draft is given by the Publish Later part Once you have filled in these fields go ahead and publish the event 400 Chapter3 Documentation Read the Docs Template Documentation Release 1 9 2 New Event 1 Title First Event You must provide a title for this content item Permalink http localhost 13776 Save the current item and leave the input empty to have it automatically generated using the pattern Title e g my title LJ Set as home page Check to promote this content as the home page
262. derstand the scenarios that are important for your site please contact at join orchard localization lists outercurve org and drop us a line Translating an Html Widget Note these steps apply to a clean installation using the default theme The Theme Machine In the admin panel navigate to Modules and verify that you have the Localization module installed and enabled The next step is to navigate to Content in the admin panel Select the Content Types tab page on top and click Edit to adjust the Html Widget Our goal is to translate a Html Widget Click Add Parts in the Parts section Here we select the Localization part and click Save to add this part At the bottom of the page click Save again to save your Content Item adjustments Now we need to navigate to the Settings menu item in the admin panel Under the section Default Site Culture you can add the cultures that you want to support In our case we have nl BE and en US Click Save to apply your culture settings Navigate to the Widgets menu item On the Default layer find for example the FooterQuadThrid section and click Add to add a Widget Now you need to Choose A Widget select the Html Widget because this 1s the one that we adjust Now fill in the needed information Title and Content and click Save Your Html Widget is now added to the FooterQuadThird section Now we are ready to translate the item Select you newly added widget to edit it On top of the Edit Widget page you wil
263. dia might be out of date Make sure you download the App_Data and Media folders from the server If you re using a SQL Server Compact database you ve copied the site data by downloading the App_Data folder If your site is using SQL Server you can copy that data to a local server in order to work with up to date data However this isn t required for migration If you want to work with a local database you ll also need to edit the settings txt file for each of the tenants The settings txt files can be found under App_Data Sites Default or App_Data Sites NameOfTheTenant In a new empty directory install a fresh copy of the latest version of Orchard but don t go through setup Copy your existing site s Media folder into the new directory Copy the remaining module and themes directories that you have on your existing site and that are not already in the new one into the new directory s Modules and Themes directories Copy the App_Data folder from the existing site into the new directory 3 5 Hosting and Deploying Websites 235 Read the Docs Template Documentation Release 1 9 2 e Point a local web server to the new directory You can use IIS in that case use IIS Manager to create a new web site that points at the directory and then navigate to it Alternatively you can use WebMatrix and IIS Express to do that right click the directory in Windows Explorer and choose Open as a Web Site with Microsoft WebMatrix and then
264. diaLibrary Orchard ContentPicker Orchard PublishLater Orchard jQuery Orchard Widgets Orchard ContentTypes Orchard Scripting Orchard Scripting Lightweight PackagingServices Orcha Orchard Projections 0Orcherd Fields Orchard OutputCacHe 0rchard Taxonomi Orchard Layouts Orchard Layouts Tokens TheThemeMachine Metadata lt Types gt lt Page ContentTypeSettings Draftable True TypeIndexing Indexes Search lt TagsPart gt lt LocalizationPart gt lt TitlePart gt lt AutoroutePart gt lt MenuPart gt lt Page gt lt BlogPost ContentTypeSettings Draftable True TypeIndexing Indexes Search lt CommentsPart gt lt TagsPart gt lt LocalizationPart gt lt TitlePart gt lt AutoroutePart gt lt BlOgPost gt lt Types gt SESGITs 3 4 Managing Websites 211 Read the Docs Template Documentation Release 1 9 2 lt BodyPart BodyPartSettings FlavorDefault html gt lt Parts gt lt Metadata gt settings gt Migration features x gt Command layer create Default LayerRule true Description The widgets in this layer are lt layer create Authenticated LayerRule authenticated Description The widgets in 1 layer create Anonymous LayerRule not authenticated Description The widgets in layer create Disabled LayerRule false Description The widgets in this layer ar layer create TheHomepage LayerRule url Descripti
265. ding an UpdateFrom version method to the part s Migrations cs file The following example shows the Map part s Migrations cs file with the UpdateFrom1 method added using System Data using Maps Models using Orchard ContentManagement MetaData using Orchard Core Contents Extensions using Orchard Data Migration namespace Maps public class Migrations DataMigrationImpl public int Create Creating table MapRecord SchemaBuilder CreateTable MapRecord table gt table ContentPartRecord Column Latitude DbType Single Column Longitude DbType Single ContentDefinitionManager AlterPartDefinition typeof MapPart Name cfg gt cfg Attachable return 1 public int UpdateFroml Create a new widget content type with our map ContentDefinitionManager AlterTypeDefinition MapWidget cfg gt cfg WithPart MapPart WithPart WidgetPart WithPart CommonPart WithSetting Stereotype Widget return 2 In this example the UpdateFrom1 method creates MapWidget by combining MapPart WidgetPart and CommonPart and then setting the widget stereotype The WidgetPart and CommonPart objects are built into Orchard The method returns 2 which is the new version number The part has now been transformed into a widget 3 9 Extending Orchard 383 Read the Docs Template Documentation Release 1 9 2 Displaying the Widget After you create the new widge
266. do not agree to all of the license terms click I Decline Some Microsoft software above use the Customer Experience Improvement Program to send us basic setup and usage info By checking this box you agree to send this info To learn which do read the Privacy Statements Privacy 5 me When the installation is complete the dialog shows the list of installed tools in addition to Orchard Click the Launch link to open the site in WebMatrix 1 1 Installing Orchard 3 Read the Docs Template Documentation Release 1 9 2 Web Platform Installer 4 6 Dx PREREQUISITES INSTALL CONFIGURE FINISH v The following products were successfully installed Orchard CMS Microsoft System CLR Types for Microsoft SOL Server 2012 x86 Microsoft SOL Server 2012 Transact SQL ScriptDom Microsoft SOL Server Compact 4 0 SP1 Microsoft SOL Server Compact Latest Microsoft SOL Server 2012 Data Tier Application Framework 11 0 for x86 April 2012 Microsoft SQL Server 2012 Data Tier Application Framework 11 0 for x64 April 2012 IIS 8 0 Express August 2012 Web Deploy 3 0 July 2012 Web Deploy 3 5 2013 Microsoft WebMatrix 3 1 1 4 Running Orchard in WebMatrix After WebMatrix starts it should inmediately launch Orchard in the default browser If not you can launch Orchard by clicking the Run drop down button and selecting which browser to use In WebMatrix you can click the Files workspace to see the contents of the Orchard site 4 Chap
267. down in the Save As dialog Translation File Format The following illustration shows the format of a translation file Each text string is repre sented by elements listed in the following table A reference see below reference string An ID which is of ten the original untranslated string After the ID is set this string should not be changed even if the English string changes so that existing translations continue to work even if they re not immediately updated msgid id string The current English string for reference This helps the translator msgid English string The translated string msgstr translated string 120 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 File Edit View Settings IG2Qg 9 4 OB d 5 a S c3 w t 1 Orchard resource strings fr FR francais France 2 Copyright c 2010 CodePlex Foundation 3 All rights reserved 4 This file is distributed under the BSD license 5 6 Core Common Drivers CommonPartDriver cs 7 msgid Invalid user name smsgid Invalid user name 9msgstr Nom d utilisateur invalide 10 118 Core Common Drivers CommonPartDriver cs 12 4 msgid Invalid container 13msgid Invalid container 14 msgstr Conteneur invalide 15 168 Core Common Extensions HtmlHelperExtensions cs 17 msgid Draft 18 msgid Draft 1s msgstr Brouillon 20
268. dynamic CurrentContent ContentItem var itemProductId dynamicContentItem Product ProductId Value if itemProductId Equals SPROCKET9000 StringComparison InvariantCulture isOnFeaturedProductPage true 2 Delete the throw new NotImplementedException line if its still in there 3 The IsOnFeaturedProductPage method should return a bool so add a return value to pass isOnFeaturedProductPage back public bool IsOnFeaturedProductPage snip return isOnFeaturedProductPage The service class is now complete Your completed service class FeaturedProductService cs should now look like this using System using Orchard Alias using Orchard ContentManagement 3 9 Extending Orchard 337 Read the Docs Template Documentation Release 1 9 2 namespace Orchard LearnOrchard FeaturedProduct Services public class FeaturedProductService IFeaturedProductService private readonly IContentManager contentManager private readonly IWorkContextAccessor workContextAccessor private readonly IAliasService _aliasService private IContent currentContent null private IContent CurrentContent get if _currentContent null var itemRoute _aliasService Get _workContextAccessor GetContext HttpContext Request AppRelativeCurrentExecutionFilePath souost ring tl hrm 7 ga currentContent contentManager Get Convert ToInt32 itemRoute Id return currentContent j public FeaturedProductService I
269. e This topic targets and was tested with the Orchard 1 5 release Orchard provides a blogging engine that makes it easy to add a blog to your web site This topic describes how to create a blog for your site add a new blog post and then setup comments and tags 17 AddingaBlogtoYourSite 7 Read the Docs Template Documentation Release 1 9 2 1 7 1 Add the Blog On the Orchard dashboard expand the Blog submenu Then click New Blog In the New Blog screen add a title description and menu text for the blog and click Save 78 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 New Blog User admin Logor Title Our Blog a Tr provide a title for this content item Permalink http localhost 30321 OrchardLocal Save the current item and leave the input empty to have it automatically generated using the pattern Title e g my blog O Set as home page Check to promote this content as the home page Description A blog for your website Feed proxy Url Provide a custom public url which will be used to proxy the local rss feed The current feed is available at http localhost 30321 OrchardLacal rss containerid 0 Render a comments rss feed Enable to render the comments rss feed Show an a menu Main Menu Y Select which menu you want the content item to be displayed on Menu text The text that should appear in the menu LJ Show on admin menu Owner admin A p
270. e extract default translation Extensions Bing Maps Output temp This will create a new Orchard en us po zip file with the strings for the module The command looks at the source code for the module and creates entries for T wrapped strings manifest strings and everything that should be localizable Please send this file to join orchard localization lists outercurve org so that we can add it to the online localization database Localizing Database Driven Content Items In addition to application and module localization Orchard provides the ability to translate content items that are stored in the database To localize content items you must enable the Localization feature In the dashboard click Modules and then on the Features tab you will see Localization Click the Enable link Your Site Modules User admin Logout Features Installed Gallery Updates 0 10 Content maj ArchiveLater Enable Blogs Disable Containers Disable Depends on Commen Depends on Common Feeds Depends on Content Routable Orchard jQuery Scheduling Navigation Orchard jQuery O Dhl tor Eeassahia Chomas ContentTypes Disable ImportExport Enable Lists Disable m Widgets Depends an Contents Depends on Containers Modules Contents Mavigation Localization Enable Pages Disable PuyblishLater Disable Depends on Settings Depends on Contents Depends on Common Orchard jQuery Scheduling By default both the Page and Blog Post content ty
271. e Docs Template Documentation Release 1 9 2 The featured product module will be a Widget which shows a static message listing the featured product with a link to that page It s not going to have any configurable settings behind it so we won t need to look at the database side of things yet It s not going to be powered by an actual product system A Widget is a great starting pointing point because it doesn t need to worry about menu settings titles URLs or integration into the admin dashboard It will be a simple banner which you can display on your site by adding a widget via the admin dashboard This will be enough to show the core concepts of a module We will come back and make improvements in the next three parts of this course Let s get started with some development by adding classes and other files to our module Content part The content part class is the core data structure When you scaffolded the module it automatically made you a Models folder Now we need to add the FeaturedProductPart class to this folder Existing Project as Azure Weblob b a8 Orchard Layouts 4 Orchard LearnOrchard FeaturedProducts b JH Properties Text File HTML Page gt NH References Web Form with Master Page Assets LESS Style Sheet Controllers Interface Web Conf te Class El Viewin Browser Google Chrome Ctrl Shift W ration File Browssegith Add Scope to This EE
272. e Include Fields DateTimeField cs 378 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Compile Include Settings DateTimeFieldEditorEvents cs gt Compile Include Settings DateTimeFieldSettings cs gt Compile Include ViewModels DateTimeFieldViewModel cs gt lt ItemGroup gt Adding the Style Sheet Create a Styles directory and create the following datetime css html dyn label forpicker display none html dyn input hinted Color CEC ftont sbyle italio date input width 10em time input width bem Using the Field In order to be able to use the new field you must first make sure that the Orchard ContentTypes feature is enabled Also enable our new DateTimeField feature under Fields Once it is you can click on Manage content types in the admin menu Click Create new type and give it the name Event Click Add next to fields and type in When as the name of the field Select our new DateTime field type as the type of the field Now in the type editor you should see our new When field and you should be able to deploy its settings section by clicking the amp gt on its left 3 9 Extending Orchard 379 Read the Docs Template Documentation Release 1 9 2 Display Name Event Fields When DateTimefField Display options Date and time I 1 Date and time Default locatiaDate only o specific overri Zone name e g roay pr
273. e TheThemeMachine Views Layout cshtml file to the MyTheme Views folder It s anticipated that this step will not be required in later releases Customizing Theme Files After copying the files you want to customize into your new theme folder you can make changes to those files You can also create new files as needed In this example the only change you will make is the background color for the body of the page In the Site css file that you copied find the body style in the General section Then change the background color from Tff to fff8dc as shown in the following example body tont sizes 81 2357 color 434343 backgrounds JXfff9400 font family Tahoma Helvetica Neue Arial Helvetica sans serif j This will change the background color to cornsilk which is a light yellow You can also provide a thumbnail image of your new theme in the theme s root folder The image file must be named Theme png The image will be displayed in the Admin Panel to help users select a theme The following image was copied from TheThemeMachine and changed to show the light yellow background color Documentatio n Upload screenshots NewTheme thumbnail PNG 156 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Applying Your New Theme In the Admin Panel under Themes select Installed The Installed tab will display the new theme under the Available Themes Documentation Upload screenshots the
274. e Writer Add a blog account Web address of your blog http localhost91 our blog This is the web address that visitors use to read your blog Username admin Password escc0o05peos W Remember my password Live Writer will connect to your blog in order to read the XML RPC capabilities that Orchard supports and download the current Theme for previewing posts before publishing If you are prompted to create a temporary post during this step select Yes in the dialog 3 1 Authoring Websites 109 Read the Docs Template Documentation Release 1 9 2 J Windows Live Writer Setting up your blog account Downloading blog editing theme Cancel After Live Writer is configured click Finish MO Chapters Documentation Read the Docs Template Documentation Release 1 9 2 Windows Live Writer Your blog has been set up Please confirm that you would like to save this blog Writer will periodically check for and download new configuration information for your blog Blog nickname Switch to this blog now Write a title and some content for your blog post in the Live Writer editor area A second post from Live Writer The Orchard Project is committed to open community participation We encourage contributions of all sorts including code submissions bug fixes and patches feature recommendations general project feedback and more In addition we hope
275. e and theme you want too However this also comes with responsibilities you have to maintain your website yourself upgrade and fix it as necessary COMPUTE WEB SITE QUICK CREATE Choose a web application from the gallery DATA SERVICES VIRTUAL MACHINE N CUSTOM CREATE APP SERVICES MOBILE SERVICE m FROM GALLERY NETWORK SERVICES CLOUD SERVICE STORE Find Apps for Microsoft Azure ALL A Z APP FRAMEWORKS BLOGS NuData DKAN Orchard CMS CMS ECOMMERCE FORUMS Orchard CMS Orchard CMS is a free open source content management GALLERIES z system that allows users to rapidly create web sites on the TEMPLATES Microsoft ASP NET platform razorC net TOOLS WIKI VERSION 1 8 1 SIZE KB 25888 linear CAS RELEASE DATE 8 5 2014 Outercurve PUBLISHER Foundation WordPress WordPress Japanese Package 440 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Configure Your App Site Settings URL giveanameforyoursite v Orchard CMS azurewebsites net WEBSCALEGROUP Default1 East Asia Basic Y Orchard CMS is a free open source content management system that allows users to rapidly create web sites on the Microsoft ASP NET platform VERSION 1 8 1 SIZE KB 25888 RELEASE DATE 8 5 2014 Outercurve PUBLISHER Foundation 15 GettingStartedwithOrchard 0 45 Read the Docs Template Documentation Release 1 9 2 gettingstartedorchard af Running C
276. e and time according to the field s configuration Now create a file of the same name under Views EditorTemplates Fields with the following contents model CustomFields DateTimeField ViewModels DateTimeFieldViewModel style Include Style Require Style Require Style Require datetime css jQueryUI DatePicker jQueryUtils_TimePicker sOuervUl Orrcharsd j3 J3Querw t s AQuervUtils t 3 jQueryUI Core Script Require C jQueryUI Widget Script Require Script Require Script Require Script Require Script Require j jQueryUI DatePicker jOuervULIls TimerPacker lt fieldset gt label for Html FieldIdFor m gt Model Date gt Model Name lt label gt if Model ShowDate label class forpicker for Html FieldIdFor m gt Model Date gt T Date lt label gt lt span class date gt Html EditorFor m gt m Date lt span gt if Model ShowTime label class forpicker fors nrtml FieldldFor m gt Model Time gt i C Iime label lt span class time gt Html EditorFor m gt m Time lt span gt 376 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 if Model ShowDate lt text gt Html ValidationMessageFor m gt m Date lt text gt if Model ShowTime lt text gt Html ValidationMessageFor m gt m Time lt text gt lt fieldset gt Cusi
277. e aos um scs ram loci e a Tis eta pad j At pa pt iah Sl eee A eo je Poe ED I1 mee Te Wea rae TELE Lo TI EI bruer erie ey ee ee eee pacem ae sari ed um nm Tat a Ee nf ea em cmt cnn mara re Fan Vra Cached ui Le cn ig cece rd SED a o D dn LLILSLILLOILIL a Liz eee dE omina nme cur fn em iry ruri mra erm maie rm eis nume omm dei manas ug Tar Ld recu pr Deam Ty owe sar puce luin Hed ee d qum be gag ques eo pari ee y bok Ter ihiak ran Set Current By The Orchard Team Version 1 0 Description for the theme http www orchardproject net Enable Uninstall The Manage Themes page is redisplayed showing MyFirstTheme as the current theme You can now go to your website to see the new theme in action 3 11 Creating Themes 439 Read the Docs Template Documentation Release 1 9 2 3 11 2 The Anatomy of a Theme Themes enable Orchard users to customize the rendering of the site and tailor it to their needs and design goals Themes can perform targeted overrides of style sheets images layouts or of any content template provided by any Orchard module Where Themes Live A theme is set of appropriately named files inside of a folder That folder must be under the Themes folder under your Orchard website s root folder TheThemeMachine The theme named TheThemeMachine is the theme that comes built into Orchard You can examine this theme in order to learn about Orchard themes Like any theme it can be found under the Themes
278. e are all things that you can manage via the admin dashboard and you will have worked with them if you have built any kind of site in Orchard To refresh your memory Content Type The template for a type of content in Orchard The most common example is the Page content type which provides the structure for a page of content in an Orchard site Widgets You can also make a content type that works as a Widget The Widget is a special variation of content type which can be placed into one of the many Zones a template defines It s manageable via the admin dashboard at run time Content types can opt in to this system by configuring their Stereotype setting to Widget Content Item This is an instance of a specific content type When you create a new Page in Orchard and fill it with content thatis a Content Item witha Content Type of Page Content Part A small module providing some specific functionality The Content Type is made up by attaching various Content Parts toit For example you could have a comments content part It just manages a block of comments for whatever it is attached to The same comments content part could be attached to a Page content type a Blog content type or within a Widget What we will be building As you might have guessed from the module name we are going to build a very simple featured product module This first step into extending Orchard will be a small one 290 Chapter 3 Documentation optic Read th
279. e community contributions but please read these guidelines before you start work First step open an issue or discuss an existing one If you re new to contributing then you should discuss your plans before you start work This is especially true if it involves building new features or changing the architecture Don t know where to start There are lots of existing bugs which have been reported in the issue tracker All of Orchard s planning is done in the GitHub repo s issue tracker If your idea bug isn t in the issue tracker don t forget to check the closed issues as well it might have been fixed in a development branch then open a new issue to start a discussion with the community Branches The repository is split into two main development branches 1 9 x and dev There is also a master branch which represents the latest released stable version of the software While other features are being worked on you might find 3 14 Getting Involved 509 Read the Docs Template Documentation Release 1 9 2 some additional branches temporarily created but they are just to test out ideas and they will get merged back into one of the main branches later on All the active feature work is being done by the core team in the 1 9 x branch Whenever a new release is ready changes get merged from 1 9 x to master Master is a stable branch and is normally always in a green state The 1 9 x branch is the short cycle dev branch Th
280. e didn t look at it in this course but you can include several features within a single module This means you can enable or disable individual parts of the module The description field and features section work together and can be displayed in several different formats For a detailed explanation of the Features section and the other fields read the manifest files guide Time to make some changes 1 Open module txt 2 Edit the module txt to your liking while staying within the spec Go ahead and put your name and details into it It feels good to see your name in lights 3 Save the file You will probably need to restart the development server before Orchard picks up the changes you ve made to your module txt 330 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Categorize your module While we are working with the manifest file there is one field which is very useful but not included by default in the module txt The field 1s called Category If you omit this field then the module defaults to the Uncategorized grouping Uncategorized Orchard LearnOrchard FeaturedProduct Disable Description for feature Orchard LearnOrchard FeaturedProduct When developing your own modules you should first check the Modules section of the admin dashboard to see if your module would sit well in one of the existing common categories It s better to group your module with other modules where possible so that us
281. e features with a default module in the main manifest The Orchard Alias module itself defined as Name Alias is its own default feature There are two extra optional features defined in the Features which can be separately enabled In this case they both have dependencies on their parent feature Orchard Alias but module developers can define independent features as well Name Alias AntiForgery enabled Author The Orchard Team Website http orchardproject net Version 1 9 1 OrchardVersion 1 9 Description Maps friendly urls to specific module actions FeatureDescription Maps friendly urls to specific module actions Category ConLent Features Orchard Alias UI Name Alias UI Description Admin user interface for Orchard Alias Dependencies Orchard Alias Orchard ExampleModule Category Content Orchard Alias Updater Name Alias Updater Description Synchronizes aliases when created from different servers Dependencies Orchard Alias Category Content 3 9 Extending Orchard 419 Read the Docs Template Documentation Release 1 9 2 Multiple features all defined in the features sub section of the manifest Name AntiSpam AntiForgery enabled Author The Orchard Team Website http orchardproject net Version 1 9 1 OrchardVersion 1 9 Description Provides anti spam services to protect your content from malicious submission Features Orchard AntiSpam Name Anti Spam Description Provides anti spam services to protect your con
282. e following Add a Content Picker Field to the FeaturedProductWidget part so that you can select a Product to be featured Implement the code so that the widget will work with the selected Product rather than using the hard coded information we supplied throughout this course You can find the information to complete this exercise by using resources such as this documentation website reading the Orchard source code and searching the World Wide Web 3 9 Extending Orchard 345 Read the Docs Template Documentation Release 1 9 2 3 9 5 Building a Hello World Module This article describes how to build a very small module for Orchard that will just display a hello world page The technique that it shows you is a great start if you are looking to take control of the page lifecycle with your own MVC controller Another simple example of a module can be found here Quick Start Get module blueprint This guide has been marked for review If you are just getting started with Orchard module development you should read the Getting Started with Modules course first It will introduce you to building modules with Orchard using Visual Studio Community a free edition of Visual Studio Introduction Orchard is built on top of ASP NET MVC which means that if you already know that framework you should feel right at home If not do not worry as we ll explain everything we re doing MVC is a pattern where concerns are neatly separated
283. e more higher level modules Why are Core Modules Core Modules Now that we want core concepts to be implemented as modules why not put them into the modules directory along with the rest of the more obvious Orchard modules such as the comments module Well this time it s about depen dencies In Orchard modules that are in the modules directory can be disabled uninstalled or otherwise updated in a breaking way We prefer modules that are self contained and don t require other non core modules as dependencies as much as possible That s part of the entire dynamism behind the content type architecture Pages and Blog posts which belong to Pages and Blog modules don t reference Comments or Tags modules but it s possible to attach comments or tags to pages and blogposts This decoupled behavior is ensured by the underlying content type architecture and not by direct reference from one or the other modules Core modules are part of the Orchard framework and it s ok for modules to depend on them They will be distributed by us and for all practical purposes are integral parts of the Orchard framework Modules can depend on them and directly access their public surface How do I write and run tests Orchard comes with a solution folder called Tests This hosts 2 types of tests 3 12 Developer Tools and Guidelines 483 Read the Docs Template Documentation Release 1 9 2 Unit Tests These are NUnit test fixtures To write a fixture for a
284. e parts of the core func tionality are implemented as modules outside the kernel talking to the kernel using the same interfaces as the more high level modules A second design issue for core modules was this why are core modules core modules After it was determined that core concepts would be implemented as modules it might have made sense to put them into the modules directory along with the rest of the Orchard modules such as the comments module The problem with that approach was dependencies In Orchard modules that are in the modules directory can be disabled uninstalled or otherwise updated in a breaking way Orchard modules should avoid dependencies on other modules as much as possible that s part of the dynamism behind the content type architecture Pages and blog posts which belong to the Pages and Blog modules don t reference the Comments or Tags modules but it s possible to attach comments or tags to pages and blog posts This decoupled behavior is ensured by the underlying content type architecture and not by direct reference from another module However core modules are part of the Orchard framework and it s considered acceptable for modules to depend on them Core modules will be distributed by the Orchard development team and for all practical purposes are integral parts of the Orchard framework Modules can depend on them and directly access their public surface 3 12 4 Dependencies and Libraries This section enumer
285. e service is to answer a single question so add a method declaration to the interface called TsOnFeaturedProductPage which returns bool You don t need to specify the public modifier when working with an interface public interface IFeaturedProductService Dependency bool IsOnFeaturedProductPage 7 Add a class to the services folder called FeaturedProductService This will be the concrete implemen tation that we place the actual code into 8 Add the FeaturedProduct Service interface to the class public class FeaturedProductService IFeaturedProductService 9 Implement its interface using the Ct r1 technique 10 Now its time to start moving the code over Open up the FeaturedProductDriver cs file that s in the Drivers folder Review the code and start thinking about what could be moved out into the service class 11 The CurrentContent property is only used for calculating the IsOnFeaturedProductPage value The three private variables which hold references to Orchard services are only used by the CurrentContent property This means everything from the start of the class through to the end of the constructor can be moved OVer 336 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 12 Cut the following code from the driver and paste it into the service class private readonly IContentManager contentManager private readonly IWorkContextAccessor workContextAccessor private readonly IAlias
286. eans any combination of the letters and numbers but there needs to be at least one 5 means match the end of the string nothing after it Prepare a sample product For this to work we need to create a dummy product that will act as the featured product 1 Navigate to the admin dashboard of your site 316 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 2 In the New section of the menu click Product E Dashboard B p roj pct i on 3 Set the Title of the page to Sprocket 9000 4 Leave the Permalink blank 5 You can optionally add some content in to the Body section just for something to preview Here is some Lorem Ipsum sample data Curabitur non nulla sit amet nisl tempus convallis quis ac lectus Nulla quis lorem ut libero malesuada feugiat Sed porttitor lectus nibh Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae Donec velit neque auctor sit amet aliquam vel ullamcorper 6 The Product Id is the custom field we created for the content type Notice the red which indicates a required field If you try to create the Product with a blank Product Id you will see a validation error Attachments getting started with modules part 3 demoproduct required png If you try to enter an incorrect value that doesn t match the pattern we specified you wil Attachments getting started with modules part 3 demoproduct badpattern png Enter SPROCK
287. eased your package on a CodePlex com site you could specify the URL to your release Example URL http orchardmaps codeplex com Project Download FileDownload aspx DownloadId 187223 In this walkthrough we will assume you are browsing for the package on your local computer Click the Browse button to find the nupkg file Orchard Module TestPackage 1 0 nupkg 1 16 201112 26 PM NUPKGFile 9 KB O Orchard Module TestPackageZ 10 nupkg 1 17 2011 11 13 AM MUPKG File 9 KB L rchard Module TestPackage3 1 0 nupkg 1 17 201111 28 AM NUPKG File 9 KB Orchard Theme Contoso 1 0 Copy 12 16 2010 2 44 AM WinRAR ZIP archive 184 KB L Orchard Theme Contoso 1 0 nupkg 12 16 2010 2 44 AM NUPKG File 184 KB L Orchard Theme CustomLayoutMachine 2 22 2010 6 42 PM NUPKG File 353 KB 2 L Orchard Theme Events Theme 1 O nupkg 12 10 2010 3 16 AM NUPKG File 30 KB Orchard Theme TheThemeMachine 0 9 0 1 11 2011 12 00 AM WNUPEG File 135 KB Orchard Theme TheThemeMachine 1 0 0 1 12 2011 10 40 PM NUPEG File 135 KB sme Orchard Module TestPackage 1 0 nupkg AI Files Open F Cancel Specifying the Package Details Once you upload your package click Next and you will be presented with a form for specifying the details of your package One of the advantages of using the nupkg format is that the gallery can automatically extract many details about your package from the file itself These details are determine
288. ebMatrix some browsers may have trouble handling more than one request at once This results in slower performance because resources are fetched one after the other If you are testing locally and see images appearing one by one you are probably hitting this bug An easy workaround is touse 127 0 0 1 instead of localhost as the domain for the development server Another is to disable IPv6 in the browser although this change can have side effects A third workaround is to make sure there s an explicit entry for Localhost in your HOSTS file Future Perspectives The Orchard team is planning more work for performance in the future This might include versions of the core assemblies and main dependencies that can be put into the GAC as well as NGen optimizations 3 5 3 What s New for Windows Azure in Orchard 1 7 1 The Windows Azure integration and deployment in Orchard have undergone a complete overhaul for version 1 7 1 This topic describes what s changed and the benefits of some of the new capabilities Visual Studio tooling Prior to version 1 7 1 packaging and deploying to Windows Azure had to be done from the command line outside of Visual Studio The external custom MSBuild file AzurePackage proj that was used to do this is no longer needed but retained for people whose established build processes depend on it The cloud service deployment configuration has been redesigned to work fully and seamlessly within Visual Studio Tools for
289. echnically part of the Activation phase but it is easier to think about the problem of reference resolution as a separate concern Once modules are properly activated they are further examined to detect and enable individual features but this is a topic for another section Discovery The list of available modules in an Orchard installation is built by searching various folders of the file system for module txt files The folders looked at by default are listed in the following sections Modules folder The Modules folder is intended to contain the vast majority of Orchard modules The convention is that each module is stored in a sub folder named amp lt ModuleName amp gt containing a single module txt file Packaging distribution and sharing of modules is only supported for modules in the Modules folder 3 13 Additional Topics 499 Read the Docs Template Documentation Release 1 9 2 Core Folder The Core folder contains by convention modules defined in the Orchard Core assembly These modules are part of the Core Orchard system and are not intended to be modified as freely as modules in the Modules folder Themes Folder The Themes folder is intended to contain Orchard Themes Wrt to dynamic compilation Themes are treated almost exactly the same as Modules except that Themes don t have to have code assembly in bin or csproj file For the
290. ecial field The line must begin with either a single tab character or four spaces Immediately following this the Featured Id itself the value not the field name must be entered followed by a colon This serve as an indented header for the specification of the feature Important All fields below must begin with either two tab characters oreight spaces This indentation process resets back to the left margin and the process repeats with the next feature Examples of this are shown in the next section Name OptionalProvides a human readable name for the feature If a name is provided it will be used as the features display name in the Modules section of the Orchard admin dashboard If a name is not provided in the manifest the FeatureId is used instead Description OptionalA description of the feature If this is the default feature of the module use the FeatureDescription instead FeatureDescription OptionalEither the main manifest section should define this field or a single feature in the features sub section should assign this field It should contain a descrip tion of the individual feature Category OptionalDefaults to uncategorized This field groups the feature together in the Modules page of the Orchard admin dashboard Related features which have the same category are displayed 418 0 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 together Each individual feature can be assigned one category however the di
291. ecord E Navigation_AdminMenuPartRecord E Mavigation_ContentMenultemPartRecord 11 12 2012 9 35 14 PM 11 12 2012 9 35 14 PM 11 12 2012 9 35 15 PM 11 12 2012 9 35 15 PM 11 12 2012 9 35 15 PM 11 12 2012 9 35 15 PM c Navigation MenultemPartRecord sg Mavigation MenuPartRecord t Navigation MenuWidgetPartRecord Site LE Files Databases mm Reports 11 12 2012 9 35 15 PM 11 12 2012 9 35 15 PM PublishedUtc 11 12 2012 9 35 14 11 12 2012 9 35 14 11 12 2012 9 35 14 11 12 2012 9 35 14 11 12 2012 9 35 14 11 12 2012 9 35 14 11 12 2012 9 35 15 11 12 2012 9 35 15 11 12 2012 9 35 15 11 12 2012 9 35 15 11 12 2012 9 35 15 11 12 2012 9 35 15 If you were already in the Databases workspace you might need to right click the Orchard node and then click Refresh in order to display the database and tables Refresh Delete Row 1 3 7 Publishing Your Web Site When you re ready to upload the local copy of your website to the Internet click the Publish button in the WebMatrix ribbon 34 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 za J g Orchard CMS Microsoft WebMatrix Remote Start lt 4 a v E Stop e E O O Requests Extensions Admin Add Add Restart Module Theme Hame View 3alleries Resources 4 Orchard CMS Orchard CMS rir Orchard CMS Microsoft WebMatrix Publish Your Site I already have a hosted website a Import publish profile
292. ect Publish and follow the instructions in the publishing wizard Click the mport button to import a web deploy publishing configuration from your Windows Azure subscriptions How to use the Windows Azure publishing tools in Visual Studio is beyond the scope of this topic but they are pretty self explanatory Once deployment has successfully completed browse to the newly deployed Orchard site and go through setup Specify the connection string to the Windows Azure SQL Database you created earlier Congratulations Orchard is now fully configured for a single instance Windows Azure Web Site Using multiple instances As with cloud services you need to do a little more configuration if you plan to scale out your web site to more than one instance The steps for enabling the Windows Azure Media Storage Windows Azure Output Cache and Windows Azure Database Cache features for a Windows Azure Web Site are described the following topics Using Windows Azure Blob Storage Using Windows Azure Cache Orchard ships with providers for Microsoft Azure Blob Storage allowing Orchard to use Microsoft Azure Blob Stor age as the underlying file system implementation for shell settings Settings txt and or media storage This topic describes how to configure and enable this functionality 3 6 Using shell settings storage Storing shell settings in Microsoft Azure Blob Storage is useful when running Orchard in server farm where there is no shared file
293. ection describes the project structure of an Orchard solution in Visual Studio The projects and folders are listed in the order they appear in Visual Studio We recommend that you open the Orchard project in Visual Studio and browse through the files as you read this topic 3 12 Developer Tools and Guidelines 491 Read the Docs Template Documentation Release 1 9 2 Modules Modules is a Visual Studio solution folder that contains Orchard module projects It maps to the Modules subfolder of the Orchard Web web site folder Each subfolder of the Modules folder is an Orchard module All Orchard modules are ASP NET MVC areas Specs The Specs folder contains the following projects Orchard Profile This provides for creating a profiling image for Orchard Orchard Specs This contains integration tests written using a SpecFlow style Feature specific information is contained in the feature files Tests The Tests folder contains the following projects Orchard Core Tests is the test project for the Orchard Core project Orchard Framework Tests is the test project for the Orchard Framework project Orchard Tests Modules is the test project for Orchard modules It contains subfolders for different modules e Orchard Web Tests is the test project for the Orchard Web project Tools The Tools folder contains the source code for tools that are used to build the Orchard solution It also contains the Orchard project which builds
294. een added to zones in other layers will be annotated in gray Main Menu Current Layer TheHomepage Add a new layer 15 Getting Started with Orchard ag Read the Docs Template Documentation Release 1 9 2 50 Header Navigation Main Menu Featured BeforeMain AsideFirst Messages BeforeContent Content AfterContent AsideSecond AfterMain TripelFirst Read the Docs Template Documentation Release 1 9 2 The TripelFirst TripelSecond and TripelThird zones on the home page have widgets in them and are visible Remov ing all of the widgets in a zone will make the zone invisible 3 Select Remove for the Third Leader Aside widget TripelThird a My Third Leader Aside The TripelThird zone will no longer be visible on the home page My Website Home Welcome to Orchard TOV La oa La Teu You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head over to manage themes to change or install new themes and really make it your own Once you re happy with a look and feel it s time for some content You can
295. efault Edit To provision the new tenant site click Set Up The Orchard setup screen is displayed as if you were setting up a 3 8 Using Windows Azure Cache 261 Read the Docs Template Documentation Release 1 9 2 brand new Orchard installation However the database options are not displayed because they were decided when the tenant was added Note If you decide to use an existing database for your tenant you will be asked for the connection string and for a table prefix The table prefix will be added to each of the tenant s tables within the database 262 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 File Edit View Tools Window Community Help Ld New Query Li L 5 z fect C re onnect 39 E l dbo Tenantl Settings ContentTypeDefiniti d dbo Tenantl Settings ContentTypePartDef dbo lIenantl Settings ShellDescriptorReco l dbo Tenantl Settings ShellFeatureRecord a dbo Tenantl Settings ShellFeatureStateRe d dbo Tenantl Settings ShellParameterReco d dbo Tenant1l Settings ShellStateRecord d dbo Tenantl Settings SiteSettingsPartRecc dbo Tenant Common BodyPartRecord dbo lenant Common CommonPartRecor dbo Tenant2 Common CommonPartVersic dbo lIenant2 Futures Widgets WidgetPartl dbo TIenant Futures Widgets WidgetsParl dbo Tenant2 Localization LocalizationPart dbo Tenant2_Navigation_MenultemPartRec dbo Tenant2_Navigation_MenuPartRecord d dbo Tenant2 Orchard Blogs BlogPartA
296. efines the behavior of the part handling events or manipulating data model prior to rendering the part The Map part is very simple and in this case our handler class will only specify that an IRepository of MapRecord should be used as the storage for this part Add the following Handlers MapHandler cs using Maps Models using Orchard ContentManagement Handlers using Orchard Data namespace Maps Handlers public class MapHandler ContentHandler public MapHandler IRepository lt MapRecord gt repository Filters Add StorageFilter For repository We will also add a driver for our Map part A driver in Orchard is a class that can define associations of shapes to display for each context in which the Map part can render For example when displaying a Map on the front end a Display method defines the name of the template to use for different displayTypes for example details or summary Similarly an Editor method of the driver defines the template to use for displaying the editor of the Map part for entering values of the latitude and longitude fields We are going to keep this part simple and just use Map as the name of the shape to use for both Display and Editor contexts and all displayTypes Add the Drivers MapDriver class as follows using Maps Models using Orchard ContentManagement using Orchard ContentManagement Drivers namespace Maps Drivers public class MapDriver ContentPartDriver l
297. emove and then deleting it You might want to move the folder to a backup location in case you need to restore it later Note On Azure there is currently no way to remove a tenant except by removing the actual database and the configuration from BLOB storage Testing Multi Tenancy on a Local Machine If you are running locally and do not have a domain to map you can edit your Windows System32 drivers etc hosts file to create a sample host The following advice is for Windows 7 or Windows Vista and was taken from Orchard Issue Tracker on GitHub These instructions assume that you re using WebMatrix and IIS Express to work with Orchard 1 Open the Windows System32 drivers etc folder 2 Right click the hosts file and give yourself modify permissions to that file 3 Open the hosts file in a text editor 4 Add the following line replacing mydemo with the domain name you want to use 127 0 0 1 mydemo Nn Open the Users YourUserName Documents IISExpress config folder 6 Open the Applicationhost config file in a text editor 7 Locate the section for your existing Orchard site such as the following site name mydemo id nnnnnnnnn gt 8 Under the bindings section leave the default localhost binding but copy it onto the next line and edit it to read binding protocol hrttp bindingInformation x 28923 mydemo gt 9 Substitute the port number above for the one you copied from the default localhost bi
298. emplates ShapeType ContentType FieldName Fields Common Text Blog Teaser Fields Common Text Blog Teaser Field templates ShapeType __ ContentType __ PartName __ FieldName Fields Common Text Blog TeaserPart Teaser Fields Common Text Blog TeaserPart Teaser LocalMenu LocalMenu MenuName LocalMenu main LocalMenu main LocalMenultem LocalMenultem MenuName LocalMenultem main LocalMenultem main Menu Menu MenuName Menu main Menu main Menultem Menultem__ MenuName Menu Item main Menultem main Resource Resource FileName Resource flower gif Resource flower gif Style Style FileName Style site css Style site css Widget Widget ContentIype Widget HtmlIWidget Widget HtmlWidget Widget Widget ZoneName Widget AsideSecond Widget AsideSecond Zone Zone ZoneName lZone AsideSecond Zone AsideSecond You should put your templates in the project according to the following rules Content item shape templates are in the views items folder Parts shape templates are in the views parts folder Fields shape templates are in the views fields folder e The EditorTemplate shape templates are in the views EditorTemplates template name folder For example an EditorTemplate with a template name of Parts Routable RoutePart has its template at views EditorTemplates Parts Routable RoutePart cshtml All other shape templates are in the views folder 3 11 Creating Themes 455 Read
299. ems that are shown per page Leave 0 for unlimited In the general settings category you can modify the following global and site wide settings Site Name The name of your site which is usually displayed by the applied theme Default Site Culture The default culture for the site You can also add culture codes here For more informa tion see Creating Global Ready Applications Page title separator The character that is used to separate sections of a page title For example the default separator character for the en US locale is a hyphen Super user A user who has administrative capability on the site regardless of configured roles This is usually the user who ran the Orchard installation and setup The default user is the admin account Resource Debug Mode The mode that determines whether scripts and style sheets are loaded in a debuggable form or in their minimal form Default number of items per page Determines the default number of items that are shown per page Base URL The base URL for your site 3 4 Managing Websites 195 Read the Docs Template Documentation Release 1 9 2 e Maximum number of items per page Determines the maximum number of items that are shown per page Leave O for unlimited Default Time Zone Determines the default time zone used when displaying and editing dates and times Default Site Calendar Determines the default calendar used when displaying and editing dates and times
300. endation One reason is that templates from different modules and parent themes might be used on a single page where there is only one doct ype declaration The following tables lists some commonly used HTML elements that provide for better structure in web pages than earlier versions of HTML did For more information about HTMLS see the W3C article HTMLS difference from HTML4 e section e article 3 11 Creating Themes 473 Read the Docs Template Documentation Release 1 9 2 e aside lt hgroup gt e header lt footer gt e nav e figure rigcaption Example figure video src tgif vid video lt figcaption gt Example lt figcaption gt lt figure gt If you are using any of these new elements in order to avoid breaking script libraries in older versions of Internet Explorer we recommend that you use the workaround described in Styling New HTMLS Elements JavaScript and jQuery Your web pages should work even if JavaScript is disabled in the browser Scripts should be used only to enhance the experience of the page which is referred to as progressive enhancement For more information see Progressive Enhancement with JavaScript Orchard has jQuery built in The Orchard team has standardized on jQuery as its JavaScript framework Images Use the appropriate image format for the scenario as described in the following list Photos and gradients should use the jpeg format
301. ent but there are a couple of caveats that justify a specific example The example that we will build is a Sponsor part that records that a specific customer was sponsored by another Modeling the Sponsor Part The Sponsor part will consist of a single Sponsor property This time we will use a lazy field so that its content only gets fetched when it is needed using Orchard ContentManagement using Orchard Core Common ULril ries namespace RelationSample Models public class SponsorPart ContentPart lt SponsorPartRecord gt private readonly LazyField lt IContent gt sponsor new LazyField IContent public LazyField IContent SponsorField get return sponsor public IContent Sponsor get return sponsor Value set _sponsor Value value 408 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 j We will see how the lazy field gets set and populated when we look at the code for the handler The corresponding record is extremely simple using Orchard ContentManagement using Orchard ContentManagement Records namespace RelationSample Models public class SponsorPartRecord ContentPartRecord public virtual ContentItemRecord Sponsor get set Building the Database Table and Part The migration for this part is as follows public int UpdateFrom4 SchemaBuilder CreateTable SponsorPartRecord table gt table ContentPartRecord JColumnerHb Spon
302. ent Blog Posts 6 Enter a title for your widget and some content 52 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 9 Your Site Add Widget fone TripelThird Ihe Zone in the Layout where the Widget will be rendered Layer TheHomepage J Layer where Live V AC E t Wen De lander ed Position Title New Third Leader Aside The title of the Widget 4 Check to render the title on the front end uncheck to hide Name he technical name of the Widget used for css class and alternates i B Fs i Paragraph wm 3 7 Save the new widget 8 Select Your Site in the upper left side of the Dashboard to view the modified home page with the new TripelThird 15 Getting Started with Orchard 8 Read the Docs Template Documentation Release 1 9 2 zone My Website Welcome to Orchard 7 a DE lov 12 2017 4 3 ig You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head over to manage themes to change or install new themes and really make it your own Once you re happy with a look and feel it
303. enter values for the shape properties The aHtml ValidationMessageFor expressions create messages that are displayed if users enter an invalid value Wrappers Wrappers let you customize the rendering of a shape by adding markup around the shape For example Docu ment cshtml is a wrapper for the Layout shape because it specifies the markup code that surrounds the Layout shape For more information about the relationship between Document and Layout see Template File Syntax Guide Typically you add a wrapper file to the Views folder of your theme For example to add a wrapper for Widget you add a Widget Wrapper cshtml file to the Views folder of your theme If you enable the Shape Tracing feature you ll see the available wrapper names for a shape You can also specify a wrapper in the placement info file For more information about how to specify a wrapper see Understanding the placement info File 3 11 Creating Themes 457 Read the Docs Template Documentation Release 1 9 2 Creating a Shape Method Another way to create and render a shape is to create a method that both defines and renders the shape The method must be marked with the Shape attribute the Orchard DisplayManagement ShapeAttribute class The method returns an IHtmlString object instead of using a template the returned object contains the markup that renders the shape The following example shows the DateTimeRelative shape This shape takes a DateTime value in the past
304. enting it working successively up the layers to surface it in the admin dashboard and the front end view In the next part of the getting started with modules course we will look at working with content items at the code level Part 3 Using the Orchard API Introduction This is part three of a four part course It will get you started with a gentle introduction to extending Orchard at the code level You will build a very simple module which contains a widget that shows an imaginary featured product It will teach you some of the basic components of module development and also encourage you to use best practices when developing for Orchard If you haven t read the previous parts of this course then you can go back to the overview to learn about the Getting Started with Modules course Now that we have built the widget and expanded it to use database storage for it s configuration we will turn to the Orchard API to make some decisions via code Amending the widget through code The second feature we have planned to add to the widget is some code that will detect when a user is viewing the featured product page and then make some changes to the display At the moment the widget is displayed site wide with a big green Click here to view it link When the user is on the product page it doesn t make sense to show a link back to itself In the previous part we added a configurable item to the widget The widget read that setting in
305. enu to browse and install available modules and themes online The http gallery orchardproject net website provides a browsable front end for finding and downloading available mod ules and themes too You can easily upload your custom module package to our Galllery website to share it with other Orchard users Register an account and contribute your module here 3 9 10 Writing a Widget This guide has been marked for review If you are just getting started with Orchard module development you should read the Getting Started with Modules course first It will introduce you to building modules with Orchard using Visual Studio Community a free edition of Visual Studio In Orchard a widget is a piece of reusable UI that can be arbitrarily positioned on the pages of a web site Examples of widgets could include a tag cloud a search form or a Twitter feed A widget is a content type which enables you to reuse existing code and UI This article describes how to write a widget by first creating a content part and then turning that part into a widget Creating a Content Part For this example you will use the Map part that is described in Writing a content part If you did not create the Map part do so now 382 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Turning a Part into a Widget To turn a content part into a widget you must update the database with your widget s type definition You do this by ad
306. eout is generally a good idea if it is replaced by a limit on memory usage recycling at an arbitrary interval has little benefit whereas recycling if the application uses all available memory is a good practice Multi Tenancy Orchard has an optional module called Multi Tenancy that enables more than one site to exist on the same Orchard instance The data for the sites is separated and for all practical purposes they are distinct sites There are a few limitations on what each tenant can do such as installing new modules and themes The advantage of a multi tenant installation over multiple instances of Orchard is that there is only one app domain which hosting companies favor because it improves site density considerably It also has advantages for each of the multi tenant sites because a hit on any of the tenants keeps the app domain alive Therefore even sites that receive very few hits will remain responsive if they share the app domain with enough other sites This results in the seemingly paradoxical notion that more sites on a single app domain might perform better in some cases than a single site per app domain In shared hosting scenarios in particular this configuration is optimal if it is an option Installed Modules For both security and performance reasons it s a good idea to keep the number of modules installed on your production server as low as compatible with your application There s a cost to anything you add to the syste
307. ept the pull request and merge your work into the Orchard CMS repository This process might involve altering the history to remove any feedback loop changes which don t add anything to the work done If more work is requested you make the changes on your local branch commit them push the branch to your GitHub account they will be automatically included in the pull request for further review What to do once your pull request has been reviewed Once your contribution has been accepted and integrated into the official Orchard CMS repository you can now delete the branch GitHub will let you know when this is safe to do You will seea Delete branch button at the bottom of the pull request page Pull request successfully merged and closed i Delete branch You re all set the rtpHarry fix reverted footer is_ branch can be safely deleted If your feature was accepted please consider contributing some documentation to the OrchardDoc repo Just as this article has helped you out today by documenting your new feature you can help other Orchard users to get the most out of Orchard CMS You can read more about the documentation process here The fork that you made can be re used for as many contributions as you like Just remember to keep making a new branch each time you start work on a new issue There is one thing to consider though While you ve been working on this there has probably been other commits and pull requests on whichever branch you
308. er P Lace element For additional shapes you can add more P lace tags one per line Single shape per line example M8 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Place Parts_TagCloud Content 5 gt Place Parts TagCloud Edit 2 Content 7 Multiple shapes per line example Place Parts Idgtloud content 5 Parts TasgCloud bdir Contenrtr7 tgs Shape Name Attribute Each attribute of a Place element is the name of a shape such as Parts Tags ShowTags as defined from the relevant part driver and has the placement as the value To determine the shapes that are part of the display of a given content item you can read the code for the part drivers Or a simpler method might be to enable the Shape Tracing module and use the shape debugging tools to examine the model The name of the attribute can be any shape name but not an alternate name use Match to specialize placement instead There are also special extensions for certain fields so that placement can be targeted at specific field instances For example the following placement will display text fields named Occupation at the start of the local content zone Place Fields Common Text Occupation s Content before Note for field developers you may give your own fields this capability by using a special override of ContentShape in your driver that provides the differentiator the part after the dash in the attr
309. er the following com mand codegen theme MyFirstTheme The codegen command creates the code structure for a new theme and sets the name of the theme to MyFirstTheme The command generates the following folder structure 3 11 Creating Themes 433 Read the Docs Template Documentation Release 1 9 2 EH Content Lg Scripts Lg Styles 4 Views E Web config Lg Zones Theme txt The only files created are the Theme txt and Views Web config files The Theme txt file is the theme manifest and is where the Admin Panel dashboard looks for information such as the name of the theme Web config is a configuration file that ASP NET MVC requires for rendering any views that are in the Views folder You seldom have to make changes in the Web config file Creating Styles for Your Theme In the Styles folder create a file named Site css You can name the file anything you want as long as it has a css extension The following example shows a stylesheet It has been kept simple for this example For information about the structure of this stylesheet and other CSS recommendations see UI Guidelines for Theme Authors Theme My First Theme Author CODVEXOLIIDS Colors Palette Background d3d3d3 Text 000 Main Accent 999 Links c03 x x Reset KK KK KK KK KK KK KK KK KK KK KK KK KK KKK KK KK KK KK KK KKK KK KK KKK KEK KKK KKK KK kc k k html body div span applet object iframe hl h2 No
310. erarchical menu Version 1 1 0 Install Download Support for multi level hierarchical main menu Adds also the Breadcrumbs Widget RecentlySeenWidget and a MenuWidget to display independent submenus on your pages Last Updated 2 25 2011 12 13 06 AM Author Piotr Szmyd Downloads 1993 Website httpz www szmyd com pl blog using the hiersrchical menu orchard module Rating wA Air Email Messaging Version 1 0 20 Install Download The Email Messaging module adds Email sending functionalities Last Updated 1 13 2011 9 40 55 AM Author The Orchard Team Downloads 1944 Website http orchardproject net Rating WAATA Lucene Version 1 0 20 Install Download The Lucene module enables the site to be indexed using Lucene NET The index generated by this module can then be used by the search module to provide an integrated full text search experience to a web site Last Updated 1 13 2011 9 40 23 AM Author The Orchard Team Downloads 1855 Website http orchardproject net Rating AAAA Messaging Version 1 0 20 Install Download The Messaging module adds messaging functionalities Last Updated 1 13 2011 9 42 27 AM Author The Orchard Team Downloads 1823 Website http orchardproject net Rating wA Arr The gallery displays the aggregated list of modules exposed by all registered feeds You can also use the Feed drop down list in the Gallery tab to display al
311. ere to point the using statement at and it only offers you options to generate stubs We don t want this Attachments getting started with modules part 1 datamigrations unknownnamespace png l Right click on your References and choose Add Reference P uda urcnarda Layours 4 Orchard LearnOrchard FeaturedProduct gt J Properties gt OO Re b BEP As E Reference L am 2 Click the Projects tab on the left Scroll down until you can see Orchard Widgets in the list Hover your mouse over it and a checkbox will appear Click the checkbox for Orchard Widgets Click OK 3 9 Extending Orchard 295 Read the Docs Template Documentation Release 1 9 2 b Assemblies 4 Projects a Solution b COM b Browse Mame Orchard Redis Orchard Roles Orchard Rules Orchard Scripting Orchard Scripting CSharp Orchard Scripting DIr Orchard Search Orchard SecureSocketsLayer Orchard Setup Orchard Specs Orchard Tags Orchard TaskLease Orchard Taxonomies Orchard Templates Orchard Tests Orchard Tests Modules Orchard Themes Orchard Tokens Orchard Tokens Tests Orchard Users Orchard Warmup Orchard WarmupStarter Orchard Web Orchard Web Tests Reference Manager Orchard LearnOrchard FeaturedProduct Path E rtpSoftware Orchar E rtpSoftwarekOrchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware Orchar E rtpSoftware
312. ers can find related modules easily In this case we will make our own category Learn Orchard which is the category used for all demo modules on this site 1 Open module txt 2 Add the following line to the file Category Learn Orchard It doesn t matter where you put it in this case because we are only defining a single feature In the future if your module supports multiple features then you should add in the relevant category to each feature 3 Save the file You will probably need to restart the development server before Orchard picks up the changes you ve made to your module txt Localize all of your text Orchard has great support for writing global aware localized websites Administrators can add cultures to their site for a wide variety of different languages This means that as a module developer you can t know ahead of time what language your module will be used in Orchard makes it possible for you to support this scenario by wrapping all of your text in a T method Every string that you display in Orchard should be passed through the T method When you are working with Razor views the T is automatically available So for example this snippet from the FeaturedProduct cshtml view would change from lt p class sale red gt ON SALE lt p gt Over to lt p Class sale red gt ceT ON SALE lt p gt If you need to inject variables into the string then you should use String Format s
313. es the return value of the UpdateFromN you just created Download the code for this lesson You can download a copy of the module so far at this link e Download Orchard LearnOrchard FeaturedProduct Part4 v1 0 zip 344 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 To use it in Orchard simply extract the archive into the modules directory at src Orchard Web Modules If you already have the module installed from a previous part then delete that folder first For Orchard to recognize it the folder name should match the name of the module Make sure that the folder name is Orchard LearnOrchard FeaturedProduct and then the modules files are located directly under that Conclusion In this course we have looked at many of the core components that make up a module These topics included Command line scaffolding Module txt manifest ContentPart ContentPartRecord Widget Data migration Dependency injection Handler Driver Editor view Front end view Placement info Content types via the admin dashboard Fields Localization Module dependencies Resource manifest Services Orchard API This should have given you a solid grounding for extending Orchard via code With this knowledge you can now build your own simple modules and you will also understand the documentation found elsewhere on this site and around the web Bonus Exercise Using the skills you have now learned research implement th
314. ew module Orchard Azure A new module Orchard Azure has been added All Azure specific functionality has been consolidated into this module Some functionality is enabled automatically by configuration when publishing to a Windows Azure Cloud Service while other functionality is packaged as features which can be enabled regardless of hosting The module contains the following features Windows Azure Media Storage Provides an Orchard media storage provider that targets Windows Azure Blob Storage Windows Azure Output Cache Provides an Orchard output cache provider that targets Windows Azure Cache Windows Azure Database Cache Provides an NHibernate second level cache provider that targets Windows Azure Cache These features are completely portable and can be used from any hosting environment i e Windows Azure Cloud Services Windows Azure Web Sites or some other hosting option As you might guess from above as part of this work two new native providers for Windows Azure Cache have been written and are shipped built in with Orchard No more need to add the memcached shim to your deployment and no more need to install custom modules with third party memcached providers in order to use Windows Azure Cache 244 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 which also means better performance as the memcached compatibility layer is not used The new native providers have been designed and tested to wor
315. ewsletter The Dynamic Forms is also a great way to implement a Contact Us page or any other number of types of information a site should collect from it s users Exporting Forms saved as a Form Submission To export form submissions you need to enable the Dynamic Forms Import Export module upload dynamic forms enable import export png Once enabled now when you perform an export you need to enable the custom step called Forms to export your Form Submissions upload dynamic forms exporting form submissions png 234 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 3 5 Hosting and Deploying Websites 3 5 1 Upgrading a Site to a New Version of Orchard A new version of a CMS is an important event in the life of a site and transitioning to it should ideally be simple Unfortunately Orchard does not currently have an automated upgrade mechanism This topic will show how to upgrade to a new version as painlessly as possible today while focusing on making your data safe A Word of Warning No matter which method you choose to use to upgrade your site you are going to have to overwrite a lot of files in the process This should emphasize the requirement to backup first but it should also call your attention to any modifications you made to common files For example if you made any modifications to core modules and or the framework something you shouldn t do custom modules and themes s
316. f the media file Edit Media Penguins jpg Media Folders gt HtmlWidget gt Edit Media Size 31 KB Added on 3 14 2011 4 10 52 PM Embed lt img src Media Default HtmlWidget Penguins pg 7 Copy this html to add this image to your site Name Penguins pg To manage the subfolders for your media folder click Media again on the dashboard Then click a folder to display the Manage Folder screen 1 8 Adding and Managing Media Content 87 Read the Docs Template Documentation Release 1 9 2 Manage Folder User admin Logout Media Folders gt HtmlWidget gt Manage Folder Actions Delete Add afolder Add media 1 Name Author Last Updated Type Size E Hydrangeas jpg 3 14 2011 4 12 29 PM jpg 33 KB E Penquins jpq 3 14 2011 4 10 52 PM Jpg 31 KB E Tulips jpg 3 14 2011 4 01 58 PM jpg 28 KB This screen gives you the options to add or delete media files and to create subfolders Click Add a folder to create a new subfolder Name the new subfolder for example name the subfolder Pictures and save it Add a Folder User admin Logout Media Folders gt HtmlWidget gt Add a Folder Folder Name Pictures Save Browse to the new subfolder and click Add media Manage Folder User admin Logout Media Folders HtmlWidget gt Pictures gt Manage Folder Actions Delete v Add afolder Add media 1 Name Author Last Updated Type Size Orchard lets you upload single media file
317. f your site 2 Click Content Definition in the menu down the side 3 Click Create new type 4 Enter Product for the Display Name This should automatically fill out the Content Type Id field for you Make sure the Content Type Idis also set to Product Attachments getting started with modules part 3 democontent newtype png 1 Click Create 2 IntheAdd Parts to Product section tick the following parts Autoroute Body e Menu e Title 3 Click Save You will be taken to the Edit Content Type page and you should see several messages from the Orchard notifier system 1 Attachments getting started with modules part 3 democontent partsadded png 1 Scroll down to the Fields section and then click the Add Field button Attachments getting started with modules part 3 democontent addfield png 1 On the Add New Field To Product page fill the form out like this Display Name Product Id Technical Name ProductId Field Type Input Field Display Name Product Id Name of the field as it will be displayed in screens Technical Name Productld Technical name of the field Field Type Input Field 3 9 Extending Orchard 315 Read the Docs Template Documentation Release 1 9 2 1 Click Save 2 The main Edit Content Type page will reopen Just for completeness lets configure the field so that it is flagged as required If you scroll to the Fields section you will see your new field is now liste
318. ference immediately apparent Note Alternatively instead of editing the hosts file you can use the URL _ 127 0 0 1 org uk_ where is the name of your tenant or another name of your choosing This will loop back to localhost and is sufficient for testing multi tenancy locally 3 8 3 Setting Up a Machine Key We recommend that deployed versions of Orchard are configured with a fixed machine key rather than the default setting which is to automatically generate the key at runtime This default setting can cause the key to change unexpectedly which can cause validation errors Setting Up the Machine Key Using IIS Manager If you have access to the IIS management console for the server where Orchard is installed it is the easiest way to set up a machine key Start the management console and then select the web site Open the machine key configuration Orchard Home Filter Go Show All Group by Area Gal ASP NET a E amp 9 E NET NET NET Error NET NET Profile NET Trust Application Authorizati Compilation Pages Globalizati Levels Settings ES al e ds d i Connection Machine Pages and Session SMTP Strings Key Controls State E mail IIS 4 E Authentica COI Compressi Default Directory Error Pages Handler Document Browsing Mappings n i tl zs 1M dise The machine key control panel has the following settings 3 8 Using Windows Azure Cache 267 Read the Docs Template Do
319. fferent features included in the module may have each have their own category to move that feature into the most relevant area of the admin dashboard To aid in discoverability module developers should prefer to review the Modules page of the Orchard admin dashboard and choose a related category from existing categories If a relevant category doesn t exist modules can freely define a new category within this field of the manifest Dependencies Required if the feature has dependenciesA comma separated list of the application Id values of all features that the specified feature depends on Each individual feature should only define its own dependencies If all features are defined in the Features subsection this main Dependencies field is not required Note dependencies are case sensitive Priority OptionalThe default is 0 and higher priorities will take precedence Used by Orchard to determine how to resolve dependencies implementing a specific interface Module manifest examples Listed below are the three different ways you can use the module manifest Single feature module Name Modules AntiForgery enabled Author The Orchard Team Website http orchardproject net Version 1 9 1 OrchardVersion 1 9 Description The Modules module enables the administrator of the site to manage the instal FeatureDescription Standard module and feature management Dependencies Orchard ExampleModule Orchard AnotherModule Category Core Multipl
320. fg gt cfg WithSetting Stereotype Widget WithPart typeof FeaturedProductPart Name WithPart typeof CommonPart Name 296 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 WithPart typeof WidgetPart Name return 1 Update dependencies as you go along In the Create method of the data migration we introduced a dependency on WidgetPart This means that our module won t run without the Orchard Widgets module being installed and enabled within the system In order to let Orchard know that we have this dependency we need to record it in a manifest file called Module txt This 1s a text file written in YAML format which stores meta information about the module like the name author description and dependencies on other modules If you haven t heard of YAML before don t worry it is a simple format to understand We will look at the Module txt manifest file again in more detail in part 4 of this course for now we just need to go in and record the dependency we have created with Orchard Widgets It is important to record this information as soon as we make a dependency on a module If we don t record the information then your module can cause exceptions for your users at run time You really need to get into the habit of doing it straight away because not only are they are easy to forget but if you have the module that you depend on already enabled you won t see any errors but your users
321. figure your storage connection string to take advantage of your custom domain Orchard will continue to generate public URLs for the media files stored in Microsoft Azure Blob Storage based on the default mystorageaccount blob core windows net hostname To ensure the public URLs for your media files contain your custom domain name modify your storage account connection string accordingly See the topic Configuring Connection Strings in the Microsoft Azure Storage docu mentation for details Here s an example connection string using a custom domain name BlobEndpoint http blobs mycustomdomain com AccountName mystorageaccount AccountKey KauG3 3 7 5 Multi tenancy configuration For multi tenancy scenarios each setting can optionally be prefixed with a tenant name followed by colon such as SomeTenant Orchard Azure Media StorageConnectionString Whenever the media storage provider reads configuration settings it will always first look for a setting specific for the current tenant and if no such setting exists fallback to the default non prefixed setting Here s an example Azure Web Site configuration with two tenants both using Microsoft Azure Blob Storage is the underlying file system implementation for storing media but each using its own separate storage account lt appSettings gt lt l Setting for Ienantl gt add key Tenantl Orchard Azure Media StorageConnectionString value storageConne amp lece Setting for Tenantz
322. files and folders The first step to take is to collapse all of the projects down Its a long list and we need to be able to see an overview of the solution so we can start working with it You don t need to collapse these individually by hand however 1 If your Solution Explorer window is not visible click View Solution Explorer 2 Click the Collapse A11 icon in the toolbar along the top of the solution explorer It looks like this 1 Attachments getting started with modules part 1 collapse all png If you expand your Modules folder you will see a long list of the modules which come packaged with Orchard 286 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 ACOTIT PLP elf LAPTE Lo LET J rr fg Solution Orchard 83 projects 4 Modules ag Lucene a8 Markdown a amp Orchard Alias 88g Orchard AntiSpam 88 Orchard ArchiveLater ag Orchard AuditTrail a amp Orchard Autoroute agg Orchard Azure a8 Orchard Azure MediaServices agg Orchard Blogs 88 Orchard Caching aa Orchard CodeGeneration Lu ccc There is a utility that is packaged with each copy of Orchard which will let us add our own module into this list It is called orchard exe This is a command line utility which will scaffold up a new empty module and add it to the main solution There are also other commands you can use with this utility To scaffold a new module 1 Press the Save A11 button or press Ctrl
323. folder 4 TheThemeMachine 4 gt Styles A3 Site css Web config 4 y Views ial BadgeOfHonor cshtml ia Branding cshtml ia Layout cshtml Theme png s Theme txt Web config The TheThemeMachine theme has been designed to be a clean looking modern theme and to be a good starting point for customization and for the development of new themes This article uses this theme as an illustration Anatomy of a Theme This section describes required and optional elements of a theme Manifest To be valid a theme must have a manifest that describes it to the system The manifest is a text file named Theme txt that is found in the root folder of the theme it describes Here is the manifest for the TheThemeMachine theme Name The Theme Machine Author jowall mibach loudej heskew Description Orchard Theme Machine is a flexible multi zone theme that provides a solid foi 4000 Chapter3 Documentation Read the Docs Template Documentation Release 1 9 2 Wereton Xd Tags Awesome Websites Attest orchardpro eck ner Zones Header Navigation Featured BeforeMain AsideFirst Messages BeforeContent Cont The beginning of the file gives the theme a friendly name description author description and tags The Zones field provides a list of all the zone names that are going to be available for widgets throughout the theme s layouts and templates Zones are containers that can be added to any template or layout Various UI element
324. fully Build Debug Team Data Tools Architecture I H Build Solution Ctr Shift B Rebuild Solution Clean Solution Build Maps Rebuild Maps Clean Maps a Publish Maps Run Code Analysis on Maps Configuration Manager Next we are going to create a data migration for our Maps module Why do we need a migration class The reason is that defining a Record and Part class to store the data doesn t actually impact the database in any way A data migration is what tells Orchard how to update the database schema when the Maps feature is enabled the migration runs when the feature is activated A migration can also upgrade the database schema from prior versions of a module to the schema required by a newer version of a module this is an advanced topic that won t be covered in this tutorial To create a new data migration class you can use the Code Generation feature of Orchard Run codegen datamigration Maps from the Orchard command line orchard gt codegen datamigration Maps Creating Data Migration for Maps Data migration created successfully in Module Maps Visual Studio prompts to re load the solution again After accepting this prompt the new data migration classes appears in the project 3 9 Extending Orchard 363 Read the Docs Template Documentation Release 1 9 2 4 54 Maps E using using using using using using using using sing sa Properties lt j References Controllers uy Models 4 Map
325. functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you 50 if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Edit second Leader Aside E Third Leader Aside Eu ore Lorem ipsum dolor sit amet consectetur adipiscing Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel Aliquam vel sem nibh Suspendisse vel condimentum tellus condimentum tellus The left side of the frame displays which shape is selected It also enables you to select which shape to highlight by providing a navigable tree for the shapes F zone Content 4 Zone TripelFirst 4 Widget Parts Contents Publish empty Parts Common Body e Zone Tripel amp econd Zone TripelThird P zone Footer The right side displays information about the selected shape and enables you to select which type of information to display 480 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Model Placement Template HTML Shape Parts Common Body Active Template Core Commony Views Parts Common Bady cshtml Display Type Detail F Alternate 3 Wrappers 0 The Shape Tracing pane displays the following information
326. g A Map part must save its coordinates Latitude amp amp Longitude so it will be linked to a record with these two properties and Orchard will do the rest to load save it You will not have to deal with records unless you develop your own module But it is useful to understand this concept in case you encounter it Record In order to be able to save a content type part in a database it needs to be linked to a record It is a class with all the properties that should be saved Eg A Map part must save its coordinates Latitude amp amp Longitude so it will be linked to a record with these two properties and Orchard will do the rest to load save it You will not have to deal with records unless you develop your own module But it is useful to understand this concept in case you encounter it Note that a content type can only have one of each kind of content parts But it can have many fields of the same kind The reason 1s in the semantic meaning of these concepts For example a blog post can only have one commenting aspect and it can have many dates creation date last update date etc Since Orchard is an open source project feel free to contribute any feature module you would like Conclusion We are going to stop here At this point you should have a good understanding of what is Orchard The next step is to get into a bit more details about modules themes and the low level architecture of Orchard This would be useful w
327. g Modules Orchard is a modular web based CMS designed to be extended easily by installing additional modules and enabling module features A module is a package that can be installed and uninstalled A package consists of a ZIP file in the nupkg file format A feature is a behavior that s exposed by an installed module that you can individually enable or disable This topic shows you how to install or download modules from the online gallery how to install a module from your local computer and how to work with the features of an installed module It also shows you how to update installed modules Note If your site is running under IIS make sure you have granted read write permissions to the Themes folder under the root of your site for the service account that is being used as the IIS application pool identity However you should remove the write permissions on a production server Viewing Installed Modules To view the modules that have been installed for your site click Modules on the dashboard and then in the Modules screen click the Installed tab Documentation Upload screenshots 675 modules installedTab upload 675 png The Installed tab displays a list of the modules that are included with Orchard along with properties of each module such as version author a description and a list of features It also provides a link that you can use to upload and install a module package 3 4 Managing Websites 187 Read the Doc
328. g a Blog which already has it s own topic Updates for Orchard 1 1 3 14 11 Updated screen shots showing updated menus and updated dashboard and settings options 72 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 1 6 Navigation and Menus This topic targets and was tested with the Orchard 1 6 release It also includes a reference to navigation in Orchard eL There are different ways to build up a menu structure Here we will show two common methods that could be used Adding menu items first content later Content first navigation later Of course they are not mutually exclusive you can alternate both methods in the same site 1 6 1 Adding Menu Items First Content Later This method could be prefered when you first want to style your website to see all menu items In the Orchard administration panel click the Navigation menu item You will see that there is a default menu available called Main Menu The right side contains all types of menu items that you can add Content Menu Item e Custom Link Html Menu Item Query Link e Shape Link Taxonomy Link Click Add next to the Content Menu Item to add a new menu item Navigation User admin Laga Current Menu iain Menu Y Add anew menu Home Custom Link Edit Delete onteni hierar iian Adds a Content ltem to the menu Custom Link Add Represents a simple custom link with a text and an u
329. ge The first step to creating your own service is to write an interface for the class The second step is to write a concrete class which implements that interface Then we move the code from the driver to the concrete class Then we request the service in the driver and use its functionality The way dependency injection works is that you request an interface to be injected and based on the configuration values of the system your request is resolved to the best matching concrete class In our case there will be only one concrete class so it will be a simple decision but this highlights again the extensibility of the Orchard architecture There is nothing stopping a developer coming along and writing their own version of a particular service and configuring the dependency injection framework to use theirs instead When you only work with the interface it doesn t matter to you which underlying class is provided Let s upgrade the module to use our own service 1 In the Solution Explorer right click on the module s project name 2 Select Add New Folder and name it Services 3 Right click the Services folder select Add New Item 4 Select the Interface item template name it IFeaturedProductService and click Add 5 The interface should be public so add that keyword to the start of the interface declaration It should also implement the Dependency interface public interface IFeaturedProductService Dependency 6 The purpose of th
330. ge 1 3 6 Working with the Database If you selected SQL Server Compact for the the database option in Orchard setup you can open the Orchard sdf database in WebMatrix by selecting Databases Home Remote x Restart PON Close All Editing View Launch Galleries Resources T ki T Oper d Cut ai iY Add Existing copy a 4 e a Orchard CMS App Data bin Config Core Media Modules Themes Li CREDITS tet L Global asax Ld LICENSE bit E m r I Poo I Create a new file Choose from one of many templates Site E Files mn Reports eee Find Results Error List Once the database window is opened you can view the contents of a table by selecting the table in the explorer pane 1 3 Working with Orchard in WebMatrix 33 Read the Docs Template Documentation Release 1 9 2 Home New Definition Table 4 Orchard CMS F Orchard sdf 4 Tables C Common BodyPartRecord C Common CommonPartRecord Ld Common CommonPartVersionRecord P Table Orchard CMS Microsoft WebMatrix Table Refresh Delete Row Data Table Orchard s nPartVersionRecord Id ContentltemRecord id CreatedUtc 11 12 2012 9 35 14 PM 11 12 2012 9 35 14 PM 11 12 2012 9 35 14 PM 11 12 2012 9 35 14 PM Lj Common Id entityPartRecord Ld Containers ContainablePartRecord C Containers ContainerPartRecord sg Containers ContainerWidgetPartRecord EE Containers CustomPropertiesPartR
331. gitude lt div gt lt div class edrtor trelgdg et aHtml TextBoxFor model gt model Longitude Html ValidationMessageFor model gt model Longitude lt div gt lt fieldset gt Views Parts Map cshtml lt img alt Location border 1 src http maps google com maps api staticmap amp zoom 14 amp size 256x250 amp maptype roadmap amp markers color blue GModel Latitude Model Longitude amp sensor false Both of these templates will be rendered as parts of a larger composite page Because the system needs to know the order and location where they will render within the composed page we need to add a placement info file into the root of the module s directory Placement Place Parts _Map Content 10 gt Place Parts Map Edit Content 7 5 7 5 lt Placement gt This is saying that the Parts_Map shape which is rendered by Views Parts Maps cshtml unless overridden in the current theme should render in the Content zone if available in tenth position It also positions the editor shape template in the Primary zone in second position To activate the Map part go to the Features section of the Orchard admin panel and enable it 366 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Geolocation Bing Maps Enable Bing Maps is disabled You can try out the Map part by attaching it to any content type in the system using the Conten
332. greeting is greetingMessage lt p gt The greeting is Welcome to our site Today 1s Wednesday When the code block consists of a single expression such as a for loop you can place the character in front of a language keyword In this case the for loop serves as the entire code block so you do not need an outer character and braces to enclose the block You can use the same approach with other block coding structures in C if then statements foreach and while loops case statements and so on In the following expression the character is placed in front of the keyword for The loop prints a set of numbered lines from 10 to 20 Qfor var i 10 i lt 21 i lt p gt Line i lt p gt 464 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Item 10 Item 11 Item 12 Item 13 Item 14 Item z 18 Item 19 Item 2 20 The following example shows how to embed server side comments in your web pages These comments are stripped from the markup before the web page is sent to the browser so users cannot see them In contrast client markup comments lt gt are not stripped from the markup so users can see them x This is a one line comment lt d x This is a multi line comment It can continue for any number of lines x Comments within a Razor syntax code block can also use the standard C commenting syntax Accessing Orchard Object
333. guide Add the placement info file to your module l Right click on the module project in the solution explorer 2 Choose Add New Item to get to the add item screen 3 9 Extending Orchard 299 Read the Docs Template Documentation Release 1 9 2 Add New Item Orchard LearnOrchard FeaturedProduct 4 Installed Sort by Default v aa Search Installed Templates Ctrl E P fri Application Manifest File Visual C lt Type Visual Ce nium An empty text file Data c EL Q i Assembly Information File Visual C b Web Windows Forms 43 Class Diagram Visual C WPF Silverlight 9 Code Analysis Rule Set Visual C SQL Server c Workflow Debugger Visualizer Visual C PowerShell J Installer Class Visual C b Online Resources File Visual C e Runtime Directives Visual C bi Runtime Text Template Visual C 3 Tex File Qo Visual C B Text Template Visual C i Windows Script Host Visual C m rx ir m Ff m LE a ire Click here to go online and find templates Name 3 5 ll O Ce 3 From the templates categories in the left hand side choose General 4 Find Text File in the list 5 Enter placement info in the Name field 6 Click OK This module has a single shape so we need to set up a Place for that shape 1 Add this snippet to the empty placement info file The Content 1 is the zone and priority of that shape A shape will have several zones defined for it Typically these i
334. guration options are described the following topics Using Windows Azure Blob Storage 3 5 Hosting and Deploying Websites 249 Read the Docs Template Documentation Release 1 9 2 Using Windows Azure Cache Deploying After these few steps of preparation you are now ready to deploy the cloud service Right click the Orchard Azure CloudService project in Solution Explorer and select Publish and follow the instructions in the publishing wizard to select subscription cloud service storage account and other publishing options How to use the Windows Azure publishing tools in Visual Studio is beyond the scope of this topic but they are pretty self explanatory Once deployment has successfully completed browse to the deployed Orchard site and go through setup Specify the connection string to the Windows Azure SQL Database you created earlier How would you like to store your data Use built in data storage SQL Server Compact O Use an existing MySql database Connection string SourcezsqiServerName nitial Catalag dbName Persist Security infos True User IDzuserNams Passwaord passvword Database Table Prefix Once setup has finished navigate to the admin dashboard of the site and enable the following three features Windows Azure Media Storage Windows Azure Output Cache Windows Azure Database Cache Congratulations Orchard is now fully configured for multiple role instances on Windows Azure You can now scale out t
335. hard Azure Media StorageConnectionString 4 Set it to be the connection string of the storage account in which you want to store media content 5 Click Save You can now enable the feature Microsoft Azure Media Storage in the admin dashboard NOTE For multi tenancy scenarios the Orchard Azure Media StorageConnectionString setting can optionally be prefixed with a tenant name 3 7 2 Enabling for Microsoft Azure Web Sites Before the feature can be enabled you must configure the connection string to the storage account you want to use When running Orchard in a Microsoft Azure Web Site this can be done either before deploying in Web config or after deploying in the Microsoft Azure management portal To configure the connection string before deploying 1 Open Orchard sln 2 Navigate to Orchard Web and open the Web config file 3 Inthe lt appSettings gt element add a setting named Orchard Azure Media StorageConnectionString and set its value to be the connection string of the storage account in which you want to store media content see example below 4 Deploy the web site Here s an example configuration lt appSettings gt lt add key Orchard Azure Media StorageConnectionString value storageConnectionstr lt appSettings gt The storage connections string will look something like the following DefaultEndpointsProtocol http AccountName myAccount AccountKey myKey You can get the account name and key from the Microsof
336. hard Bloogs m Controller BlhogPostAcmin 4 Action Delete postid pgontexLt cContentrrem rdg blogslug bLogPOSt BlogPart As RoutePart Slug ma AS o c 3 4 4 4 iy 3 11 Creating Themes 3 11 1 Writing a New Theme This topic was updated for the Orchard 1 0 release An Orchard theme defines an application s appearance and is used to customize the look and feel of an Orchard website A theme can override the style sheets images layouts or content templates provided by any Orchard module In addition a theme can contain code that overrides targeted code in a module This article shows how to create a theme from scratch It is intended to be an introduction to theme development and has been kept simple by design Instead of starting from scratch you can create a theme by customizing an existing theme a parent theme Orchard provides a theme named TheThemeMachine that is designed as an easy to use parent for custom themes For more information about using a parent theme see Customizing the Default Theme Generating a New Theme Before you can use the command line command codegen to generate the code structure for you new theme you must download and enable the Code Generation feature This feature is not installed to Orchard by default For more information see Command line code generation To generate the code structure for a new theme open the Orchard command line utility and ent
337. hard ContentManagement using Orchard ContentManagement Records namespace SimpleCommerce Models public class ProductPartRecord ContentPartRecord public virtual string Sku get set public virtual float Price get set public class Prod ctPart ContentPart ProductPartRecord Required public string Sku get return Retrieve r gt r Sku 352 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 set Store r gt r Sku value Required public float Price get return Retrieve r gt r Price set Store r gt r Price value This code has two properties Sku and Price that are virtual in order to enable the creation of a dynamic proxy that will handle persistence transparently The code also defines a content part that derives from ContentPart lt ProductPartRecord gt and that exposes the SKU and price from the record as public properties and infoset You can find more info about infoset here The properties have attributes that will surface in the UI as validation tests In order for the application to pick up the new file you need to add it to the module s project file Open the Sim pleCommerce csproj file and look for assemblyinfo cs After that line add the following Compile Include Models Product cs Save the file but leave it open because you will make additional changes to it throughout the tutorial Navigate to the site in your b
338. hard to Windows Azure NOTE The Windows Azure deployment process in Orchard has undergone a complete overhaul for ver sion 1 7 1 For more information about what s changed see the What s new for Windows Azure in Orchard 1 7 1 topic 3 5 Hosting and Deploying Websites 245 Read the Docs Template Documentation Release 1 9 2 Prerequisites Before you can deploy Orchard to Windows Azure you need the following e Visual Studio 2012 Windows Azure SDK 2 1 for Visual Studio 2012 The Orchard source code An active Windows Azure subscription Deploying Orchard to a Windows Azure Cloud Service If you only plan to run a single role instance deploying is extremely simple Starting with version 1 7 1 of Orchard deployment can be performed using the Windows Azure tooling in Visual Studio By default Orchard uses a local file based SQL Server CE database This database won t suffice when running in a Windows Azure Cloud Service because the Windows Azure fabric controller may decide to reimage your role instance at any time without warning When that happens anything that has been written to the local hard drive in your role instance VM since it was created is lost which means any changes made to the site since it was first deployed will be lost Obviously that s not acceptable so we need to instead store the data in a shared database that will not be affected by role instance reimaging To do this you need to create a Windows Azure SQL d
339. hat default rendering may be overridden by the current theme The theme does that by having its own version of a template for that shape or its own shape method for that shape Themes can have a parent which enables child themes to be specializations or adaptations of a parent theme Orchard comes with a base theme called the Theme Machine that has been designed to make it easy to use as a parent theme Themes can contain code in much the same way modules do they can have their own csproj file and benefit from dynamic compilation This enables themes to define shape methods but also to expose admin UI for any settings they may have The selection of the current theme is done by classes implementing IThemeSelector which return a theme name and a priority for any request This allows many selectors to contribute to the choice of the theme Orchard comes with four implementations of ThemeSelector e SiteThemeSelector selects the theme that is currently configured for the tenant or site with a low priority e AdminThemeSelector takes over and returns the admin theme with a high priority whenever the current URL is an admin URL 3 9 Extending Orchard 283 Read the Docs Template Documentation Release 1 9 2 e PreviewThemeSelector overrides the site s current theme with the theme being previewed if the current user is the one that initiated the theme preview e SafeModeThemeSelector is the only selector available when the application is in
340. hat the layout template references zones in addition to the Content zone These new zones are added to the Layout shape if content is added to the zone Html RegisterStyle site css 1 Model Header Add Display Header 5 Model Header Add Display User 10 Model Header Add Model Navigation 15 lt div id 2 page lt header gt Display Model Header lt header gt lt div id main gt 468 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 div id 2 messages aDisplay Model Messages lt div gt div id content wrapper gt div id 2 content Display Model Content lt div gt lt div gt div id 2 sidebar wrapper div id sidebar gt aDisplay Model Sidebar lt div gt lt div gt lt div gt div id footer wrapper footer aDisplay Model Footer footer lt div gt lt div gt This layout template contains a code block that adds subzones to the Header zone It also refers to the following new zones Messages Sidebar and Footer In order for these zones to appear in the Orchard UI so you can add content to them you must reference the zones in the theme s Theme txt file as shown in the following example Name SimpleTheme Author Description Simple example theme Version 1 0 Tags Simple Website http www orchardproject net Zones Header User Navigation Messages Content
341. he Docs Template Documentation Release 1 9 2 9 euni lVocdules Features Installed Recipes Gallery New Filter Wrappe Actions Enable Y B Content Content So m pu mei eS l Content Definition I Blog Queries 4 Content Control Wrapper Enable Add an Edit button on the front end for authenticated users Depends on Contents E Comments Widget Widget Control Wrapper Enable Add an Edit button on the front end for authenticated users Depends on Widgets Modules Iu Themes Once these modules are enabled you can edit the contents of an individual zone by clicking the Edit link at the top right in the zone 15 Getting Started with Orchard 0 55 Read the Docs Template Documentation Release 1 9 2 My Website some ee ee eee E Tc MM Welcome to Orchard Nov 12 2012 4 35 PM You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head over to manage themes to change or install new themes and really make it your own Once you re happy with a look and feel it s time for some content You can start creating new custom conten
342. he command a second time to make sure Type the following command feature enable Orchard CodeGeneration and press enter orchard feature enable Orchard CodeGeneration Enabling features Orchard CodeGenerat ion ode Generation was enabled oc hard gt This will activate the code generation features of orchard exe The command that we will be using is codegen datamigration 8 Type help codegen datamigration and press enter to see the syntax for this command To see details about all of the commands available type help commands Like the rest of Orchard CMS the orchard exe command shell is extendable The total numbe 1 Scaffold the data migration class by entering the following command codegen datamigration Orchard LearnOrchard FeaturedProduct 2 Close the Orchard command line window 3 This has now created a new data migration the file system called Migrations cs It will be in the root folder of your module Switching back to Visual Studio should show you the File Modification Detected dialog 1 Attachments getting started with modules part 1 reload solution png Click Reload gt xxNote x x If you had unsaved changes in your Solution file then click the Dismiss opti Now you have aMigrations cs file in the root folder of your module s project By default it has an empty method called Create which returns an int For the moment returning a value of 1 is fine It s the version number of your d
343. he comment is displayed 3 4 Managing Websites 199 Read the Docs Template Documentation Release 1 9 2 Edit Comment User admin Logout Name syed Abbas Email syed cohowinery com Uri http www cohowinery com Body What a cool blog post Pending Approved Mark as spam Click Pending to change the comment status and then save the comment Browse to your site and view the content item for which you changed the comment category to pending The pending comment is no longer visible You can assign comments to the following categories Pending The comment is pending administrator approval The comment will not be visible to users unless an administrator marks it as Approved Approved The comment is approved and will appear on the site This is the default category for new comments unless you enable the site level setting to require approval of all comments See the next section e Mark as spam The comment is spam and will not displayed For more information see the next section Setting Site Level Comment Options Orchard provides two site level features for comments administrative approval of comments and spam protection You can access both features by clicking Settings Comments on the dashboard to open the screen for setting comment options 200 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Requiring Approval for Comments You might want to require moderator
344. he database the data from myPartRepository Another example of a filter is the Acti vatingFilter that is in charge of doing the actual welding of parts onto a type calling Filters Add new ActivatingFilter lt BodyAspect gt BlogPostDriver ContentType Name adds the body content part to blog posts e drivers Drivers are friendlier more specialized handlers and as a consequence less flexible and are associated with a specific content part type they derive from ContentPartDriver lt T gt where T is a content part type Handlers on the other hand do not have to be specific to a content part type Drivers can be seen as controllers for a specific part They typically build shapes to be rendered by the theme engine Content Manager All contents are accessed in Orchard through the ContentManager object which is how it becomes possible to use contents of a type you don t know in advance ContentManager has methods to query the content store to version contents and to manage their publication status Transactions Orchard is automatically creating a transaction for each HTTP request That means that all operations that happen during a request are part of an ambient transaction If code during that request aborts that transaction all data operations will be rolled back If the transaction is never explicitly cancelled on the other hand all operations get committed at the end of the request without an explicit commit Request Lifecycle
345. he2 orchard demo error log CustomLog var log apache2 orchard demo access log combined HostnameLookups Off UseCanonicalName Off ServerSignature On Make ABSOLUTELY sure that the path in double quotes ends with a slash Alias srv www vhosts orchard demo AddMonoApplications OrchardDemo srv www vhosts orchard demo Orchard is a NET 4 0 application If your Mono was installed in a different prefix MonoServerPath OrchardDemo usr bin mod mono server4 Helps when you get stack traces MonoDebug OrchardDemo True 256 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Orchard assumes a case insensitive filesystem MonolOMAP OrchardDemo all Directory srv www vhosts orchard demo SetHandler mono MonoSetServerAlias OrchardDemo lt Directory gt lt VirtualHost gt Save the file close the editor and type one the following commands to restart Apache use only one of those service apache2 restart ete init d apache2 restart To make sure Mono backend has been started correctly type ps ax grep OrchardDemo As the result you should see output similar to Zoo 2 Ssl 0 00 usr bin mono debug usr lib mono 4 0 mod mono server4 exe f Now you are ready to start your favorite web browser and point it to http orchard demo Configuring for XSP No extra steps are necessary You need to run xsp4 in the Orchard Web directory using the following command line MONO IOMAP
346. hemes The second is to go to the dashboard Themes page and click the link to install a theme which allows you to browse for a theme package on your local computer and install it Note If your site is running under IIS make sure you have granted read write permissions to the Themes folder under the root of your site for the service account that is being used as the IIS application pool identity However you should remove the write permissions on a production server Installing a Theme from the Gallery When the gallery feature is enabled as it is by default in Orchard a Gallery tab appears at the top of the both the Themes screen and the Modules screen in the dashboard Themes Installed Updates 0 Note If the gallery feature has been disabled there will be no Gallery tab visible in the Themes or Modules dashboard screens To enable a disabled gallery click Modules in the dashboard and click Enable on the Gallery feature In the Themes screen of the dashboard click the Gallery tab A set of themes appears with a pair of Install and Download links next to each theme Documentation Upload screenshots_675 Gallerythemes_installing_675 png To install a theme in your site click the Install link next to the theme Installing a theme adds it to your site in the Available list of themes on the Themes page in the dashboard From there you can preview a theme or set it as the current site theme as described Previewing and Appl
347. hen you start learning how to extend Orchard 3 9 2 How Orchard Works Building a Web CMS Content Management System is unlike building a regular web application it is more like building an application container When designing such a system it is necessary to build extensibility as a first class feature This can be a challenge as the very open type of architecture that s necessary to allow for great extensibility may compromise the usability of the application everything in the system needs to be composable with unknown future modules including at the user interface level Orchestrating all those little parts that don t know about each other into a coherent whole is what Orchard is all about This document explains the architectural choices we made in Orchard and how they are solving that particular problem of getting both flexibility and a good user experience 276 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Architecture Orchard Foundations The Orchard CMS is built on existing frameworks and libraries Here are a few of the most fundamental ones e ASP NET MVC ASP NET MVC is a modern Web development framework that encourages separation of con cerns e NHibernate NHibernate is an object relational mapping tool It handles the persistence of the Orchard content items to the database and considerably simplifies the data model by removing altogether the concern of persis tence from module development
348. his means in the future if we want to make further changes we could add an UpdateFrom2 method We can keep returning a number one higher than the previous to update as many times as we need 1 Open the Migrations cs file in the root folder of the module 2 Beneath the Create method add in the following method public int UpdateFrom1 SchemaBuilder CreateTable typeof FeaturedProductPartRecord Name table gt ta ble ContentPartRecord Column IsOnSale return 2 To start off with we are using the SchemaBuilder class to create a new table The first parameter is the table name This should match the ContentPartRecord we built Instead of pulling it out using typeof Name you could pass in a string such as CreateTable FeaturedProductsPartRecord butthat leaves you open to intro ducing small typos into the code like I did just then Did you notice the extra s I accidentally typed into the table name If you make a mistake like this then you won t get an exception Orchard will still run but your data will be saved to the wrong table creating hard to find bugs The ContentPartRecord callis just a simple shorthand to add in the id column If you look in the definition just place your cursor in the method in Visual Studio and press F12 you will see it simply adds an extra Column lt gt into the chain Column int Id column gt column PrimaryKey NotNull We then add our column with a data type
349. hod Get takes a key and a function that can be used to generate the cache entry s value if the cache doesn t already contains the requested entry The main advantage of using the Orchard API for caching is that it works per tenant transparently File Systems The file system in Orchard is abstracted so that storage can be directed to the physical file system or to an alternate storage such as Azure blob storage depending on the environment The Media module is an example of a module that uses that abstracted file system Users and Roles Users in Orchard are content items albeit not routable ones which makes it easy for a profile module for example to extend them with additional fields Roles are a content part that gets welded onto users Permissions Every module can expose a set of permissions as well as how those permissions should be granted by default to Orchard s default roles Tasks Modules can schedule tasks by calling CreateTask on a dependency of type IScheduledTaskManager The task can then be executed by implementing IScheduledTaskHandler The Process method can examine the task type name and decide whether to handle it Tasks are being run on a separate thread that comes from the ASP NET thread pool Notifications Modules can surface messages to the admin UI by getting a dependency on INotifier and calling one of its methods Multiple notifications can be created as part of any request Localization Localiza
350. holders above you can use one of the available online generators such as http www eggheadcafe com articles GenerateMachineKey GenerateMachineKey aspx http www betterbuilt com machinekey e http www codeproject com KB aspnet Machine Key Generator aspx http www developerfusion com tools generatemachinekey 3 9 Extending Orchard 3 9 1 First Steps into Orchard The goal of this article is to ease you into Orchard There are so many concepts to understand that I think it is necessary to give a high level view of the whole thing before digging in So this article starts with a common ground that any web user should understand and progressively deepens while introducing relevant technical terms When you finish reading this you should have a good enough understanding to start playing with Orchard as a designer developer without getting confused by its high level architecture and its terminology When introduced each new term is put in bold so that you make sure to understand it before moving forward This article also contains a lot of links to other pages with more specific explanation so you can use it as a starting point To answer some general questions about what Orchard is and where it comes from read the Frequently Asked Questions For a more technical presentation read How Orchard works Looking at Orchard as The best way to introduce the basics of Orchard is to look at the roles that a user can have when access it
351. hould be used instead you will lose them or you will need to re apply your changes after the upgrade Any modification you made to web config or other common files will also need to be re applied after the process If you made modifications to permissions on the files and folders inside your site they may also get reset in the upgrade and need to be re applied Upgrading a Running Instance of Orchard to a New Version The instructions in this section only apply for a standalone Orchard web site If you are working with the full source code of Orchard please refer to enlistment It is highly recommended that you work on a local copy of your site throughout the update process Make a backup of everything in your site including the database This is extremely important so that you can roll back to a running site no matter what happens during migration Visit the Settings pages on your current Orchard instance and make a note of the current settings This infor mation might not be needed during the migration process but if it is it will otherwise be difficult to get the information Visit the Modules Features and the Themes pages on your current Orchard instance and make a note of all the modules and themes you have installed Download a copy of the site from the server to your local computer If you are routinely working with a staging environment from which you publish to production you already have that local copy but the data and me
352. i This PC Jg Desktop CREDITS J Documents L Global azax Jg Downloads LICENSE dM Music E Refresh Pictures Web config B Videos iy Local Disk C W CD Drive D IR3 CE r Cia Network a m O 12 items 1 tem selected Tip If you want to completely reset an Orchard site configuration to its default settings you can delete the contents of the App_Data directory This removes all your custom settings users and configuration as well as any custom data you have added to the site If you delete the contents of the App_Data folder and if you want to remove custom images that you have added to the site you can delete the contents of the Media folder as well The required files will be recreated the next time Orchard is started Now you can create your new website Search your system for Internet Information Services IIS Manager and execute it 12 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Search Everywhere Calendar internet information internet information services DOW 16378 04 115 48 FTSE 100 6 584 17 42 56 NIKKEI 225 A 14 417 68 420 87 internet information services lis manager internet information services windows f LE Internet Information Services IIS Manager i W8A gt Sites Default Web Site nmn 43 File View Help Default Web Site Home a S WBA w8a operator Ey Application Pools Filte
353. iable will then contain a string version of the content type The Product content type was created via the admin dashboard This means that there isn t a concrete class for us to use in a typeof T Name call so we will have to work with the string Product when we re checking the type of the current content item Putting the code together is just a case of a standard NET string comparison 1 Open up the FeaturedProductDriver cs file located in the Drivers folder 2 Locate the Display method and replace it with the following protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts FeaturedProduct gt bool isOnFeaturedProductPage false new code if CurrentContent null var itemTypeName CurrentContent ContentItem TypeDefinition Name if item TypeName Equals Product StringComparison InvariantCultureIgnoreCase final product id check will go here end of new code return shapeHelper Parts FeaturedProduct IsOnFeaturedProductPage isOnFea turedProductPage You don t need to include the comments in your module they are just for guidance Using fields Fields are a great way to quickly surface data We added one to our Product content type in the admin dashboard in just a minute or two We didn t need write a ContentPart or work with Visual Studio at all When creating websites in Orchard you will find plenty of occ
354. ibute name See the Text Field driver for example or read Creating a Custom Field Type You can learn more about shapes and alternates in these topics Accessing and Rendering Shapes and Alternates The value itself 1s split into a zone name a colon and then a position Local Zone Placement By default the zone name will specify a local zone If you look inside that shape template you will see that there are several locally defined zones Razor templates would use Display Model Content to display the content zone for example Usually you will find a zones like Header Meta Content or Footer available for placement Example local zone placement Place Parts TagClouds Content 5 Top Level Zone Placement The zone name can also specify a top level zone Top level zones are defined in the Layout cshtml view In the case of a top level zone the zone name must begin with a slash e g AsideFirst Example top level zone placement Place Parts TagCloud AsideFirst 5 3 11 Creating Themes 449 Read the Docs Template Documentation Release 1 9 2 Placement Order The position is defined using a dotted notation It can be a single number 1 5 10 42 or it can be a succession of numbers separated by a dot 1 2 1 52 3 etc The order will be determined starting from the first number and if multiple positions have the same first number using the subsequent numbers This way 1 comes before 2 4 5 and 2 4 5 come
355. ident you don t more T a When the Shape Tracing frame is collapsed your site functions as it would normally However when you click the icon the frame expands and displays Shape Tracing features Shape Information When the Shape Tracing frame is expanded you can hold the mouse pointer over a section of a page and that section is highlighted Click the highlighted section to display information about the shape and how it is rendered 3 11 Creating Themes 479 Read the Docs Template Documentation Release 1 9 2 My VS Orchard Site Home Blog Welcome to Orchard Edit apr 4 2011 3 28 PM You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t meed this anymore you can remove it by going into editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head over te manage themes to change or install new themes and really make it your own Once you re happy with a look and feel its time for some content You can start creating new custom cantent types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re looking to add additional
356. ield Drivers UsedImplicitly public class DateTimeFieldDriver ContentFieldDriver lt Fields DateTimeField gt public IOrchardServices Services get set EditorTemplates Fields Custom DateTime cshtml private const string TemplateName Fields Custom DateTime public DateTimeFieldDriver IOrchardServices services Services services T NullLocalizer Instance public Localizer T get set private static string GetPrefix ContentField field ContentPart part handles spaces in field names return part PartDefinition Name field Name JReplace The protected override DriverResult Display ContentPart part Fields DateTimeField field string displayType dynamic shapeHelper var settings field PartFieldDefinition Settings GetModel DateTimeFieldSettings var value field DateTime return ContentShape Fields Custom DateTime key in Shape Table field Name used to differentiate shapes in placement info override this is the actual Shape which will be resolved Fields Custom DateTime cshtml s gt s Name field Name Date value HasValue value Value ToLocalTime ToShortDateString String Empty 3 9 Extending Orchard 373 Read the Docs Template Documentation Release 1 9 2 Time value HasValue value Value ToLocalTime ToShortTimeString SEL iNGsEMpLy ShowDate settings Display DateTimeFieldDisplays DateAndTime settings Display
357. ilable features displays in Box view to maximize the number of features displayed at a glance 180 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 You can also switch views to List view if you prefer to see your features as a list of items with more verbose descriptions Taxonomies amp Widgets Media Enables the Autoroute part for tokenized routing Depends on Alias Tokens A simple web log Depends on Autoroute Common Feeds jQuery En Oee ENV aa Modules User admin Logo Features Installed Recipes Gallery Filter Actions Choose action Content Content i Content Definition Alias Disable Alias UI Enable Archive Later Enable Blog Maps friendly urls to specific module actions Admin user interface for Orchard Alias Scheduled archiving Queres Depends on Alias Depends on Common Scheduling Comments Autoroute Disable Blogs Disable Containers Disable Container and containable parts to enable paren Depends on Contents Feeds Content Control Wrapper Enable Content Localization Enable ContentTypes Disable Add an Edit button on the front end for authenti Enables localization of content items ContentTypes modules enables the creation and Depends on Contents Depends on Settings Depends on Contents Date Time Format Localization Enable Feeds Tokens Enable Import Export Enable Enables localization of date time formats and na
358. iled What are Core Modules Core Modules are Orchard Modules you can find under src Orchard Web Core They also constitute the Orchard Core project in the solution These are modules that are always enabled and come with the default Orchard installation See Why are Core modules modules and Why are Core Modules Core Modules below for more detailed information Why are Core modules modules The difference is similar to OS concepts of monolithic vs micro kernel it was pretty obvious during high level de sign of Orchard that an extensibility point such as modules was needed Everything else would constitute the core framework Take the Common module for example which introduces the BodyPart a core concept common to many types of content types such as blog posts or pages Now we could ve implemented this as part of the Orchard framework dll and have modules depend on it But then it wouldn t get the benefit of being a module such as being able to hook up handlers drivers views routes etc This also relates to MVC and areas where everything that belongs to an area is under the same directory It was pretty clear that the right choice was to get some core concepts out of the framework dll into a separate dll and have them be modules This is very similar to non monolithic operating systems where parts of the core functionality is implemented as modules outside the kernel talking to it via the same exact interfaces as th
359. ilt in modules such as pages and blogs or themes If you re locking to add additional functionality vou can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Click Cancel to exit preview mode and return to the Themes screen Note By default a newly installed theme is not enabled When you preview a theme it is automatically enabled Only enabled themes are shown in the drop down list of themes available for preview Click Set Current on an available theme The following illustration shows the Themes screen after you click Set Current on the Contoso theme Themes Installed Gallery Updates 0 Current Theme Contoso By The Orchard Team Version 1 0 Chee por supcr ducer beaches 12 uorvarhing thu http www orchardproject net miwhtiw mai A subtle and simple CMS theme perfect for any modern product or service business website When return to the home page for your site the new theme is applied to your pages Change History Updates for Orchard 1 1 3 21 11 Updated screen shots and reworked text for installing applying and previewing themes 3 2 Customizing Websites 149 Read the Docs Template Documentation Release 1 9 2 3 2 2 Installing Themes There are two ways to add a theme to Orchard The first and easiest is to use the Gallery tab on the Themes page in the dashboard to browse and install themes from an online feed of available t
360. imary wefault primary P We chose to keep both date and time displayed The settings for the field are also the opportunity to determine where the field will appear on the front end if you want to override the defaults Let s skip that for now Add the Route part so that our events can have a title then hit Save We can now add a new event by clicking Create Event in the admin menu The editor that gets created for us has a when field with nice date and time pickers v Orchard Edit Event Dashboard v Blogs Title Create New Blag Merd dinner v Content Permalink Manage Content http localhost S0 nerd dinner Manage Content Types TES Create Event 8 10 2010 10 30 AM Create Page Di D 03 D4 05 06 oy DE DS 10 11 i v Tags oo 15 30 45 Manage Tz am pm v oamments 380 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Create an event and save it You can now view it on the site Orchard Nerd dinner When 8 10 2010 5 30 PM Getting the Code Download the code here CustomFields zip The code is also hosted on http orcharddatetimefield codeplex com 3 9 9 Packaging and Sharing a Module After developing a module extension to Orchard you probably want to share it with others Orchard provides a module packaging feature that can be used to create a package file containing your module To enable this feature visit the Features section of the Orchard admin panel a
361. imilar to this host all all ie Aa D erally md5 It is extremely important that the last item in the line above is not indent it should be md5 password or trust for other authentication methods please refer to the PostgreSQL documentation After the line is in the file restart PostgreSQL and you re ready to use the new database from Orchard Configuring with Apache 2 and mod mono Make sure you have Apache 2 the Worker MPM is recommended and mod mono 2 10 1 or newer installed Config uration paths given below are specific to OpenSuSE 11 4 you will need to adjust them for your distribution Contents of the created files does not change save for the filesystem paths of course Create Apache Virtual Host Configuration File sudo 3 cd etc apache2 vhosts d At this point you will need a working text editor You can try typing any of the following commands to launch one gedit mcedit joe vi editor below is used as a placeholder editor etc apache2 vhosts d orchard demo conf One of them should result in the editor starting If you don t know how to use the started editor refer to its online help After the editor is started paste the following code in it lt VirtualHost 80 ServerAdmin webmaster orchard demo ServerName orchard demo Change the path below to suit your configuration DocumentRoot srv www vhosts orchard demo The paths used here should be common for all Linux distributions ErrorLog var log apac
362. in a blog post Alternates are particularly useful when you have different types of content and you want to customize the appearance of these different types of content The Orchard framework uses a naming convention to determine whether an alternate template is used for rendering content The naming convention enables you to add template files that are used automatically without requiring you to modify any code 458 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Naming Convention for Alternates Alternate shapes are named using the name of the base shape followed by a double underscore __ and an ending that is specific to the alternate shape For example a Parts_Tags_ShowTags shape can have alternates with names such as Parts Tags ShowTags BlogPost and Parts_Tags_ShowTags__ Page The part of the alternate name after the double underscore reflects when the shape is used such as the current content type For more information about how shapes are named see Accessing and Rendering Shapes Mapping a Template File to an Alternate To create a template file that maps to the corresponding shape name you must name the template according to the following naming convention Convert an underscore _ in the shape name to either a dot or backslash in the template name A backslash indicates that the template resides in a subfolder Convert a double underscore __ in the shape name to a hyphen Fo
363. in the Parts folder called FeaturedProduct cshtml 4 Within the FeaturedProduct cshtml view file add the following HTML markup model Orchard LearnOrchard FeaturedProduct Models FeaturedProductPart fieldset div class editor label Html LabelFor model gt model IsOnSale lt div gt lt div class editor field Html CheckBoxFor model gt model IsOnSale Html ValidationMessageFor model gt model IsOnSale lt div gt lt fieldset gt When you edit the widget in the admin dashboard you will see a simple edit form 310 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Css classes Add custom css classes for the widget separated by spaces Is the featured product on sale Owner admin You can see that it is automatically pulling through the DisplayName attribute value that we used earlier Update the front end view Now that we have gone through all the steps to surface the IsOnSale property we can finally use it to make a decision in the front end view If you have experience with normal ASP NET MVC Razor views you will know that you can blend your C code in with the HTML including features such as using conditional statements to control the visibility of certain sections We will now update the module to show a red ON SALE box in the widget when IsOnSale is set to true 1 Open up the view file located at Views Parts FeaturedProduct cshtml 2 Copy this
364. ing Dynamic Objects Introducing Shapes Shapes are dynamic data models that use shape templates to make the data visible to the user in the way you want Shape templates are fragments of markup for rendering shapes Examples of shapes include menus menu items content items documents and messages A shape is a data model object that derives from the Orchard DisplayManagement Shapes Shape class The Shape class is never instantiated Instead shapes are created at run time by a shape factory The default shape factory is Orchard DisplayManagement Implementation DefaultShapeFactory The shapes cre ated by the shape factory are dynamic objects NoteDynamic objects are new to the NET Framework 4 As a dynamic object a shape exposes its members at run time instead of at compile time By contrast an ASP NET MVC model object is a static object that s defined at compile time Information about the shape is contained in the ShapeMetadata property of the shape itself This information includes the shape s type display type position prefix wrappers alternates child content and a WasExecuted Boolean value You can access the shape s metadata as shown in the following example var shapeType shapeName Metadata Type After the shape object is created the shape is rendered with the help of a shape template A shape template is a piece of HTML markup partial view that is responsible for displaying the shape Alternatively you can use a sh
365. ing Orchard in a server farm configuration Without using some form of shared storage media content will become out of sync between the nodes in your farm as users add or remove media files Offloading media requests from the Orchard web server When Microsoft Azure Media Storage is enabled all end user requests for media content are made directly to the public blob storage endpoint 3 7 1 Enabling for Microsoft Azure Cloud Services Before the feature can be enabled you must configure the connection string to the storage account you want to use When running Orchard in a Microsoft Azure Cloud Service this can be done either before deploying in the cloud service project or after deploying in the Microsoft Azure management portal To configure the connection string before deploying 1 OpenOrchard Azure sln 252 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 2 Navigate to Orchard Azure CloudService double click the role Orchard Azure Web to bring up its property page and navigate to the Settings tab 3 Set the Orchard Azure Media StorageConnectionString setting to be the connection string of the storage account in which you want to store media content 4 Deploy the cloud service To configure the connection string after deploying 1 Deploy the cloud service 2 In the management portal navigate to your cloud service and select the Configure tab 3 Under Orchard Azure Web locate the setting Orc
366. ing Settings for the Field This flexibility in rendering that we just introduced in the view model can be exposed as settings for the field This way administrators can configure fields on the content types they create in order to adapt them to their exact needs Create a Settings folder and add the following DateTimeFieldSettings cs file to it namespace CustomFields DateTimeField Settings public enum DateTimeFieldDisplays DateAndTime DateOnly TimeOnly public class DateTimeFieldSettings public DateTimeFieldDisplays Display get set We have defined here an enumeration describing the possible values of our display setting which is the only setting for the field The settings class itself 1s just an ordinary class with one property typed with that enumeration 372 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Writing the Driver Exactly like a part a field has a driver that will be responsible for handling display and editing actions on the field when it s been added to a content type Create a Drivers folder and add the following DateTimeFieldDriver cs using System using JetBrains Annotations Using Orchard using Orchard ContentManagement using Orchard ContentManagement Drivers using CustomFields DateTimeField Settings using CustomFields DateTimeField ViewModels using Orchard ContentManagement Handlers using Orchard loca la Zar Lon namespace CustomFields DateTimeF
367. ing System uscndg Orchard Alias using Orchard ContentManagement using Orchard ContentManagement Drivers using Orchard LearnOrchard FeaturedProduct Models namespace Orchard LearnOrchard FeaturedProduct Drivers public class FeaturedProductDriver ContentPartDriver lt FeaturedProductPart gt private readonly IContentManager contentManager private readonly IWorkContextAccessor workContextAccessor private readonly IAliasService aliasService private IContent currentContent null private IContent CurrentContent get if currentContent null var itemRoute _aliasService Get _workContextAccessor GetContext HttpContext Request AppRelativeCurrentExecutionFilePath oubstrringi il rrdmt 42 currentContent contentManager Get Convert ToInt32 itemRoute Id return currentContent public FeaturedProductDriver IContentManager contentManager IWorkContextAccessor workContextAccessor TAliasService aliasService _contentManager contentManager workContextAccessor workContextAccessor aliasService aliasService protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts FeaturedProduct gt extra space to write additional lines of code here return shapeHelper Parts_FeaturedProduct 23 protected override DriverResult Editor FeaturedProductPart part 3 9 Extending Orchard 323 Read the Doc
368. ing commands in Orchard Open the Orchard command line utility and enter the following command codegen theme MyTheme BasedOn TheThemeMachine If you are using Visual Studio for editing or if you plan for your Theme to eventually contain code files too you may also want specify the CreateProject and IncludeInSolution options as follows codegen theme MyTheme BasedOn TheThemeMachine CreateProject true IncludeInSolution true 3 2 Customizing Websites 155 Read the Docs Template Documentation Release 1 9 2 This line tells Orchard to create the code structure for a new theme sets the name of the theme to MyTheme and directs Orchard to base the theme on TheThemeMachine The CodeGen command generates the following folder structure E di My Theme n Content di Scripts m Styles i Views Zones The only files created are the Theme txt and Views Web config files The Theme txt file the theme manifest is where the Admin Panel looks for information such as the name of the theme This is also where your BaseTheme is specified Web config is a configuration file that ASP NET MVC requires for rendering any views placed in the Views folder You seldom have to make changes in the Web config file Copying Files from the Theme Machine To keep this example simple the only file you will customize will be the Site css file Copy the Site css file from TheThemeMachine Styles folder to the MyTheme Styles folder Currently you must also copy th
369. ing environment for creating ASP NET Web Pages with Razor syntax It includes IIS Express a development web server ASP NET and SQL Server Compact an embedded database also used by Orchard WebMatrix gives you productivity features that support Razor syntax such as syntax highlighting for code and Intel liSense for HTML markup and CSS You can also work with Razor syntax in Visual Studio 2010 which provides the added features of full IntelliSense for your server code and also lets you use the Visual Studio debugger For more information see Program ASP NET Web Pages in Visual Studio However you can use any text editor to experiment with Razor syntax To download and install WebMatrix go to the WebMatrix downloads page and click the link for the Microsoft Web Platform Installer to start your download Code Blocks and Inline Expressions You add code to a web page using the character Braces are used to mark a code block For example the following expression assigns the string Hello World to a variable named myMessage var myMessage Hello World Code blocks can be inserted in the web page interspersed with HTML markup The following code defines a greeting message that includes the current day of the week and embeds the message in the page markup var greeting Welcome to our site var weekDay DateTime Now DayOfWeek var greetingMessage greeting Today is weekDay lt p gt The
370. ing n or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re look functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Second Leader Aside Third Leader Aside Lorem ipsum dolor sit amet consectetur adipiscing Lorem ipsum dolor sit amet consectetur adipiscing Lorem ipsum dolor sit am elit Curabitur a nibh ut tortor dapibus vestibulum elit Curabitur a nibh ut tortor dapibus vestibulum elit Curabitur a nibh ut to Aliquam vel sem nibh Suspendisse vel Aliquam vel sem nibh Suspendisse vel Aliquam vel sem nibh Su condimentum tellus condimentum tellus condimentum tellus 3 New Tenant successfully created Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard Powered by DotNest the Orchard SaaS platfo 15 Getting Started with Orchard 8 Read the Docs Template Documentation Release 1 9 2 1 5 4 Orchard on Azure Websites After a free registration you can create websites from the Azure Gallery where you can select Orchard to deploy in one click too Your Orchard site on Azure Websites will be completely under your control you can install any modul
371. ingleton at the app domain level Next the host will get the Shell for the current tenant using the ShellContextFactory Tenants are instances of the application that are isolated as far as users can tell but that are running within the same appdomain improving the site density The shell is a singleton at the tenant level and could actually be said to represent the tenant It s the object that will effectively provide the tenant level isolation while keeping the module programming model agnostic about multi tenancy The shell once created will get the list of available extensions from the ExtensionManager Extensions are modules and themes The default implementation is scanning the modules and themes directories for extensions At the same time the shell will get the list of settings for the tenant from the ShellSettingsManager The default implementation gets the settings from the appropriate subfolder of App Data but alternative implementations can get those from different places For example we have an Azure implementation that is using blob storage instead because App Data is not reliably writable in that environment The shell then gets the CompositionStrategy object and uses it to prepare the IoC container from the list of available extensions for the current host and from the settings for the current tenant The result of this is not an IoC container for the shell it is a ShellBlueprint which is a list of dependency controller and re
372. ion changes the class name to group which adds semantic value because you often float related items as a group Method 2 Apply the overflow auto property to the parent container Certain combinations of margin and padding can force internal scrollbars If you can t tweak things to remove the scrollbars you can try us 3 11 Creating Themes 477 Read the Docs Template Documentation Release 1 9 2 ing overflow hidden which has virtually the same effect without the scrollbars The only drawback of hidden seems to be that some images are cropped if they re placed lower in the page Forms Mark up form elements using the ordered list method This method describes form elements as a sequential list of inputs that the user needs to fill in It provides both semantic meaning and order to the form which aids accessibility When forms are rendered without style sheets they are clearly labeled in sequential order and have a count associated with them The ordered list provides additional information for some screen readers that announce the number of list items when they first encounter the list lt fieldset gt lt legend gt Delivery Details lt legend gt lt ol gt ol Bia label for name gt Name lt em gt lt em gt lt label gt lt input id name gt rs lt li gt label for addressl1 gt Address lt em gt lt em gt lt label gt lt input id address1 gt lt li gt lt li gt label fore town city
373. ion new apartments and decide the terms for each tenant and the individual tenants as inhabitants of each apartment Adding Tenants Initially you will only have a single tenant which is the Default tenant 3 8 Using Windows Azure Cache 259 Read the Docs Template Documentation Release 1 9 2 e Your Site List of Site s Tenants User admin Logout Default Edit W Reports E Tenants L Settings To provision another tenant site click Add a Tenant 260 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Add New Tenant ame Alpha Hast alpha localhost Example If host is orchardproject net the tenant site URL is http orchardproject net Database Setup Allow the tenant to set up the database amp Use built in data storage SQL Server Compact Use an existing SQL Server or SQL Express database The Add New Tenant screen asks for the name of the tenant the name may not contain spaces and the host domain that will map to the tenant As the landlord for your tenants you decide whether the tenant should be allowed to configure the database on the Orchard setup screen or whether you want to configure the database on behalf of the tenant After you ve decided how to provision your new tenant site click Save Under List of Site s Tenants you see the new tenant List of Site s Tenants User admin Logout Add a Tenant Alpha http alpha myorchard 14964 Edit D
374. iptor new HttpRouteDescriptor Name Default Api Priority 0 RouteTemplate api myapi id Defaults new area MyCustomModule controller MyApi id RouteParameter Optional public void GetRoutes ICollection RouteDescriptor routes 426 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 foreach RouteDescriptor routeDescriptor in GetRoutes routes Add routeDescriptor j Now the Api endpoint can be reached by hitting api myapi Configuring Web Api in Orchard Since Orchard doesn t have the concept of an AppStart file in order to add custom configuration to Web Api in Orchard you must do so in an Autofac module For example the following will set the default Web Api return type to Json and will ensure that Json objects properties returned by the Api follow the camelCased naming convention namespace MyCustomModule public class WebApiConfig Module protected override void Load ContainerBuilder builder GlobalConfiguration Configuration Formatters JsonFormatter SupportedMediaTypes var jsonFormatter GlobalConfiguration Configuration Formatters OfType JsonMe if jsonFormatter null jsonFormatter SerializerSettings ContractResolver new CamelCasePropertyN Conclusion This document should provide the basics of getting started with Web Api in Orchard Enjoy 3 10 Working with Data 3 10 1 Understanding Data Access This topic
375. is is where features and bug fixes are being worked on for the next point release for example the difference between v1 9 1 and v1 9 2 The dev branch is the long cycle dev branch This is where bigger features are being worked on that won t make it into the next version of Orchard CMS There is also a separate repository called Brochard which is the implementation of Orchard CMS in Asp Net vNext also known as DNX Milestones and labels New issues are opened all the time After an issue is submitted the core team members will review it When it s acccepted as a valid task to complete it will be given a milestone and perhaps some labels The milestone indicates which branch any pull requests for the issue should be sent to You might also see some additional tags like a severity level or further categorization These labels can help you prioritise which issues you should give your attention first based on their urgency or your speciality as a developer LayoutPartDriver fails with IndexOutOfBoundsException TT high Layouts Gi 5253 opened on T May by pszmyd dev In the screenshot above you can see that the bug has been tagged with the labels bug high and Layouts This means it has been confirmed as a bug it is a high priority fix and it is part of the Orchard Layouts module Below that you can see the milestone icon with the word dev next to it This means that if you do work on it you should work from the dev branch How to fork
376. is maps to the Orchard Fields Fields InputField class and you can access it s data through the Value property As you build up your skills as an Orchard module developer one of the important ones will be digging through the code to discover this sort of thing for yourself As I was writing this I didn t know what the class was called To find it out I put a breakpoint on the line of code started a debug session and inspected the field to see what class it was and how to get at it s data This is a useful skill to have in your repertoire when working with Orchard but in this case you also have a useful resource that has been put together by Sebastien Ros He has created an Orchard Cheatsheet which covers common properties that you might want to access on each of the built in Orchard content fields The second important thing to understand with accessing fields is that if you tried that line above you wouldn t get very far and this is the reason why new developers have had so much trouble with it The fields are injected into the class at run time using NET dynamic features This means you don t get IntelliSense for dynamic properties It also means that unless the class is marked as dynamic the code won t compile So before you can use code to access your field you need to cast your ContentItem to dynamic var dynamicContentlitem dynamic CurrentContent ContentiItem var itemProductId dynamicContentItem Product ProductIid Value
377. isplays options that are specific to the features that are enabled for your site 194 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 General Site name Orchard CMS Beginner Base URL http localhost 13776 Enter the fully qualified base URL of the web site eg http localhost 30320 orchardlocal http www yourdomain com Default Site Culture en US YT Determines the default culture used to localize strings and to format and parse numbers date and times Add or remove supported cultures for the site Default Site Calendar Culture calendar T Determines the default calendar used when displaying and editing dates and times The Culture calendar option means the default calendar for the culture of the current request will be used not necessarily the configured default site culture Default Time Zone UTC 05 30 Chennai Kolkata Mumbai New Delhi Y Determines the default time zone used when displaying and editing dates and times Page title separator Super user admin Enter an existing account name or nothing if you don t want a Super user account Resource Debug Mode Use web config setting Y Determines whether scripts and stylesheets load in their debuggable or minified form Default number of items per page 10 Determines the default number of items that are shown per page Maximum number of items per page Determines the maximum number of it
378. it then click on the new upgrade menu entry that was added to the admin menu Visit all the relevant tabs and execute the required upgrade actions they present Once you re done the feature can be disabled which will remove the menu entry You re done If You Have a Source Code Enlistment If you are working with a source code enlistment the update process is going to be extremely simple because you are already going through it every time you sync your source code directory with the repository When the time comes to upgrade just get the latest changes and sync to the latest in the default branch 3 5 Hosting and Deploying Websites 239 Read the Docs Template Documentation Release 1 9 2 Import Export The Import Export module can be used to do clean data migrations from one version to another Applying a framework patch Occasionally we may release small updates in the form of a patch to one or several dlls These patch files are regular zip files that contain updated dll files To install such a patch first extract the zip then make a copy of the version of those files that are already in the bin folder of your site Then replace the existing copy with the one from the patch file 3 5 2 Optimizing Server Performance of Orchard Applications This topic discusses various techniques for tuning a server environment to run Orchard efficiently The optimal con figuration depends on the type of site you re running and on usage patte
379. ith the code above there s only one thing left creating a cshtml view shape to render our form Shapes defining edit forms for content type settings has to be placed under Views DefinitionTemplates with the name lt settingsClassName gt cshtml So in our case it ll look like on the picture above Inside it s just like any other Razor view file model Szmyd Orchard Modules Sharing Settings ShareBarTypePartSettings lt fieldset gt lt div gt aHtml LabelFor m gt m Mode T Share bar display style Html DropDownListFor m gt m Mode new System Web Mvc SelectList Model AvailableModes Value Text int Model Mode lt div gt lt fieldset gt This renders the dropdown list so user can choose one of the predefined Modes Model AvailableModes contains the available ones we populated the property with appropriate data in TypePartEditor method above Hooray we re done Now you possibly wonder where will this edit form be shown Orchard will render settings form when you ll try to edit the content type containing your part The steps are like this Content Types Edit the type you want gt Add your part gt Voila There is a nice arrow image next to your part If you click it the form shows Using settings for content type As for site scoped settings this section is also a one liner The part below is some content part in this case a Share BarPart from the Orchard Sharing project var type
380. ithDescription Your description here The description is displayed in the admin dashboard in the content definition section Element Wrapper Edit Turns elements into content items Featured Product Edit Identity Automatically generates a unique identity for the content item which is required in import export scenarios where one content item references another Edit And when you are working with the content part Add Field Fields Add Field Add Parts EL Featured Product Common Provides common information about a content item such as Owner Date Created Date Published and Date Modified Remove Widget Turns a content type into a Widget Note you need to set the stereotype to Widget as well Remove 340 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Let s add an update to the data migration class so that this is populated 1 Open the Migrations cs located in the root folder of the module 2 Each time you want to add a new migration you add one to the number in your UpdateFromN methods Unless you have been experimenting with the code you should be on UpdateFrom2 now Add this method to the class and set its return value to 3 public int UpdateFrom2 return 3 We want to edit the description by using WithDescription on the part Add this code into the method ContentDefinitionManager AlterPartDefinition typeof FeaturedProductPart N
381. ivate properties add in a default constructor Orchard Alias Go back to the FeaturedProductDriver cs file You can now add the missing namespace via Ct r1 public FeaturedProductDriver IContentManager contentManager IWorkContextAccessor workContextAcces sor IAliasService aliasService _contentManager contentManager _workContextAccessor workContex tAccessor _aliasService aliasService You can see that we are following the standard pattern of defining a private property adding an instance to the constructor parameters and then assigning the injected class to the private variable this code in between the first batch of private properties and the constructor The Driver now has all of the requirements implemented to support the CurrentContent property private IContent currentContent null private IContent CurrentContent get if currentContent null var itemRoute _aliasService Get _workContextAccessor GetContext HttpContext Request AppRelativeCurrentExecutionFilePath oubstringul lsimt y 32 35 Chapter 3 Documentation SO Read the Docs Template Documentation Release 1 9 2 currentContent contentManager Get Convert ToInt32 itemRoute Id return currentContent 1 If you have cleaned up your using statements then you might need to add a namespace using Ct rl for the Converge Lolnts2 The complete FeaturedProductDriver cs should now look like this us
382. ived from a site s Contact Us page Read how to create a custom form and then use a rule or the new Work Flow to have Orchard send an email Change History Updates for Orchard 1 8 9 8 14 Updated screen shots for email messaging module 3 14 Getting Involved 3 14 1 Contributing Documentation At the beginning of your topic add a statement that clearly identifies the version of Orchard the topic was written for such as the following This topic targets and was tested with the Orchard 0 8 release Make sure you test all code and markup with the targeted version of Orchard 3 14 2 Documentation Style Guidelines The Orchard documentation is built in Markdown We use a few simple conventions to ensure a homogeneous style throughout the full set of documents File Name And Title The document should not specify its own title as part of the document itself but its file name should be the document title with spaces replaced by dashes The title will be added by the site dynamically from the file name Structure Topics should begin with a brief summary explaining what audience it targets and their key takeaways This summary will be displayed in search results so it should make sense by itself It should consist of one paragraph of text without a leading title If the topic is not complete enough to fulfill its goals the top of the document should specify gt Draft topic on the first line After the summary the a
383. iver we wrote previously but also it s responsible for rendering the edit form and saving the posted data public class ShareBarSettingsHooks ContentDefinitionEditorEventsBase public override IEnumerable TemplateViewModel TypePartEditor ContentTypePartDefinition definition if definition PartDefinition Name ShareBarPart yield break var model definition Settings GetModel lt ShareBarTypePartSettings gt model AvailableModes Enum GetValues typeof ShareBarMode Cast lt int gt Select i gt new Text Enum GetName typeof ShareBarMode i Value 1 rie yield return Definitionlemplatse model public override IEnumerable lt TemplateViewModel gt TypePartEditorUpdate ContentTypePartDefinitionBuilder builder IUpdateModel updateModel if builder Name ShareBarPart yield break var model new ShareBarTypePartSettings updateModel TryUpdateModel model ShareBarTypePartSettings null null builder WithSetting ShareBarTypePartSettings Mode int model Mode ToString 424 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 yield return Detinitionlemplare model This class overrides the ContentDefinitionEditorEventsBase which defines two overridable methods TypePartEditor and TypePartEditorUpdate The first one gets called when the edit form is being rendered GET and the second one when the edit form data gets posted POST Unli
384. ize the label with our DisplayName text we need to pass an extra parameter in to the aHtml LabelFor so This would look something like this aHtml LabelFor model gt model IsOnSale T Is the featured product on sale However this kind of duplication of the text 1s not a best practice Instead there is a way to pull the DisplayName attribute text in and pass it through the T and into the LabelFor 1 Open Views EditorTemplates Parts FeaturedProduct cshtml 2 Find the call to LabelFor Html LabelFor model gt model IsOnSale And replace it with Html LabelFor model gt model IsOnSale T Html DisplayNameFor model gt model IsOnSale ToHtmlString Localization is an important topic in Orchard Read the using the localization helpers and the creating global ready applications guides for more detailed information about supporting this feature Your styles shouldn t be inline Hopefully this one should have raised some alarm bells as you were doing this having a style tag in the view is not a good HTML practice You should always put your CSS into an external css file This allows the browser to download the file once for each the sites and keep it cached for subsequent requests However just putting the styles into an external file is not the whole story with Orchard It provides two techniques to help you include scripts and styles within your view The quick fix for this is to move the CSS into a cs
385. k and feel it s time for some content You can start creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re looking to add additional functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Second Leader Aside Third Leader Aside Lorem ipsum dolor sit amet consectetur adipiscing elit Lorem ipsum dolor sit amet consectetur adipiscing elit Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam Curabitur a nibh ut tortor dapibus vestibulum Aliquam Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus vel sem nibh Suspendisse vel condimentum tellus vel sem nibh Suspendisse vel condimentum tellus Powered by Orchard PJS Bootstrap 2014 1 5 11 Extending Orchard With Modules And Features A key feature of Orchard is the ability to add new features in order to extend the functionality of your site The primary way to do this is by installing modules You can think of a module as a package of files in a zip folder that can be instal
386. k on httpr orchard cadeplex com discussions If you are interested in how the gallery is built on Orchard the source code ts avalable under an open source Mew BSD license at http forchardgalery codeglex com and hithpe qalleryserver codeplex com Orchard gallery Drrenard Home Dawnload Documientab oatr by Orchard On the Modules tab of the website you can browse and search for available modules 3 3 Using the Orchard Gallery 163 Read the Docs Template Documentation Release 1 9 2 Search Modules All Categories Adminstration Blog Command line Commerce Community Content Deployment Developer Events and Calendar Experimental File Management Games Hosting Localization Location Modules Orchard gallery 52 results for Modules Displaying results 1 10 Themes Lategornes o URCHARLD HOME KIIN US DON B L1 Sign In Contribute Code Generation 1 0 20 A224 Download By The Orchard Team S Took ba creabe Orchard components Mare mlcematian LY comments Tags orchard codegen scaffolding command ime developer 772 Downloads Email Messaging 1 0 20 ir he tot Donload By The Orchard Team The Emad Messaging module sdds Email sending functionalities More information UO greni Tage erchard grad mievamng BE Dessnla ads Lucene 1 0 20 221 Downoad By The Orchard Team The Lucerne module enables the sibi to b indiessd uim Lucene MET
387. k with both Windows Azure Role based Cache and the newly released Windows Azure Cache Service See the following topics for more information Using Windows Azure Blob Storage Using Windows Azure Cache Cloud services and web sites As far as possible we now have feature parity between Windows Azure Cloud Services and Windows Azure Web Sites Things like media storage and output caching have been reimplemented and packaged as features in the Orchard Azure module that can be enabled from either environment Also automated publishing from within Visual Studio has been overhauled and is supported for both target environments Fully loaded by default Orchard is now pre configured for Windows Azure Cache when deploying to a Windows Azure Cloud Service If you scale out your deployment to more than one role instance you can take advantage of this to keep your instances in sync By default the cloud service project is configured for co located role based caching with 30 of the role instance mem ory allowed for cache usage Three named caches Out put Cache DatabaseCache and SessionStateCache are configured by default Windows Azure Output Cache and Windows Azure Database Cache have to be enabled as features in the dashboard post deployment while the ASP NET Session State Provider for Windows Azure Cache is configured and enabled by default in Web config Windows Azure Diagnostics is now fully configured by default when deploying Orchard to a Wi
388. ke for Content Types module settings etc because those values must not change on a production farm You never create a content type on production on a farm or you have to restart all nodes one after the other Another reason to use this module and why it has been done is that it is not dependent on memory pressure so entries won t be removed if your system memory consumption grows as opposed to the ASP NET cache AII the other cache providers are and must use memory pressure limits 2nd Level NHibernate Caching This is used to prevent recurring sql queries to the database Because the accessors are simple and well defined checking a string in the dictionary it s safe to use it on a farm as long as the data is store in a central repository like using Memcached A simple Memcached provider for it is tricky as you need to configure the provider location port and usually the settings are best placed in the database but it s the chicken and egg issue and you can t bootstrap it from a module The only solution is then to have the configuration for it inside the web config or maybe the settings txt when it will be extensible 3 9 Extending Orchard 421 Read the Docs Template Documentation Release 1 9 2 Output Caching Using Contrib Cache The goal of this module is to provide output caching like ASP NET does and to provide cache headers management max age Cache Control ETag It was recently extended to be able to define the s
389. ke the generic content part drivers this class is not bound to the specific content type as the content types are just a list of names for a collection of parts so each of the methods we just defined will be called for every content type and for every part This is why the yield break statement is used to filter only the ones containing the part we need ShareBarPart By convention as shown in the TypePartEditorUpdate method settings should be named as lt prefix gt lt propertyName gt when passing to builder WithSetting where prefix is the string passed to the updateModel TryUpdateModel Prefix can be anything but has to be unique Remember though when you use string other than your settings class name you cannot use Settings GetModel lt Your_Settings_Type gt as shown in the TypePartEditor method above In this case you have to use Settings GetModel lt Your_Settings_Type gt prefix instead 1 It should be considered best practice to use your settings class name as a prefix as in the code above 2 Settings are persisted within the content type definition in the db in the string form You have to be sure that the properties you define are convertible to and from the string representation Notice the usage of Enum GetValues typeof someEnum Enum GetNames typeof someEnum and Enum GetName typeof someEnum i This methods get very useful when you want to iterate over the names values of an enum If you re done w
390. ked if reward IsChecked lt text gt checked checked lt text gt gt string Format 10 LLSEII reward RewardProgram Name reward RewardProgram Discount lt label gt rewardIndex lt li gt ML lt fieldset gt Notice how the check boxes use Html FieldNameFor This will ensure that they will have a name that the model binder will be able to understand and correctly bind when it is posted back Also noticeable is the hidden input which is a standard workaround for the peculiar way in which HTML check boxes don t post anything when not checked The model binder knows how to use the information for both the hidden input and the check box to determine the Boolean values to set Of course any variation from that naming scheme would make the binding fail The Placement File For the parts to appear at all in the UI we need to update our placement info file lt Placement gt lt Place Parts Address Bait Convent 104 17 gt Place Parts Address Gontent 10 Place Parts Rewards Edit 2 Content 11 Place Parts Rewards Content 11 gt lt Placement gt Using the Rewards Part If you haven t used the application s admin UI since you wrote the migration it should now warn you that a feature needs to be upgraded That is our sample feature as the system noticed the latest executed migration does not match the highest available Go to the features screen locate the RelationSam
391. l display the edit interface in the admin dashboard This is designed to be used with a HTTP GET request The second is another Editor overload which takes the submitted information from the first and attempts to pass that information back into the database This is designed to be used with a HTTP POST request 1 Open the FeaturedProductDriver cs class which is in the Drivers folder of the module project 2 Below the Display method paste in this block of code protected override DriverResult Editor FeaturedProductPart part dynamic shapeHelper return ContentShape Parts FeaturedProduct Edit gt shapeHelper EditorTemplate TemplateName Parts FeaturedProduct Model part Prefix Prefix protected override DriverResult Editor FeaturedProductPart part IUpdateModel updater dynamic shapeHelper updater Try UpdateModel part Prefix null null return Editor part shapeHelper 3 Add the namespace for IUpdateModel using the Ctr1 keyboard shortcut As explained above the first Editor method is for displaying an edit form in the admin dashboard You can see that it returns a content shape called Parts_FeaturedProduct_Edit We will use this information later on when updating the placement info 308 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 The way it does it is by using the provided shapeHelper factory to create a new shape for the current content part our FeaturedPr
392. l feeds or to filter and display only the modules from a particular feed To install a module click the Install link for the module This topic uses the Bing Maps module as an example 3 4 Managing Websites 189 Read the Docs Template Documentation Release 1 9 2 Bing Maps Version 0 5 0 Dauid Bing Maps part and widget Last Updated 1 12 2011 9 46 52 PM Author Bertrand Le Roy Downloads 1230 Website http weblogs asp net bleroy Rating titi Show Showing items 1 10 of 113 10 1 2 3 4 gt gt After the module has been installed Orchard prompts you to enable features in the module Select the features you want to enable and then click OK Bing Maps 0 5 0 Details User admin Logout Successfully added Orchard Module Bing Maps 0 5 0 to C myorchard src Orchard Web The module has been successtully installed Installation details Pick the features you want enabled v Bing Maps When you return to the Installed tab you can see the module that you just installed Downloading a Module from the Gallery At times you may want to simply download a module package to your computer rather than installing it in a site To download a module return to the Gallery tab and click Download for a specific module For example download the Contact Form module The download process lets you save the nupkg file that contains the module contents to your local machine You can then optionally
393. l find the following text New translation Click this to add the translation for another culture Change History Updates for Orchard 1 8 11 03 14 Updated Localization steps and procedure aka Crowdin 3 17 11 Updated for references to dashboard 3 17 11 Updated screens and procedures in section on localizing database driven content items 3 18 11 Updated screens and procedures in section on localizing the Orchard application and modules 4 12 11 Structure of the document modified Added online tool tutorial 3 1 3 Search and Indexing Orchard provides the ability to index and search content items in the application The indexing functionality is provided by enabling the Indexing feature along with a specific implementation of indexing Lucene based is included by default In addition to the Indexing the Search feature provides the ability to query the index by keyword or using Lucene query syntax to return a list of content items matching the query on the front end You must enable all the following Modules Search Indexing and Lucene 126 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Modules Features Installed Recipes Gallery Filter lucene Actions Choose action Search Lucene Enable Lucene indexing services Depends on Indexing Because search depends on indexing enabling search will automatically enable indexing as well Note that you must also enable Luce
394. l string Name get set public static StateRecord DeserializeStateRecord string rawStateRecord if rawStateRecord null return new StateRecord var stateRecordArray rawStateRecord Split new ae return new StateRecord Id String IsNullOrEmpty stateRecordArray 0 O Int32 Parse stateReco Code stateRecordArray l1 Name stateRecordArray 2 F public static string SerializeStateRecord StateRecord stateRecord if stateRecord null return TIe return String Join stateRecord Id stateRecord Code stateRecord Name 3 9 Extending Orchard 387 Read the Docs Template Documentation Release 1 9 2 Addres gt gt AddressPart Class Class ContentPart AddressPartRecord Contet Properties Prope S Address string A SM City string E State StateRecord FT 2 Zip string Sta d FA Clas ContentPart TRecord gt Generic Class ContentPart Properties 3T Record TRecord Here is a representation of what we just showed in code Creating the Database Tables and Part The database structure for the model we just built can be created from a migration public int Create SchemaBuilder CreateTable AddressPartRecord table gt table ContentPartRecord Column string Address sColumn lt sstring gt City Column int StateRecord Id olum nesbtring Zrxp s SchemaBuilder CreateTable StateRecord
395. late Documentation Release 1 9 2 fitignore ClickToBuild cmd DeleteModuleBinaries Orchard proj Orchard 4 Orchard Azure Orchard Core Orchard sln Orchard Specs Orchard Tests Modules Orchard Web OrchardBasicCorrectness Shapes tx fones txt T Sources Orchard src gt devenv orchard sln Hit F5 to build and run the application 3 12 Developer Tools and Guidelines ources orchard 489 Read the Docs Template Documentation Release 1 9 2 Solution Explorer o 8 s Search Solution Explorer Ctrl Pr MJ Solution Orchard 74 projects b Modules m Modules Deprecated mi Specs m Tests im Themes mi Tools BW Orchard Core Orchard Framework e Orchard WarmupsStarter 1 Orchard Web gt Properties gt a References mi App Data P imm Config P d Global asax D Refresh html Web config KV Ww XC Vw WV O N O M Without Visual Studio Build the application from the command line following the instructions found here Build ing and deploying Orchard from a source code drop You may use IIS or IIS Express to run the application Everyday Git Extensions Use The part of Git Extensions you re going to use the most is the Repository Explorer right click on the Git enlistment directory from the Windows Explorer to find it it s called GitEx Browse For example to get the latest changes from GitHub just click Pu11 The repository explorer gives you a view of all the
396. lation boundary between applications However Orchard provides an additional isolation boundary between sites referred to as multi tenancy that allows you to run multiple Orchard sites within a single ASP NET app domain This is useful because app domains are generally expensive to initialize tear down and recycle from memory usage standpoint Running multiple isolated Orchard sites in a single app domain can allow more sites to fit on a single server which is favored by hosting providers to keep costs down The assumption is that cost savings for hosting providers result in lower cost for hosting customers Multi tenancy is particularly nice in a Windows Azure environment because one deployment to Azure can easily support multiple websites Note If you want to set up a multi tenant test site on your local machine first read Testing Multi Tenancy on a Local Machine later in this article Enabling Multi Tenancy By default the multi tenancy feature is not enabled when you install Orchard To enable multi tenancy open the Orchard dashboard click Modules find the Multi Tenancy feature under Hosting and then click Enable Hosting MultiTenancy Once multi tenancy is enabled you see a Tenants dashboard menu section A tenant refers to a separate site config uration inside of the default tenant which is initial site created after you install Orchard You can think of the default tenant as the landlord of an apartment building who can provis
397. layer selected click Add to zone next to SearchForm in the list of available widgets Keep Header selected as the zone and Default as the layer so that your search widget appears on top of all pages the default layer applies to all pages in the site Give it a title such as Search and click the Save button For more information about widgets see Managing widgets If you navigate now to any page in the front end of the site you will see the search form Upload screenshots 675 searchformwidget png When you type a keyword or query into this input box a list of matching content items is displayed Upload screenshots 675 searchwidgetfrontend png 128 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Change History Updates for Orchard 1 8 9 05 14 Updated all screen shots for Search Indexing and Lucene 3 1 4 Saving Scheduling and Publishing Drafts This topic has been updated for the Orchard 1 0 release Orchard lets you save a page as a draft or publish it to your web site When you publish a page you can either publish immediately or specify a time when the page should be published The options for saving or publishing a page are available at the bottom of the Create Page page Documentation Upload screenshots_675 draftpublish png Save a Draft Option When you want to save a page but do not want the page to be visible to visitors you can
398. ld your module inject into the Admin menu and what controller actions these links invoke What is the Permissions cs file This file has an implementation of the Orchard interface called PermissionProvider It lets modules declare a set of permissions as well as attach those permissions to default Orchard roles Once you add a new permission type to your module here you will be able to use the Orchard authorization APIs to check that permission against the current user You will also be able to manage which custom roles the permission belongs to in the Roles administration page How do do authorization inside my module against current user roles Orchard comes with a default services implementation of the TOrchardServices interface Simply include IOrchardService in your constructor and you will get the default implementation injected Like public AdminController IMyService myService IOrchardServices orchardServices _myService myService orchardservices orchardservices 482 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 At this point services gives you Authorizer for authorization Notifier for writing out notifications ContentManager for access to the Orchard content manager and TransactionManager for handling database transactions To check if the current user has a certain permission you would simply do Services Authorizer Authorize Permissions SomeModulePermission T Some operation fa
399. lds NNI Add Parts Parts Common Provides common information about a content item such as Owner Date Created Date Published and Date Modified Remove Publish Later Adds the ability to delay the publication of a content item to a later date and time Remove Title Provides a Title for your content item Remove Autoroute Adds advanced ur configuration options to your content type to completely customize the url pattern for a content item Remove gt Body Allows the editing of text using an editor provided by the configured flavor e g html text markdown Remove Tags Allows to describe your content using non hierarchical keywords Remove Localization Menu Provides an easy way to create a ContentMenultem from the content editor Remove E3ETS A content type in Orchard is made up of fields and parts An good overview of these concepts is described in Basic Orchard Concepts A field is something specific to the type for example a Product type might have SKU and Price fields A part however is a reusable component that can be attached to one or more types For example the Autoroute part gives a type the ability to be addressed on the front end via a route url In some ways you can think of a type as having fields and being made up of one or more parts This is actually reflected in the underlying code in Orchard as well To treat a blog post as a AutoroutePart and access it s AutoroutePart Slug property you would write somethi
400. le Type File folder File folder PROJ File Windows Comma Windows Comma Windows Comma Text Document Windows Comma Text Document PROJ File SIZE Attachments Manually installing Orchard zip file VSOpenSolution PNG To run the site press Ctrl F5 You should see the Orchard setup screen in your browser 1 2 5 Setting Up a Site When you first launch the Orchard site you are presented with the Orchard setup screen 20 Chapter 1 Getting Started 7KB 1KB 1KB 2 KB 7KB 1KB 2 KB 24 KB Read the Docs Template Documentation Release 1 9 2 Get Started Please answer a few questions to configure your site What is the name of your site My Orchard Site Choose a user name admin Choose a password Contirm the password How would you like to store your data amp Use built in data storage SQL Server Compact Use an existing SQL Server SQL Express database Use an existing MySql database Choose an Orchard Recipe Orchard Recipes allow you to setup your site with additional pre configured options features and settings out of the box Default I7 The default recipe for an Orchard site that includes pages blogs custom content types comments tags widgets and basic navigation 1 2 Manually installing Orchard from a zip file 21 Read the Docs Template Documentation Release 1 9 2 By default Orchard includes a built in database that you can use without installing a
401. le strings throughout the code The static Get Prefix method is a conventionally defined method that is used to create unique column names in the database for instances of the field type 3 9 Extending Orchard 375 Read the Docs Template Documentation Release 1 9 2 We then have two actions Display and Editor which start by fetching the settings and value for the field and build shapes out of them Note The UsedImplicitly attribute is only here to suppress a warning from Resharper It could be removed without much harm The shapeHelper object provides some helper methods to create shapes two of which can be seen in action here The second Editor method is the one that is called when the admin form is submitted Its job is to map the submitted data back into the field and then to call the first Editor method to render the editor on the screen again Writing the Templates We need to write the views that will determine how our field is represented in admin and front end UI Create a Fields and an EditorTemplates directory under Views Then create another Fields directory under Edi torTemplates In Views Fields create the following Custom DateTime cshtml lt p class text field span class name gt Model Name lt span gt if Model ShowDate lt text gt Model Date lt text gt if Model ShowTime lt text gt Model Time lt text gt lt p gt This code renders the name of the field a colon and then the dat
402. lease 1 9 2 lt img alt Location border 1 src http maps google com maps api staticmap amp zoom 14 amp size 256x2560 amp maptype satellite amp markers color blue GModel Latitude Model Longitude amp sensor false This example shows an img element in which the src attribute contains a URL and a set of parameters passed as query string values In this query string Model represents the shape that was passed into the template There fore QGModel Latitude is the Latitude property of the shape and eModel Longitude is the Longitude property of the shape The following example shows the template for the editor This template enables the user to enter values for the latitude and longitude model Maps Models MapPart lt fieldset gt lt legend gt Map Fields lt legend gt div class editor label gt Html LabelFor model gt model Longitude lt div gt div oclass edritor field Html TextBoxFor model gt model Latitude aHtml ValidationMessageFor model gt model Latitude lt div gt lt div class editor label Html LabelFor model gt model Longitude lt div gt lt div class editor field gt Html TextBoxFor model gt model Longitude Html ValidationMessageFor model gt model Longitude lt div gt lt fieldset gt The Html LabelFor expressions create labels using the name of the shape properties The Html TextBoxFor expressions create text boxes where users
403. led on your site To view the modules that are included with Orchard in the Orchard Dashboard click Modules and then click the Installed tab in the Modules screen 70 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 ED Features Installed Recipes Gallery New Install a module from your computer Content l amp Content Definition Alias Version 1 8 1 Bloa Maps friendly urls to specific module actions E Features Alias Alias UI Author The Orchard Team Website http orchardproject net EX Comments AntiSpam Version 1 8 1 Provides anti spam services to protect your content from malicious submissions Taxonomies Widgets Features Akismet Anti Spam Filter Anti Spam TypePad Anti Spam Filter Author The Orchard Team V cal Media eae eee Wavigalon Archive Later Version 1 8 1 a The ArchiveLater module introduces scheduled archiving functionality Modules Features Archive Later Author The Orchard Team Website http orchardproject net s Themes Autoroute Version 1 8 1 Description for the module Features Autoroute Author The Orchard Team Website http orchardproject net Blogs Version 1 8 1 The Orchard Blogs module is implementing basic blogging features Features Blogs Remote Blog Publishing Author The Orchard Team Website http orchardproject ne Orchard provides some built in modules and you can install new modules For
404. les are being built as well A module is just an ASP NET MVC area with a manifest txt file that is extending Orchard A module typically contains event handlers content types and their default rendering templates as well as some admin UI Modules can be dynamically compiled from source code every time a change is made to their csproj file or to one of the files that the csproj file references This enables a notepad style of development that does no require explicit compilation by the developer or even the use of an IDE such as Visual Studio Modules must be placed in the Modules folder Orchard Web Modules MyModule and the folder name must match the name of the compiled DLL produced by the project So if you have a custom module project called My Custom Module csproj and it compiles to My Custom Module dll then the module root folder must be named My Custom Module Modules My Custom Module Themes It is a basic design principle in Orchard that all the HTML that it produces can be replaced from themes including markup produced by modules Conventions define what files must go where in the theme s file hierarchy The whole rendering mechanism in Orchard is based on shapes The theme engine s job is to find the current theme and given that theme determine what the best way to render each shape is Each shape can have a default rendering that may be defined by a module as a template in the views folder or as a shape method in code T
405. les such as pages and blogs or themes If you re looking to add additional functionality you can da so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you 50 if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Second Leader Aside Third Leader Aside Lorem ipsum dolor sit amet consectetur adipiscing Lorem ipsum dolor sit amet consectetur adipiscing Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum elit Curabitur a nibh ut tortor dapibus vestibulum elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel Aliquam vel sem nibh Suspendisse vel Aliquam vel sem nibh Suspendisse vel condimentum tellus condimentum tellus condimentum tellus Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 You can now begin configuring your site 1 1 5 Change History Updates for Orchard 1 8 4 15 14 Updated info for 1 8 release Updated some screenshots requirements zip link and other minor changes Updates for Orchard 1 1 4 12 11 Updated screens for 1 1 installation 3 14 11 Added information about recipes in the setup screen 1 2 Manually installing Orchard from a zip file This topic
406. ling Orchard Using a zip File e Enlist in the Orchard source code and build Orchard from the command line or in Visual Studio This topic shows how to install Orchard using the Microsoft Web Platform Installer 1 1 2 Requirements The minimum requirements for running Orchard are the following ASP NET 4 5 A web server such as IIS Express 8 7 5 or IIS 7 x When installing IIS make sure you enable the ASP NET IIS modules Also make sure that you run Orchard in an integrated pipeline ASP NET 4 application pool Important If you previously installed any pre release versions of WebMatrix ASP NET Web Pages or ASP NET MVC 4 you should uninstall those products before Orchard will run correctly on your computer To develop Orchard sites many developers will want to use a database such as SQL Server and a web page programming environment such as WebMatrix or Visual Studio 2013 The following installation was tested with a clean installation of Windows 8 1 It uses the Web Platform Installer and it includes Orchard IIS 8 0 Express and optional applications for Orchard development like WebMatrix and SQL Server Compact 4 0 Read the Docs Template Documentation Release 1 9 2 1 1 3 Installing Orchard To begin download and install the Web Platform Installer When you re done run it Find Orchard CMS and then click Add to include Orchard as an item to install o Web Platform Installer 4 6 sli Rs Spotlight
407. llery Updates 0 Current Theme Tires Machine The Theme Machine B By jowall mibach loudej heskew ru uiia E Ri ota ae ER Version 1 0 20 httpz orchardpraject net me Orchard Theme Machine is a flexible multi zane theme that provides a solid foundation a to build your site It features 20 collapsible widget zones and is flexible enough to cover a n wide range of layouts EE m STTACE d mai pa mm E tur Available Install a theme fram your computer img Contoso TH PCR AETEHI I COUTACTS A ES Pee r TT Perm By The Orchard Team By BIND Version 1 0 Version 1 0 1 A subtle and simple CMS theme perfect for Custom Theme by BIND any modern product or service business httpz www bind pt website Enable Uninstall http weww orchardproject net Enable Uninstall To use an example theme to test this feature download an existing theme from the Gallery tab on the Themes page then browse to the saved nupkg file on your computer and install it as described previously When a theme is installed the theme files are placed in the Themes folder You can see the installed themes in your site by checking the Available section on the Themes page in the dashboard For more information about how to preview themes and apply them to your site see Previewing and Applying a Theme 152 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Change History Updates for Orchard 1 1
408. llowing you to create your form In this screen is where you can choose to either store the submission or create content from the submitted values However let s say we are looking to add a new widget that will live in the right rail AsideSecond zone that is a call for visitors to join a mailing list The only input that will be captured will be the users email address Store Form Submission as a Content Type In order for Dynamic Forms to capture and save an email address from a visitor as Content we need to create a new content type in Orchard In the admin browse to the Content Definitions tab and click on Create new type button in the upper right Let s call the new type Subscribe Form 230 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 upload dynamic forms dynamic forms new content type subscribe form png The next screen asks if we d like to save any Parts to the new Subscribe Form content type Since all we are looking to capture is an email address click on the save button without selecting any of these options Now that we have our new content type we ll want to add an input field for the email upload dynamic forms subscribe form email field png After adding and saving the input field with the name Email we can now customize the type of validation the new input field should have by selecting an input type of Email Feel free to fill in the other information for the field
409. located in NViewsNPartsNFeaturedProduct cshtml 9 Replace the Style Include call which is used to directly reference style sheets with a Style Require call This is used to refer to resources defined in resource manifest files 334 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Style Require FeaturedProduct Don t forget that the resource doesn t need the css extension on the end If you run the module in Orchard now then it will look the same as it did before While this is a simplistic application of a best practice I think that from the explanation of it you will see how valuable it will be in more complex modules Orchard also has an assets pipeline feature This feature can help build your resources into the final files to be included by Orchard in the resource manifest For example you might want to combine the scripts into a single file or minify your style sheets If you look in your project you will see a file called Assets json which drives this feature Don t tie your CSS classes to the visuals The CSS classes used throughout the module so far have been intentionally terrible The reason for this was to highlight the fact that you shouldn t tie the class names to the visuals of the class When your module is out there in the wild it will be used by many different themes which will all provide their own color schemes and styles If somebody took our module and wanted to make
410. lt siteName gt AdminUsername lt username gt AdminPassword lt password gt DatabaseProvider lt Sq l CelSOLServer gt DatabaseConnectionString lt connection_string gt DatabaseTablePrefix lt table_prefix gt En abledFeatures lt featurel featurez gt Run first time setup for the site or for a given tenant If you run Orchard exe before you have set up your site the only command you can run is the setup command This performs exactly the same function as running Orchard in the browser and completing the setup form to enter a site name admin user name password and database options Additionally the setup command takes an optional argument which is a list of features to enable at setup time orchard setup SiteName Orchard Developer Site HdminUsername admin AdminPassword adminiz3 Data baseProuider SqlCe Site Orchard Developer Site sucessfully setup to run data provider SqlCe with table prefix After running the setup command you can type help commands again to reveal more commands orchard help commands List of available commands blog create Slug slug Title title Owner username MenuText menu text gt Creates a new Blog blog import Slug lt slug gt FeedUrl feed url Owner lt username gt Import all items from feed url into the blog at the specified slug cultures get site culture Get culture for the site cultures list List site cultures cultures
411. lternates available for a MenuItem object with the following template names MenuItem mainMenuItem main url my blogMenuItem main url my blog post 1 For the homepage the following alternate is available MenuIltem main url homepage 460 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Using this module you can add URL specific alternates to the Layout shape such as the following Layout url homepage This adds a specific layout for your About page of your site Creating a new layout file in your Themes ThemeName Views named Layout url About cshtml would be picked up and used when viewing the About page in your site Note if the changes are only small perhaps using alternate url naming to the zone would be more appropriate You can enable URL Alternates by downloading the Designer Tools module from the Orchard Team in the Orchard Modules Gallery Orchard Designer Tools Similarly widget alternates add new templates names that you can use to change the rendering of content parts when they are rendered as part of a specific widget type or inside of a specific zone Shape Tracing another feature of the Orchard Designer Tools module is a great way to discover what alternates are available for any shape template on the page Here are some examples of widget alternate template names Parts Common Body HtmlWidget TripelSecondParts Common Body TripelSecond Explicitly Designating an Alternate Template In
412. ly of a stylesheet a few templates usually layouts and a few images They will contain no code except for the simple code in the template files For more advanced themes you might want to provide settings create custom shapes or override shapes in code To address these scenarios it is possible to build a theme much like a module and include a csproj file that describes how to compile the code it contains For information about module development see Walkthrough Writing An Orchard Module and Creating a Module with a Simple Text Editor 3 11 3 Understanding the placement info File In a CMS such as Orchard content is built as a composition of arbitrary parts For example a blog post is an assemblage of a route Autoroute Part title Title part contents Body part tags Tags part comments Comment part and a few additional technical parts Common and PublishLater To get a template to render an object like this you could access each of these parts explicitly and render them that s a scenario that would work in Orchard But that would not handle well the unpredictable changes in the definition of the content types that are the essence of a CMS For example what if the administrator of the site downloaded a star rating module and added the rating part to posts If the layout for the whole item were explicitly defined you would have to explicitly modify the template In Orchard this isn t necessary and adding a new part and dis
413. m in particular in terms of dynamic compilation and loading additional assemblies If you are not using a module it should be removed Some modules such as the gallery will be useful on your development server but probably not on your production server and should be removed 242 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Going even further some modules are a convenience that you might want to do without For example many modules do nothing more than render a pre formatted bit of HTML to include some external script or embedded object If so it s a good to determine whether you couldn t achieve the same thing with an HTML widget or the body of content items by going into the HTML source and directly injecting HTML there Depth of the Views Folders The contents of Views folders are dynamically compiled and there is some overhead associated with each subfolder This combined with the multiplication of modules in a typical Orchard instance means that it can have an impact on startup performance to flatten Views directories Orchard gives a choice to module and theme authors to use subfolders or equivalent dotted names for templates see Accessing and Rendering Shapes It is generally preferable to use the dotted notation IPv6 Development Servers and Modern Browsers If you are in an IPv6 environment and using a local development server such as the Visual Studio Development Server or IIS Express in W
414. m lt div gt l diw id layout main container gt site lt div id layout main class group gt 31 Mit Model AsideFirst null CI Files 32 E aside id aside first class aside first proup gt 2 lzone Model AsideFirst Databases 34 lt aside gt mim 1 100 F 4 mm Reports Find Results Error List You can change the editor WebMatrix uses by following these instructions As an example you may find it helpful to use the XML editor which provides colorization on the placement info file To do this you must change the setting for info files in the WebMatrix file filetypes xml which can be found in the following locations 32 bit machines C Program Files Microsoft WebMatrix config filetypes xml 64 bit machines C Program Files x86 Microsoft WebMatrix config filetypes xml 1 Add the info file extension to the list of XML file types 32 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 lt FileType extension info config csproj vbproj resx settings sitemap user wsdl l lt OpenAs gt XML lt OpenAs gt lt TabColor gt Yellow lt TabColor gt lt Icon gt XMLFileIcon lt Icon gt lt EmitUt f8BomByDefault gt True lt EmitUtf8BomByDefault gt lt Description gt An XML File lt Description gt lt FileType gt 1 Remove the info file extension from the list of Text file types Text Gray DefaultFileIcon False Unknown file type 2 Restart WebMatrix to apply the chan
415. me Pict picture Width Here is an approach you can use in Orchard 1 1 with the amount of code required to get the picture width reduced from three lines to just one Model ContentItem ProfilePart Picture Width Creating Shape Templates Shape templates are fragments of HTML markup for rendering shapes To demonstrate how shape templates are used suppose you want display a map on your web page The shapes that will contain the map settings for display and edit are defined in the following driver code using Maps Models using Orchard ContentManagement using Orchard ContentManagement Drivers namespace Maps Drivers public class MapPartDriver ContentPartDriver lt MapPart gt protected override DriverResult Display MapPart part string displayType dynamic shapeHelper return ContentShape Parts Map gt shapeHelper Parts_Map Longitude part Longitude Latitude part Latitude GET protected override DriverResult Editor MapPart part dynamic shapeHelper return ContentShape Parts Map Edit gt shapeHelper EditorTemplate TemplateName Parts Map Model part POST protected override DriverResult Editor MapPart part IUpdateModel updater dynamic shapeHelper updater TryUpdateModel part Prefix null null return Editor part shapeHelper 466 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 The Display method is used to display the
416. ment Records ContentPartRecord 5 Add a public property to the class Place your cursor in the main body of the class Type prop then press the Tab key twice public class FeaturedProductPartRecord ContentPartRecord pror 1 1 prop Code snippet for an automatically implemented property Language Version C 3 0 or higher Mote Tab twice to insert the prop snippet This will insert a code snippet for an automatically implemented public property 6 In the first placeholder you can just start typing and it will replace the int automatically set it to virtual bool then press Tab type IsOnSale and press Enter to complete the property public class FeaturedProductPartRecord ContentPartRecord i The important thing to remember for your ContentPartRecord classes is that each of the properties you want to store in the database should be marked with the virtual keyword This is so that NHibernate the database system used by Orchard can inject its underlying plumbing You should now end up with a file called Models FeaturedProductPartRecord cs with the contents using Orchard ContentManagement Records namespace Orchard LearnOrchard FeaturedProduct Models 1 public class FeaturedProductPartRecord ContentPartRecord public virtual bool IsOnSale get set Update the ContentPart You now have a class that will provide the interface between your database and your content part FeaturedProductPartRecord The fir
417. ment or it should be set to false Importing and Exporting a Recipe Orchard enables you to import and export recipes from and to the web server It uses the Import Export module which is disabled by default Therefore you must enable the module to use this feature To enable the Import Export module open the dashboard and click Modules On the Modules page select the Features tab Under Content locate the Import Export feature and click Enable A message at the top of the page will notify you when the feature is enabled You will also see Import Export listed in the dashboard feature list Import Export To export a recipe open the dashboard and click Import Export Click the Export tab and then choose the types metadata data and settings to include in the export file When you are finished click Export 216 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Export Import Export Choose the types to include in the export file Content Types ContainerWidget Page Menultem Layer HtmlWidget Blog BlogPost RecentBlogPosts BlogArchives List Comment o o px ES E s E ps pu p a Choose what to save for these types 7 Metadata Metadata is the definition of your content types what parts and fields they have with what settings E Data Data is the actual content of your site Version History a Only Published Versions Only Drafts E Site Settings Please verity that you are not ex
418. mentation Read the Docs Template Documentation Release 1 9 2 W w compare master gs Choose a head branch bas fix reverted footer issue w master revert 116 master revert 118 master revert 120 master update contributing patches update manifest docs In this screenshot the upgrade contributing patches branch is being selected 7 The page will refresh and you will see all the files that are going to be updated by your pull request 3 14 Getting Involved 513 Read the Docs Template Documentation Release 1 9 2 Comparing changes Choose two branches to see what s changed or to start a new pull request If you need to you can also compare across forks base fork OrchardCMS OrchardDoc base master head fork rtpHarry OrchardDoc compare update contributing patches Able to merge These branches can be automatically merged Wee Xon Discuss and review the changes in this comparison with others 1 commit 1 file changed 0 commit comments l Commits on Aug 31 2015 rtpHarry initial re draft Showing 1 changed file with 76 additions and 38 deletions 114 EEEE Documentation Contributing patches markdown Creating a branch inside a fork should be 1 preferred because it makes merging a lot easier Prerequisites 5 1 contributor Unified Split Review the files that are going to be changed This is your last chance to double check ever
419. mes_available png Click Set Current The Installed tab is redisplayed showing MyTheme as the current theme You can now go to your website to see the new theme in action Change History Updates for Orchard 1 8 9 8 14 Updated screen shots for Customizing Default Theme 3 3 Using the Orchard Gallery 3 3 1 Gallery Overview Orchard is a modular web based CMS that s designed to be extended by installing additional module packages and by enabling features contained in those modules A module package consists of a ZIP file in the nupkg format In Orchard a theme is also a module To facilitate sharing for modules and themes Orchard lets you search for modules and themes online and install them directly to your site Browsing the Gallery Web Site To find available modules and themes and download them to your computer you can browse the Orchard Gallery website For more information see Browsing the Gallery Website Installing Modules and Themes from the Gallery You can also access the Gallery from within your Orchard site in order to download or install modules and themes To do so click Themes or Modules on the dashboard and then click the Gallery tab Note The Gallery feature is enabled by default For more information about working with the Gallery feature including how to enable or disable it see Installing Modules and Themes from the Gallery Contributing a Module or Theme to the Gallery If you are a developer who
420. mic forms no content type png View Submitted Dynamic Forms Data At this point we have enabled the Dynamic Forms module created a new content type for the Dynamic Forms to use and added a Dynamic Forms widget to draw the Subscribe Form content type in the right rail AsideSecond zone of all the pages The submissions are being saved in Orchard because the option in the Dynamic Forms widget Create Content was checked So where are they being saved Select the Content link on the left in the admin section of Orchard Documentatio n upload dynamic forms subscribe form entries png You can view all submitted data without a content type by going to Form Submissions section in the admin Documentation upload dynamic forms form submissions png Export Dynamic Forms Data Since Dynamic Forms can be either saved as a content type or as a form submissions you have different steps when exporting and importing Exporting Forms saved as Content Type The only thing left to do is to export our list of submissions so that the email addresses can be used by services like Publicaster Campaign Monitor MailChimp and the like The easiest way to export anything and everything from the 3 4 Managing Websites 233 Read the Docs Template Documentation Release 1 9 2 Orchard CMS is to use the Import Export module The Import Export module is shipped with Orchard by default in version 1 6 and on but is not enabled by default Let s en
421. mized module loading strategy which for example allows loading assemblies for modules without having to deploy them in the bin folder In addition to that Orchard supports this is still somewhat experimental the ability to dynamically compile modules deployed as source code only This is more flexible than deploying binaries and enables some interesting scenarios such as in place code customization without having to use Visual Studio This is somewhat similar to the ASP NET App Code directory except Orchard supports multiple logical folder typically one per module independently The goal of this section is to describe at a technical level how Orchard load modules in the 0 5 release This feature is often referred to as Orchard Dynamic Compilation even though technically dynamic compilation is only involved in very specific cases High Level Overview When an Orchard application starts the Orchard Framework the ExtensionLoaderCoordinator class to be precise needs to figure out what are the modules installed in the Web Site and activate them typically by loading their assem bly At a high level this process can be divided in 3 distinct phases Discovery figure out what are the modules present in the web site Activation figure out what strategy to use to activate or load each module References Resolution figure out what are the assembly references needed to be activated for each module This phase is t
422. mments to be shown but does not allow the conversation to continue i Allow threaded comments Enable to allow users to answer directly tp other comments Created On Owner admin Save Publish Now e Publish Later In the dashboard click Blog to view the list of posts in the blog In the list of posts the new post is saved as a draft which means it is not yet visible to visitors of the site Click Publish to allow site visitors to see the post Manage Our Blog User admin Log Blog Properties A blog for your website Actions Choose action Y Apply New Post LJ My first post Blog Post Clone Preview Publish Edit Delete Not Published 1 Draft 0 comments Last modified 12 seconds ago By admin A screen shows that the post was published successfully 1 7 Adding a Blog to Your Site 81 Read the Docs Template Documentation Release 1 9 2 Manage Our Blog User admin Loc That Blog Post has been published Blog Properties A blog for your website Actions Choose action Y Apply New Post LJ My first post Blog Post Published No Draft Published a moment ago 0 comments Last madified 1 minute ago By admin Clone View Unpublish Edit Delete Click Your Site to view the site s home page again A new tab Blog has been added to the menu Click the Blog tab which will display the blog and the new the post To see more details about the new post click the m
423. ms Contributor Can author and edit his own content items but not publish them save draft only Anonymous Can view the front end of the site only Authenticated Can view the site front end and perform other operations depending on the site and other role permission settings Implied Permissions Some permissions specify whether a user is allowed to perform a single action other permissions specify whether the user is allowed to perform a group of actions The permissions that pertain to a group of actions are typically higher level permissions that logically include lower level actions When you grant a higher level permission that relates to a group of actions the lower level permissions are implicitly included For example if you grant a role permission to manage blogs you are also granting that role permission to edit publish and delete blogs You can see which permissions are explicitly or implicitly granted by examining the check boxes in the AI low and Effective columns The Allow column shows which permissions are explicitly granted and the Ef fective column indicates which permissions are explicitly or implicitly granted The following image shows that Manage blogs was specifically granted to the role and the other permissions were implicitly granted 3 4 Managing Websites 207 Read the Docs Template Documentation Release 1 9 2 Orchard Blogs Feature Permission Allow Effective Manage blogs v Edit own blog posts
424. n Manager Feature in Vandelay Industries module available from the gallery adds commands to install translation files more parsimoniously Once you have the module installed and the po file that you want to install downloaded enter the following command replacing the path to the po file as necessary install translation c temp fr zip This should have only extracted those resources for the modules that are actually installed that it has translations for If a module is not found running the command won t create unnecessary directories and your Orchard site will remain clean If you later install additional modules for which a translation exists it is possible to re run the command Switching the site to another culture To change the default culture for the application go to the Settings gt General screen in the Orchard dashboard Under Default Site Culture click Add or remove supported cultures for the site Default Site Culture en US Add or remove supported cultures for the site In the Cultures screen select a culture from the Add a culture list for example fr FR and then click Add The culture code is added under Cultures this site supports To remove a culture click the x button next to it Read the Docs Template Documentation Release 1 9 2 Cultures Manage Settings gt Supported Cultures Available Cultures Add a culture at ZA Other Cultures this site supports en US After you
425. n Orchard select the Preview tab in Live Writer When you are satisfied with the way your post looks click the Publish button 3 1 Authoring Websites 113 Read the Docs Template Documentation Release 1 9 2 A cecond post from Live Writer Windows Live Writer File Edit View Insert Format Table Tools Blogs Help New Open Save draft My Orchard Site Home About Us Our Blog Our Blog MVC Area One A second post from Live Writer Perfect place to tak about your The Orchard Project amp committed to open community particpabon We encourage company Contoso i5 a fictinus contributions of al sorts ndudng code submissions bug fixes and patches feature company that provides technology recommendations general project feedback and more In addition we hope that other sevices to a varierty of sectors community members and partners in the ecosystem may be nterested n ut amp zng Orchard to help them build ther own applications MVC Area Two We are saying free shipping on al software today Yup the amp a good place to put the Contact Us 1 Mxrosaft Way Redmond WA 98444 United States a Set categories Eset publish date Draft Unsaved Our Blog Live Writer publishes your post and will automatically load the URL for the post in your browser for viewing 114 Chapter 3 Documentation Read the Docs Template Documen
426. n create new accounts on the site Display a link to enable users to reset their password Users must verify their email address Users must be approved before they can log in Change History Updates for Orchard 1 8 9 8 14 Updated screen shots for Managing users and roles 3 4 7 Understanding Permissions This topic has been updated for the Orchard 1 8 1 release Each role has a set of permissions assigned to it and these permissions indicate which actions a user in that role can perform For each role you can only grant permissions you cannot specifically deny a permission A user s permission set consists of all granted permissions for all roles that the user belongs to To assign or review permissions for a role click the Roles link Click Edit for the role you want to modify or review 206 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Users Actions Delete Name Administrator Edit Anonymous Edit Delete Authenticated Edit Delete Author Edit Delete Contributor Edit Delete Editor Edit Delete Moderator Edit Delete By default Orchard includes a number of roles with default permissions Administrator Can perform any operation has all permissions Editor Can author publish and edit his own and others content items Moderator Can moderate comments and tags only No authoring permissions Author Can author publish and edit his own content ite
427. n download additional po files for other cultures from http orchardproject net localization Translations are provided by the community If you don t find the culture you re looking for please consider contributing it It s a few 3 1 Authoring Websites 119 Read the Docs Template Documentation Release 1 9 2 hours of work and it will benefit the whole community Contributing new translations Working with a plain text editor The localization tool available at https crowdin net project orchard cms can prepare stub files for a specific language Orchard s translations are stored in the form of PO files in packages that you can add to your own Orchard instance These packages are regenerated at the beginning of every hour the process takes 2 3 minutes Please visit the project home page on Crowdin to see the progress of the translations for each language You can download all the translations for each language for both projects Orchard CMS Orchard CMS Gallery The downloaded zip file contains the set of po files that you can edit using a text editor When you re done please subscribe to our localization mailing list by sending email to join orchard localization lists outercurve org and then send the zipped package of po files to the list Please make sure when working with po files that the files are saved in UTF 8 with Byte Order Mark This is usually a setting in your text editor in Notepad it is under the Encoding drop
428. n on how to do that 142 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Home Orchard CMS Scheduled Page Events First Event Tags Orchard Harvest Monday September 8 2014 9 21 08 PM Location USA No Comments Hi admin Comment Let s try out the Search capability against our new content type Make sure you have first enabled the Indexing Search and Lucene features in the Features admin screen Now visit the Search Index page to view the available fields that are indexed You should see the event location field in the index as expected if not just rebuild the index and you ll see it Indexes User admin Logout The index orchardsearch has been updated orchardsearch Update Rebuild Delete 4 document s Updated a moment ago Fields id type created published modified author body format title tags event location 3 1 Authoring Websites 143 Read the Docs Template Documentation Release 1 9 2 We can tell the Search feature to query this field by going to the Settings admin screen and adding this field to the Search settings Search Indexes orchardsearch Select which index to use in search queries Fields id type created published modified author body format title tags event location Check any property which should be used for search queries On the front end type a keyword that matches the location of your event Search
429. n someone wants to deploy an Orchard web site where all modules are pre compiled and stored in bin in a typical asp net web application way 500 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Core Module Loader If module txt indicates a module from the Core folder the CoreExtensionLoader return the types from the Orchard Core amp lt moduleMame amp gt namespace of the Orchard Core assembly Orchard Core is a special assembly containing modules that are core to the system i e offering basic functionality on top of the Orchard Framework Precompiled Module Loader If module txt indicates a module from the Modules folder the PrecompiledExtensionLoader looks for an as sembly named amp lt ModuleName amp gt in the Modules amp lt ModuleName amp gt bin folder If the file exists it s is copied to the App_Data Dependencies folder which is a special folder used to ASP NET to look for additional assemblies outside of the traditional bin folder Dynamic Module Loader If module txt indicates a module from the Modules folder the Dynamic Module loader looks for a file named csproj in the Modules amp lt ModuleName amp gt folder If the file exists the loader will use the Orchard build manager for csproj files to compile the file into an assembly and return all the types from that
430. n the About page if the user is not authenticated or on any page if the user is authenticated 1 9 Managing Widgets 93 Read the Docs Template Documentation Release 1 9 2 not authenticated and url about or authenticated To allow multiple URL values you can use the following syntax url e rfoo or url ebasrf 1 9 6 Assigning a Widget to a Zone To assign a widget to a zone click the Add button on a zone that you want to add the widget to and then select the widget to add For example click Add on the Header zone and then in the Choose A Widget screen click the Html Widget The Add A Widget screen is displayed 94 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Add Wid get User admin Logout fone Header Layer Default Position 1 Title Body BA 2 Ha B J Format wm al Owner admin 1 9 Managing Widgets 95 Read the Docs Template Documentation Release 1 9 2 The fields you need to fill in depend on the widget you re configuring However all widgets have Zone Layer Title and Position fields The Position field determines the relative position of all widgets within the zone in effect z order Keep in mind that the widgets within the zone can come from multiple layers For example two different layers might have widgets assigned to the same zone The value of the Position field can be an integer or a sequence
431. n we can make a Tag cloud widget appear on the side 274 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Current Layer Default MEE Add a new layer The widgets in this layer are displayed on all pages All Layers Hide All Anonymous empty Header Add y empty Authenticated empty Naviaatior Add Navigation le Default Main Menu Menu Widget Unpublish Remove Disabled empty TheHomepage empty Featured Add EafnrakAain Add More advanced themes may also include some programming code to further customize the look Developer The developer has a complete insight of the architecture of Orchard and can extend it Orchard is organized in modules Each module provides a building block aka add on plugin to the website with a high level distinct goal For example you can have Extension module Adds some low level features that will benefit the website Eg Ability to search your content or to use an external editor to write blog posts like Live Writer Content module Adds everything code and visual required to view edit some type of content like blog posts Widget module Adds a small visual content that can be displayed on the side of existing content modules like a Tag cloud next to a blog Element module Adds a small contained element for use in the Orchard Layouts module a core module that lets you design page layouts in the browser Theme module Changes the lo
432. n will display the list of content items that share that tag Manage tag Orchard Tag Name Orchard Content items tagged with Orchard Content Type Name Page Welcome TO Orchard 1 10 1 Change History Updates for Orchard 1 8 10 31 14 Updated screen shots for managing tags 1 10 Organizing Content Using Tags 99 Read the Docs Template Documentation Release 1 9 2 100 Chapter 1 Getting Started CHAPTER 2 Tutorial Videos 2 1 Tutorial Videos About Orchard 2 1 1 Introduction Training Videos 2 1 2 Commercial Pluralsight has an introductory training course available here http pluralsight com training courses tableofcontents courseName orch fundamentals The first part of the Pluralsight video course is free and subsequent episodes require a subscription Orchard CMS Theme Development For Beginners Orchard CMS Theme Development for Beginners by Abhishek Luv Orchard CMS Tutorial Workflows in Orchard CMS Orchard CMS Tutorial Workflows in Orchard CMS by Abhishek Luv 2 1 3 Free Dojo Course Course for beginners interested in developing on Orchard starting with how to use Orchard from the UI Orchard CMS for Absolute Beginners Orchard CMS for Absolute Beginners by Abhishek Luv Orchard CMS Tutorial Recipes in Orchard CMS Orchard CMS Tutorial Recipes in Orchard CMS by Abhishek Luv 101 Read the Docs Template Documentation Release 1 9 2 Introduction to Orchard 1 5 by Sebastien Ros
433. nclude the header content meta and footer but they can have any combination of zones defined In this case the Content is the main content area The priority means that it will be near the top of the content zone In more complicated modules there could be several shapes Setting different priorities will let you organize their display order when you want them to be in the same zone For example if another shape had a place of Content 0 5 it would go before it Content 15 and it would go after it Theme developers can customize these layout preferences by providing their own placement info and overriding your initial configuration This lets theme authors customize your module without having to make changes to the actual code This means when the module is upgraded to a new version the theme developers changes will not be overwritten Trying the module out in Orchard Congratulations you ve made it to the pay off using the module in Orchard The last few steps will enable the module in Orchard and assign the widget to a zone in the active template 1 In Visual Studio press Ct r1 F5 to start the dev server without debugging mode enabled 300 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 2 Log in to the admin dashboard The login link will be in the footer of the site 3 Click Modules in the navigation menu 4 The first item in the list should be our module Orchard LearnOrchard FeaturedProduct Unca
434. nd enable the Orchard Packaging feature Packaging Gallery Enable Packaging Packaging Services Enable Depends on Packaging Depends on Packaging Services Alternatively you can enable the Orchard Packaging feature from the Orchard command line To do this run bin orchard exe from the root of your Orchard installation or the root of the Orchard Web project if you are run ning against a source enlistment orchard gt feature enable Orchard Packaging When the Orchard Packaging feature is enabled the Orchard command line tool supports additional commands that can be used to create a package nupkg file from any module in your Orchard installation and to install a new module from a packaged nupkg file package create lt extensionName gt path Create a package for the extension lt extensionName gt an extension being a module or a theme The package will be output at the path specified The default filename is Orchard Module Theme extensionName extensionVersion nupk 3 9 Extending Orchard 381 Read the Docs Template Documentation Release 1 9 2 For example package create SampleModule c temp will create the package e temp Orchard Module SampleModule 1 0 0 nupkg package install packageId location Version lt version gt Install a module or a theme from a package file package uninstall packageId Uninstall a module or a theme The packageId should take the format Orchard M
435. nd modules you can use the Feed drop down list to filter the display so that it shows all available items or only the items from a selected feed This is only useful if you have multiple feeds registered 3 3 Using the Orchard Gallery 161 Read the Docs Template Documentation Release 1 9 2 Modules User admin Logout Features Installed Gallery Updates 0 Sort by Downloads neration Version 1 0 20 Install Download Tools to create Orchard components Last Updated 1 13 2011 9 37 35 AM Author The Orchard Team Downloads 2632 Website http orchardprojectnet Rating iki Hierarchical menu Version 1 1 0 TEN Install Download lt A Support for multi level hierarchical main menu Adds also the Breadcrumbs Widget RecenthSeenWidget and a MenuWidget to display independent submenus on your pages I act lindated 2 35 7211 12738 ABA T Arthnr Gictr Senedd Deo unlnanc 1005 By default the Orchard Gallery feed is registered for an Orchard site To register additional gallery feeds see Regis tering Additional Gallery Feeds Module gallery feeds Change History Updates for Orchard 1 1 3 22 11 Updated screen shots and menu or UI options 3 3 3 Browsing the Gallery Web Site The Orchard Gallery web site allows you to browse and search for available modules and themes to extend and customize the behavior of any Orchard site It also provides a convenient way for developers and designer
436. nd other items that share that tag 3 3 Using the Orchard Gallery 165 Read the Docs Template Documentation Release 1 9 2 ORCHARD HOME POIN US ON a s Orchard gallery Home Modules A Sigh in Ggarch Tignes 43 results for Themes Denlrying repas L 10 Dark 1 0 22 Do By BIND ando asd A dark bared there Ey BINU More information d 0 cnmrment Tags bind business web2 0 black dark modem 565 Download Contoso 1 0 x Chrno ad By The Orchard Team A subtle and simple CMS theme perfect for any modem product or serice business website More information 0 comiirents Tage business ema modem umple subtle produci crack 2T 2 Derardoadk Classic 1 0 Dranio Riit z By THe Orchard Tear Orchard Clark Heg There Mora inormmatian Qoomments Tags Classic blog Senf 848 Downloads You can search for available themes or modules by typing keywords in the search input box For modules you can also search within a specific category or across all categories 166 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 ORCHARD HOME jo us on Ea E d a s Orchard gallery Home Modules Fi Sign In Contribute 7 results for blue in All Categories E nas Ing all rez m Skewed Summer Kitsch Download 1 0 0 By Nathan Hecho Dose A shghth over the bop theme usmg Typelet and mspired by hitpi lveecn coleurcven cam paleite 13
437. nd with 500 000 transactions cache 128MB After you ve set up an account with a hosting provider the provider will typically send you an email with your user name server name and other information To save you the extra step of entering this information manually the provider might send you a Profile XML file named with the publishsettings extension that contains this infor mation You can use these settings by selecting Import publish profile and then selecting the file provided by your hoster Otherwise you can enter the settings manually uia Import publish profile recommended Import the publishsettings from your hosting providers control panel After you ve published your site you might want to make changes to it and republish it When you subsequently select Publish WebMatrix will list the local files that have been changed since the last time the local site was pub lished At this point you can select which files you want to upload to the remote stie and select Continue or cancel 36 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Publish Preview Changed Files 31 Total 860 KB w Mame Action Date modified SIZE v App Data Logs orchard error 2012 11 07 loq Add Mowember 07 1 56 PM OB v App Data Sites Default Indexes Search 2 fdx Add November 02 10 49 AM 646 App Data Sites Default Indexes Search 2 fnm Add November 02 10 49 AM 75 B App Data Sites Default Indexes Se
438. nder New enabling us to create a new customer 3 9 Extending Orchard 395 Read the Docs Template Documentation Release 1 9 2 Dashboard v Mew Customer List Page v Content Content Items Content Types Blogs gt Lists Widgets Media Navigation Comments Create Customer Name Joe Address Street Address 1 Main St City Orchard City State WA Washington WA Washington WV West Virginia WI Wisconsin WY Wyoming The customer can be displayed on the front end as well 396 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Orchard Name Joe 1 Main 5t Orchard City WA 98052 Building an N N Relationship Building a n n relationship in Orchard relies on the same principles as what we did for the 1 n relationship The main difference is that instead of having one foreign key on the part record we have an intermediary object for the relationship that has two foreign keys to the records This is of course close to the way this is done in relational databases In this section we are going to build a part that can record an arbitrary number of associations with reward programs for our customers Modeling the Rewards Part The rewards part and its association with reward programs are modeled as follows 3 9 Extending Orchard 397 Read the Docs Template Documentation Release 1 9 2 gt gt RewardsPart A RewardProgramRecord Class Clas
439. nding If you do not want to run WebMatrix with admin privileges which is not a good practice for security reasons you need to follow the steps outlined in the article Handling URL Binding Failures in IIS Express as follows 1 Open a command window that has administrative privileges In All Programs amp gt Accessories amp gt Com mand Prompt right click the program shortcut and then click Run as administrator 2 Run the following command gt netsh http add urlacl url http mydemo 28923 user everyoneThis can later be removed with the following command gt netsh http delete urlacl url http mydemos 298923 Alternatively you could run WebMatrix using admin privileges as follows Open WebMatrix with admin privileges Right click the shortcut in Windows then click Run as administra tor Finally 1 Open your site and attempt to start it 266 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 2 Locate the IIS Express icon in the taskbar and right click it You see your site name where you can select to open it via its additional URL Remember to remove the item from the hosts file or comment out the line using the character if you want to view the live site from the same domain name after you ve deployed it to an ISP You need to be very careful that you are looking at the remote site rather than the local one Consider adding something to one or other of the themes to make the dif
440. ndows Azure Cloud Service The Windows Azure Diagnostics appender is configured by default in the cloud service web role You can use Server Explorer to download and examine diagnostics data from within your deployment Additionally the Windows Azure Diagnostics appender has been improved and now logs messages with their correct severity level prior to 1 7 1 all Log4net entries were logged to Windows Azure Diagnostics as verbose messages As before when deploying to a Windows Azure Cloud Service Orchard is pre configured to use Windows Azure Blob Storage as the underlying file system implementation for shell settings the Settings txt file Unlike before using Windows Azure Blob Storage for media storage is not preconfigured but easily activated by enabling the new Windows Azure Media Storage feature Storage account credentials for these providers need to be specified in the cloud service project before deployment Visual Studio will display warning messages if you don t As before containers are created automatically in the storage service if they don t already exist 3 5 4 Deploying Orchard to Windows Azure Orchard can be deployed to both Windows Azure Cloud Services and Windows Azure Web Sites Orchard also ships with a number of integration features that takes advantage of Windows Azure services such as blob storage and caching and that can be configured before deployment if needed This topic walks you through the process of deploying Orc
441. ne before search and indexing will work Orchard Search was enabled Orchard Indexing was enabled You need to enable an index implementation module like Lucene Manage Features When the indexing feature is enabled a new Search and Indexes item becomes available under the Settings section of the dashboard The indexer runs as a background task once per minute by default and you can optionally update or rebuild the index from this screen The Indexes screen also displays the number of documents content items indexed and the Search screen displays the indexed fields Documentati n Upload screenshots 675 indexnsearch png Documentati n Upload screenshots 675 indexcreated png 3 1 Authoring Websites 127 Read the Docs Template Documentation Release 1 9 2 Upload screenshots 675 indexupdated png After enabling the Search feature goto the Content Definition section and click on any Content Type which you want to index and then check the check box for the available index For e g Page Content Type Upload screenshots 6 5 indexcontenttype png When the search feature is enabled the Settings screen in the dashboard displays the fields that will be queried from the index listed on the Search screen Upload screenshots 675 searchfield png The front end of the site does not have the searching UI yet at this point To add it you need to add a widget Click Widgets in the admin menu With the default
442. ng Seript Foot lt script type text javascript Ss function 4 S Html FieldIdFor m gt Model Date datepicker S Html FieldIdFor m gt Model Time timepickr J lt SCripc gt This template is registering a few styles and scripts note that if other parts register the same files they will still be rendered only once Then it defines the editor as a date picker and a time picker according to the field s configuration The fields are regular text boxes that are unobtrusively enriched by date and time pickers using jQuery UI plug ins To specify the order and location where these templates will be rendered within the composed page we need to add a placement info file into the root of the module s directory lt Placement gt lt Place Fields Custom DateTime Edit Content 2 5 gt Place Fields Custom Daterimee Content 2 5 s lt Placement gt Managing the Field Settings We are not quite done yet We still need to take care of managing and persisting the settings for the field Add the following DateTimeFieldEditorEvents cs file to the Settings folder using System Collections Generic using Orchard ContentManagement using Orchard ContentManagement MetaData using Orchard ContentManagement MetaData Builders using Orchard ContentManagement MetaData Models using Orchard ContentManagement ViewModels namespace CustomFields DateTimeField Settings public class DateTimeFiel
443. ng like this post As amp lt AutoroutePart amp gt Slug Fortunately you don t have to write code to have fun with types and parts We are going to look at this in more detail by way of example in the next section 132 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Defining a New Content Type Let s define a custom content type Suppose you wanted to define an Event type for listing events with location and date fields To do this in the Manage Content Types screen click on Create new type Type the name Event for the content type The Content Type Id field is automatically populated with Event which you can keep New Content lype Display Name Event Name of the type as it will be displayed in screens Content Type Id Fvent Technical name of the type Click Add to add a field 3 1 Authoring Websites 133 Read the Docs Template Documentation Release 1 9 2 Edit Content Type Event User admin Loge Edit Placement Display Name Event ent pe Id Fve ent I Ype ia EVE Creatable etermines if an instance r nter De can be create hr in the 3 1 gt A gt 4 4 L A A A Draftable Stereotype Add Field Fields i Add Parts Parts icc gt Common Provides common information about a content item such as Owner Date Created Date Published and Date Modified Remove Currently Orchard only includes a single field type TextField but more
444. ng an Installed Theme After installing a new theme you can preview enable and apply that theme to your site by clicking Themes in the dashboard For more information see Previewing and Applying a Theme Installing a Module from the Gallery To access the gallery for modules click Modules on the dashboard and then click the Gallery tab A set of modules appears with a pair of Install and Download links next to each module 3 3 Using the Orchard Gallery 159 Read the Docs Template Documentation Release 1 9 2 Modules User admin Logout Features Installed Gallery Updates 0 Feed All feeds Sort by Downloads Search Code Generation Version 1 0 20 EN Install Download Tools to create Orchard components Last Updated 1 13 2011 9 37 35 4M Author The Orchard Team Downloads 2629 Website http orchardproject net Rating wrr trir Hierarchical menu Version 1 1 0 Install Download Support for multi level hierarchical main menu Adds also the Breadcrumbs Widget RecentlySeen Widget and a MenuWidget to display independent submenus on your pages Last Updated 2 25 2011 12 13 06 AM Author Piotr Szmyd Downloads 1993 Website httpu www szmyd com pl blog using the hierarchical menu orchard module Rating ekki Email Messaging Version 1 0 20 Install Download The Email Messaging module adds Email sending functionalities Last Updated 1 13 2011 9 40 55 AM Author The Orchard Te
445. ng to do in order for the new content part to work is to write the two templates front end and admin that are configured in the driver Create the front end template first Create a Parts folder under Views and add a Product cshtml file that contains the following code lt br gt aT Price lt b gt S Model Price lt b gt lt br gt Model Sku lt br gt This is very plain rendering of the shape Notice the use of the T method call to wrap the Price string literal This enables localization of that text The administration view is a little heavier on HTML helper calls Create an EditorTemplates folder under Views and a Parts folder under that Add a Product cshtml to the Parts folder that contains the following code model SimpleCommerce Models ProductPart lt fieldset gt lt label class teub tors Sku o T sku lt 7 label gt lt br 7S Html TextBoxFor m gt m Sku new class text lt br gt label class sub rors Price 20rI Price lt label gt lt br gt Html TextBoxFor m gt m Price new class text lt fieldset gt Add those two templates to the csproj file using the following lines Content Include Views Parts Product cshtml gt Content Include Views EditorTemplates Parts Product cshtml gt 356 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Putting it All Together into a Content Type The content pa
446. nifest such as Contoso Theme If you do not provide a name in the manifest the ID is used instead If you do provide a name it will be used as the theme s display name in the Orchard Gallery and in the Orchard UI Description A brief summary of a theme s appearance and layout details The description is used in the Orchard Gallery and in the Orchard UI Version The version number of a theme The version information is displayed in the Orchard Gallery and the Orchard UI and is also used to determine whether an update is needed Author The developer of a theme This can be an organization individual or a list of individuals Website The URL for the website of the theme developer Tags A comma separated lists of tags for the theme The tags can be used to filter or group themes in a list For example a custom online gallery of themes can provide the ability to filter and display themes by tag Zones A comma separated 420 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 list of the Orchard zones that are used by a theme These zones are displayed in the Orchard dashboard and can be used to customize the layout of a site by adding removing or arranging widgets BaseTheme The ID of another theme that this theme inherits from This is an optional field It is useful in cases where you want to customize an existing theme by copying it and then making some changes in style and appearance When you use this approach
447. njection When you want to get access to one of Orchard s service classes you need to add a reference to the class to the default constructor However instead of requesting the class directly you will always work with the interface that the service you want implements The advantage of dependency injection is that you don t depend on concrete implementations the actual class Work ing with an interface means that you or a module can swap out the implementation of a specific class if it needs to By always working with an interface instead of the actual service it means you don t need to know which particular implementation you are working with preventing you from being tied to it So if you wanted a copy of the content manager then you would request IContentManager contentManager in your constructor The standard process for incorporating a new service into the class is as follows you don t need to do this now 320 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 1 Create a new private read only variable to hold the injected class It should start with an underscore like Content Manager 2 Update the default constructor to include the service as a parameter 3 Assign the injected class to the private variable for later use We will use this three step theory in the next section Implementing CurrentContent Based on the service requirements in our demo implementation above of the Current Content pro
448. nt class ContentPartRecord also includes a property named id and a reference to the content item object Therefore an instance of the MapRecord class includes not just Latitude and Longitude but also the id property and the content item object that is used to maintain the relationships between the part and other content When you define a content part you use the record as shown below namespace Maps Models public class MapPart ContentPart lt MapRecord gt Required public double Latitude get return Retrieve r gt r Latitude set Store r gt r Latitude value Required public double Longitude get return Retrieve r gt r Longitude set Store r gt r Longitude value Notice that only data that s relevant to the part is defined in the MapPart class You do not define any properties that are needed to maintain the data relationships between MapPart and other content For a complete example of the MapPart see Writing a Content Part You can also read the Getting Started with Modules course to familiarize yourself with the overall concepts of module development Data Migrations Creating the record class does not create the database table it only creates a model of the schema To create the database table you must write a data migration class A data migration class enables you to create and update the schema for a database table The code in a migration class is executed when an
449. nt part This way the comment management module can be developed only once and apply to arbitrary content types including those that the author of the commenting module did not know about Parts themselves can have properties and content fields Content fields are also reusable in the same way that parts are a specific field type will be typically used by several part and content types The difference between parts and fields resides in the scale at which they operate and in their semantics Fields are a finer grain than parts For example a field type might describe a phone number or a coordinate whereas a part would typically describe a whole concern such as commenting or tagging But the important difference here is semantics you want to write a part if it implements an is a relationship and you would write a field if it implements a has a relationship For example a shirt is a product and it has a SKU and a price You wouldn t say that a shirt has a product or that a shirt is a price or a SKU From that you know that the Shirt content type will be made of a Product part and that the Product part will be made from a Money field named price and a String field named SKU Another difference is that you have only one part of a given type per content type which makes sense in light of the is a relationship whereas a part can have any number of fields of a given type Another way of saying that is that fields on a part are a dic
450. ntentType Example template Widget BlogArchive For fields e ShapeType FieldName Example template FieldsNCommon Text Teaser e ShapeType PartName Example template FieldsNCommon Text TeaserPart e ShapeType ContentType PartName Example template FieldsNCommon Text Blog TeaserPart e ShapeType PartName FieldName Example template FieldsNCommon Text TeaserPart Teaser e ShapeType ContentType FieldName Example template FieldsNCommon Text Blog Teaser e ShapeType ContentType PartName FieldName Example template FieldsNCommon Text Blog TeaserPart Teaser For content parts e ShapeType Id Example template Parts NCommon Metadata 42 e ShapeType ContentType Example template Part sNCommon Metadata BlogPost You can use the Shape Tracing module to generate alternate templates through the Shape Tracing user interface For more information see Customizing Orchard using Designer Helper Tools URL and Widget Alternates The URL Alternates module enables you to create templates for specific URLs and the Widget Alternates enables additional alternates for widgets of certain types and in specific zones You must enable the URL Alternates and Widget Alternates modules in order to use their features When enabled alternate shapes are created based on the URL or the zone These URL alternates are combined with the alternate patterns defined above For example the URL my blog post 1 has a
451. ntentTypeSettings Draftable True TypeIndexing Included true gt lt CommentsPart gt lt TagsPart gt lt LocalizationPart gt lt BlogPost gt lt Types gt SParvs lt BodyPart BodyPartSettings FlavorDefault html gt lt Parts gt lt Metadata gt lt Secrerngse A gt Migration features x gt lt Command gt layer create Default LayerRule true layer create Authenticated LayerRule authenticated layer create Anonymous LayerRule not authenticated layer create Disabled LayerRule false layer create TheHomepage LayerRule url layer create Blog LayerRule rl Bilog layer create Maps LayerRule url Maps page create 7S91lugi welcome to orchard rirtle Welcome to Orchard Path welcom Diog Create Slug blog Titles Blog Homepage false ZDesScripElomn Thuzs as your page create Slug maps Title Bing Maps Path bing maps Homepage false P widget create HtmlWidget Title First Leader Aside Zone TripelFirst Position widget create HtmlWidget Title Second Leader Aside Zone TripelSecond Positi widget reste HbmlwWidget 7 Title Third Leader Aside fone Ieipelrhwed JPosstaon menuitem create MenuPosition 1 MenuText Home Url OnMainMenu true menuitem create MenuPosition 2 Men Text Blog Url Blog OnMainMenu tru menuitem create MenuPosition 3 MenuText Maps Url
452. o as many role instances as you need and things will be handled NOTE If you set the instance count to more than 1 before deploying you must now restart all role instances once to make sure they pick up the new configuration Deploying Orchard to a Windows Azure Web Site Deploying to a Windows Azure Web Site is also done using the Windows Azure tooling in Visual Studio However instead of using the Orchard Azure sin as described for Windows Azure Cloud Services above for a Windows Azure Web Site we use the normal Orchard sln solution and publish the normal Orchard Web project As with a cloud service if you only plan to run a single instance deploying is extremely simple The steps for using Windows Azure SQL Database as the database are the same as for a cloud service create a Windows Azure SQL database beforehand and specify its connection string during setup 250 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Start by opening the Orchard sln solution in Visual Studio Right click the solution node in Solution Explorer and select Rebuild This step is necessary to get all modules and themes compiled thereby having their resulting DLL files included in the published package compilation of modules and themes does not happen automatically since they are not referenced by the Orchard Web project being published To deploy the web site right click the Orchard Web project in Solution Explorer and sel
453. o overwrite it Most themes can just fall back to the version of the file that can be found in the SafeMode theme under Views The Document cshtml file is responsible for the HTML that goes around the body element This means it defines the doctype element Orchard assumes the HTML5 document type the htm1 element the head element where it defines the head zone where the meta tags some script elements and the links for style sheets to be inserted This is different from the Header zone which is the top zone in the body The Document cshtml file also contains the title element inside the head element Finally the file defines the body element where the Body and Tail zones are rendered Layouts Layouts are the outermost shape that is rendered within the body element For example this is typically where you define the main widget zones You can read about the details of the markup inside of a layout in the Markup section later in this document A theme can contain any number of layout files even though currently only one is supported and included in the TheThemeMachine theme namely Layout cshtml For example a theme can add specialized layouts such as Layout Blog cshtml or Layout HomePage cshtml that would be used instead of the default for a blog or for the homepage provided there is an extension providing those layout shape alternates Notice that layouts are named Layout layout name cshtml Each layout can have a different set of z
454. o perform all of the Same operations on the package that you can perform including deleting your package from the gallery Also anyone with ownership rights to your package can upload additional versions of this package to the gallery Manage Owners for Package Orchard Module TestPackage Current Owners amp bradmi amp Bertrand Le Roy X Remove Add New Owner Enter an owner s username to add them as a package owner se pasten gs Add Registering a Package ID in Advance You may want to register a package ID ahead of time because you want to claim the name of an idea before you ve implemented your module or theme You can do this from the Contribute tab of the site ORCHARD ROME JOIN LIS OM lE B Orchard gallery Home Modules Themes Contribute A Saar ri Contribute to Orchard Gallery Add New Module or Theme Upload and publish your package for other Orchard users to download and enjoy You can upload Get Started multiple revisions of the same package as long a the version is different LL E Is your module the best Manage My Contributions thing since sliced bread Is your theme going to start a revolution Create an account and contribute Echt zonbribustings Register Package Id Grab a here names Tor Voie MOULE mat yeu intend ba up eui Already have an account Sign in and contribute 3 3 Using the Orchard Gallery 177 Read the Docs Template Documentation Release 1
455. o use the conventional brace styling Private fields are prefixed with an underscore and camel cased Using directives appear before the namespace not inside it 496 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 JavaScript Coding Conventions Namespaces are Pascal cased Class names are Pascal cased e Plugin names are Camel cased Properties fields local variables are Camel cased e Parameters are Camel cased Function names are Camel cased unless they really are class constructors or namespaces in other words global local functions and methods are Camel cased Private internal protected members are underscore prefixed and Camel cased Constants are just static fields apply same rules as for fields JavaScript coding conventions follow C conventions except for Pascal vs Camel e and are interchangeable strictly equivalent XHTML attributes should be in double quotes and if code needs to be in there it has to use single quotes ex note this kind of DOM 0 event creating is itself discouraged and is only shown here as an example In pure JS code use double quotes for string delimiters When the string is one character and the intent is a character use single quote for consistency with managed code 6699 e There is no need for String Empty just use Localizable strings need to be isolated into resource dictionaries until we figure out our client localiza
456. oard and click Modules Select the Features tab find the SimpleCommerce module and click Enable Modules Features Installed Gallery Updates 0 Uncategorized SimpleCommerce 3 9 Extending Orchard 357 Read the Docs Template Documentation Release 1 9 2 To add a new Product content type click Content on the dashboard select the Content Types tab find Product and click Create New Product Your Site Mana ge Content Types User adimin Logout Content Items Content Types Blog Edit Blog Archives Edit Blog Post Edit Comment Edit Container Widget Edit Html Widget Edit Layer Edit List List ems Edit Create Mew Lest Menu Item Edit Page List Items Edit Create Mew Page Product List Items Edit Recent Blog Posts Edit You now have a product editor that features your Sku and Price fields The code for this module can be downloaded from the following page Orchard Module SimpleCommerce 0 5 0 zip 3 9 7 Writing a Content Part This guide has been marked for review If you are just getting started with Orchard module development you should read the Getting Started with Modules course first It will introduce you to building modules with Orchard using Visual Studio Community a free edition of Visual Studio This tutorial walks through the process of creating a new content part from scratch using the scaffolding feature in Orchard as a productivity tool Although this tutorial assumes development in Visual St
457. odegen datamigration lt feature name gt Create a new Data Migration class codegen module module name IncludeInSolution true false Create a new Orchard module codegen theme theme name CreateProject true false IncludeInSolution true false Bas Create a new Orchard theme codegen moduletests lt module name gt Create a new test for a module 284 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 For a walkthrough of using the code generation feature to create a new module and data migration read the Getting Started with Modules course Change History Updates for Orchard 1 8 9 04 14 Updated the screen shots for Code Generation Module 3 9 4 Getting Started with Modules Part 1 Getting Started with Modules Introduction This four part course will get you started with a gentle introduction to extending Orchard at the code level You will build a very simple module which contains a widget that shows an imaginary featured product It will teach you some of the basic components of module development and also encourage you to use best practices when developing for Orchard In this first part we are going to set up our dev environment scaffold a module and then build a simple Widget inside it Prerequisites This course assumes the following You have some experience using Orchard and understand its core concepts Refreshers and links to related guides will be provided e
458. oduct IsOnFeaturedProductPage isOnFeaturedProductPage EF protected override DriverResult Editor FeaturedProductPart part dynamic shapeHelper return ContentShape Parts FeaturedProduct Edit gt shapeHelper EditorTemplate TemplateName Parts FeaturedProduct Model part Prefix Prertix protected override DriverResult Editor FeaturedProductPart part IUpdateModel updater dynamic shapeHelper updater TryUpdateModel part Prefix null null return Editor part shapeHelper Trying the module out in Orchard This is the part where it all pays off If you run Orchard in the browser you will see the updates we have been working on in action 1 Within Visual Studio press Ctr1 F5 on your keyboard to start the website without debugging enabled it s quicker and you can attach the debugger later if you need it 2 You will start off on the homepage The widget should look the same as it did at the end of part two 1 Attachments getting started with modules part 3 testing homepage png 1 Click on the Sprocket 9000 menu item to go to your product page You should see a purple notification box instead of a link 328 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Attachments getting started with modules part 3 testing sprocket png 1 If you followed the Bonus Exercise section and created additional demo product pages you can also navigate to those and you
459. oductPart with the bool IsOnSale property This is the same shape factory we used in our Display method the first time around For editor views you use the EditorTemplate method and pass in the configuration val ues By default Orchard places all of its editor views in the EditorTemplates folder Com bining this with the TemplateName parameter we know that we will be creating a view called NViewsNEditorTemplatesNPartsNFeaturedProduct cshtml in the next section The Model parameter passes in the data in our case a data structure that includes the IsOnSale value This will be accessible inside the Razor view and we will use it to determine what to display The Prefix is a text value that is prepended to the names of the shapes internally This makes sure that the names are unique The Prefix value that we supply is a method that comes with deriving from ContentPartDriver that just uses a typeof to get the name of the class protected virtual string Prefix get return typeof TContent Name J In more complicated projects this method can combine multiple shapes together and return them as a single CombinedShape The second overload of the Editor method is used when the administrator submits a page that has the EditorTemplate form inside it You can see the bare minimum code here which just attempts to pass the form data to the correct internal model As long as it doesn t have any errors the model will then be persisted to the data
460. odule Theme extensionName For example package uninstall Orchard Module SampleModule will uninstall the Modu package uninstall Orchard Theme SampleTheme will uninstall the Theme under the user create UserName username Password password Email lt email gt Creates a new User By running the package create command you can create a zip file of a module orchard package create Lucene C Temp Package C Temp Orchard Module Lucene 1 0 0 nupkg successfully created Orchard uses the NuGet packaging format to create module packages basically zip files with extra metadata in formation about your package NuGet is based on the OPC packaging format which you can learn more about at http en wikipedia org wiki Open Packaging Conventions Once you ve created a module package you can share it easily with others Orchard provides the ability to browse and install a module from the Modules section of the Orchard admin panel Refer to the Installing and upgrading modules topic for more details Additionally Orchard provides a Gallery feature that can register one or more gallery feeds of module extensions OData format Users can easily install modules from any registered feed A default gallery feed is exposed from this website at http packages orchardproject net FeedService svc For more information refer to the Module gallery feeds Module gallery feeds topic You can visit the Gallery admin panel m
461. ody headings links and any other elements where you want to apply a different style and override the reset This can include styles for elements like lt ul gt lt p gt etc Structure Layout definitions for major structural components of your templates such as containers headers footers etc This section can be subdivided with comments into sections such as navigation header etc Main Main styles related to your theme This can contain definitions for blog posts tags etc Secondary Secondary styles related to your theme for things like stylized text errors etc Forms All styling related to form items Creating Themes 475 Read the Docs Template Documentation Release 1 9 2 11 Mise Miscellaneous definitions that are needed to render the look of your template The following example shows this structure applied to a CSS file x Theme My Sample Theme Author Copy r1gnt Colors Palette Background 4 fff Text 4434343 Main Accent 999 Links 443444 x Reset KK KK KK KK KK KK KK KK KK KK KK KK KK KK KK KK KK KKK KK KKK KKK KKK KEK KEK KKK KKK KEK YOUR C55 RESET CODE GOES BERE Lec Clearing Float ck ckckckckckckckckckckockckckckckockckokckokckokckockockockckckckckokckokckokckokckckckckckckokckokckck ck ck ckckckck ck ck ck ck kc k ck group after CONCERNE Vrs ar display block height 0 clear both visibility hidden group tdisplay znline block
462. ok of existing content modules This is what the designer would typically create All the above A module can have many extensions content types widgets and themes all in one package Orchard is designed to be highly extensible this means that almost anything that you interact with can be extended replaced or disabled Out of the box Orchard comes with a number of modules to provide a good user administrator experience but a designer developer can change them or create more It is also possible to share your modules with the Orchard community and to install modules developed by others Orchard comes with only one theme called The Theme Machine However it has enough zones to allow various arrangements This is important because a site can only have one theme active at a time This means the theme must be flexible enough to allow pages to have different layouts If you are not satisfied you can copy it and add more zones The Orchard Gallery contains a lot more themes and modules ready to install Make sure to browse it to find out what extra features are available Content In order to fill your website Orchard allows you to edit and display content It comes with the ability to create pages and blog posts out of the box But it also allows you to define your own content This is important because you may want to have events or profiles or anything else that isn t supported out of the box This section explains the various elements tha
463. oml method intact 3 Copy the AlterPartDefinition call from UpdateFrom2 to the Create method so that your Create method now looks like this public int Create Featured Product Widget ContentDefinitionManager Alter TypeDefinition FeaturedPro ductWidget cfg gt cfg WithSetting Stereotype Widget WithPart typeof FeaturedProductPart Name WithPart typeof CommonPart Name WithPart typeof WidgetPart Name Featured Product Part ContentDefinitionManager AlterPartDefinition typeof FeaturedProductPart Name part gt part WithDescription Renders information about the featured product Featured Product Part Record SchemaBuilder CreateTable typeof FeaturedProductPartRecord Name table gt table ContentPartRecord Columnebool LsOnSale return 1 j Leave the original UpdateFrom2 method intact 4 Update the Create methods return value from return 1 toreturn 3 Your Migrations cs file should now look like this using Orchard ContentManagement MetaData using Orchard Core Common Models using Orchard Core Contents Extensions using Orchard Data Migration using Orchard LearnOrchard FeaturedProduct Models using Orchard Widgets Models namespace Orchard LearnOrchard FeaturedProduct public class Migrations DataMigrationImpl public int Create Featured Product Widget ContentDefinitionManager AlterTypeDefinition FeaturedProduct widget cig gt
464. on 6 After a short pause while it loads you will then be presented with the Orchard command line 288 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 EA rtpSoftware OrchardCMS OrchardModuleCourse src Orchard Web bin Orch Initializing Orchard session Ihis might take a few seconds 3 ype FU For help exit to exit cls to clear screen rchard Note There is a separate article where you can learn more about orchard exe and its features You don t need to read it to understand this course but it will be useful to review in the future as part of your overall training 7 Type the following command feature enable Orchard CodeGeneration and press enter orchard feature enable Orchard CodeGeneration Enabling features Orchard CodeGenerat ion ode Generation was enabled Fc hard gt This will activate the code generation features of orchard exe Note If you get an error saying No command found matching arguments feature enable Orchard CodeGeneration then you didn t follow the steps in the setting up for a lesson guide You need to run the solution and go through the Orchard Setup screens before this command is available The code generation command that we will be using is codegen module 8 Type help codegen module and press enter to see the syntax for this command To see details about all of the commands available type help commands Like the rest of Orchard CMS the or
465. on The widgets in this la Site setting set baseurl menu create MenuName Main Menu page create Slug welcome to orchard Title Welcome to Orchard Path welcome menuitem create MenuPosition 0O MenuText Home Url MenuName Main Mei widget create MenuWidget Title Main Menu RenderTitle false Zone Navigation theme activate The Theme Machine lt Command gt lt Orcnard gt The following sections of a recipe file are the elements that are most important to understand Recipe This section contains metadata about the recipe such as its name and description Feature This section lists module features that Orchard will enable Metadata This section provides configuration for the types parts and fields that Orchard contains e Settings This section provides a way to configure website settings Command This section lists commands that Orchard will run against your website in order to complete the setup For more information about Orchard commands see Using the Command line Interface Creating a Custom Recipe You can create your own recipe which can then be added to the setup page or to your own module Recipes added to the setup page can be selected by the user only during site setup recipes added to a module can be executed by the user after site setup To get started with creating a custom recipe you can select an existing recipe that you can tailor to your purposes The following e
466. one the module txt is a text file you will find in the root of your module folder We have already looked at this file briefly in this course each time we have added dependencies When Orchard is scanning the folders looking for modules to load it will parse this file to get information about it The module txt is a manifest file Technically the document is in YAML format If you open it now you will see the following Name Orchard LearnOrchard FeaturedProduct AntiForgery enabled Author The Orchard Team Website http orchardproject net Version 1 0 OrchardVersion 1 0 Description Description for the module Pealures Orchard LearnOrchard FeaturedProduct Description Description for feature Orchard LearnOrchard FeaturedProduct The Name field at the top is a friendly text name that s displayed to the user For example the Name field for the module in the screenshot below reads Dynamic Forms Validation Activities Dynamic Forms Validation Activities Enable Adds activities for form validation Depends on Cf Scripting Dynamic Forms AntiForgery enables the XSS injection protection so you should have this set to enabled unless you have a specific reason to manage this yourself The file format is quite straightforward The fields mean what you would expect them to mean Version Is the version of the module OrchardVersion is the version of Orchard that this module was written against Features is the only complicated one W
467. one in a predefined list of choices That is a 1 n relationship A n n relationship could be for example a list of commercial rewards that a customer can benefit from Orchard does of course provide support for those scenarios This topic is going to walk you through the creation of such contents Building a 1 N Relationship The model that we re going to build here consists of an Address part that can be attached for example to a Customer content type The address part has a street address a zip code a city name and a state The state is what we are going to model as a 1 n relationship to a table of states Note this is clearly over normalized as a state in an address would usually be sufficiently well represented by a simple two letter state code The UI can then take care of representing the choice of that code as a constrained choice in a list of states We are not claiming what we are building here is the correct way to represent a state in an address but that the process exposed here is representative of what you d follow to build a real world 1 n association in Orchard Modeling the Address Part Here is the code for the Address part using Orchard ContentManagement namespace RelationSample Models public class AddressPart ContentPart lt AddressPartRecord gt public string Address get return Retrieve r gt r Address set Store r gt r Address value public string City Y get return Retrieve r gt r City
468. ones organized differently in markup 444 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 For an example of how your own modules and themes can provide alternative layouts based on custom criteria see Switching the Layout in Orchard CMS Shape Templates In Orchard before a web page is rendered into HTML it is built as a tree of shapes Shapes are flexible objects that represent the objects that will contribute to the rendering of the page Examples include zones menus menu items and widgets Each shape can be rendered by a template which can be overridden by a theme Templates have the same name as the shape they are made to render For example if Menu cshtml exists it is used to render a Menu shape The TheThemeMachine theme has two shape templates BadgeOfHonor and Branding which are built from Layout cshtml and injected into the Header and Footer zones using the following code Site name and link to the home page WorkContext Layout Header Add New Branding 5 Powered by Orchard WorkContext Layout Footer Add New BadgeOfHonor 5 Note Templates are one of two ways to render shapes In addition to templates you can define the rendering using code by defining a method that has a Shape attribute Look for the CoreShapes cs file for examples This is usually done in modules but themes can do it as well Item Templates Themes can override how content items are rendered
469. ontinue with your module development you will come across these files many times over Before long you will start recognizing these core files and you will see how it all fits together Course structure Throughout the course we will alternate between discussing topics and implementing them The discussion may contain example code or other example scenarios So that there is no confusion for you as to what you should be doing when it comes to implementing these lessons into the module it will be explained step by step via numbered lists Later on in the course as the topics become more advanced we may go through several sections of discussion before wrapping up the lessons into changes to the codebase You will also occasionally come across Bonus Exercise sections These are completely optional You can skip them complete them at the time or come back after completing the course to complete them They are suggested when there is an extra feature you could implement using the skills you have just learned Getting started Now that you ve completed all of the setup tasks you will have a fresh copy of Orchard configured and ready to go The rest of this part of the course will walk you through the process required to scaffold an empty module and then build a simple Widget inside of it Command line scaffolding with Orchard exe You should now be looking at Visual Studio Down the side in your Solution Explorer window you will see many
470. ontrollers in Orchard you need to add a version of the view file in your theme s Views folder For example if you want to customize the search results page of the Orchard Search module Orchard Search you need to add a file in the following folder of your theme Themes Your theme Views Orchard Search Search Index cshtml 3 11 Creating Themes 461 Read the Docs Template Documentation Release 1 9 2 This file will override the default view used by the Orchard Search module The ViewEngine used by Orchard will look for the following pattern when resolving MVC views e Themes Active theme Views Area Controller View cshtml e Themes Active theme Views Controller View cshtml e Themes Active theme Partial cshtml e Themes Active theme DisplayTemplates TemplateName cshtml e Themes Active theme EditorTemplates TemplateName cshtml Please be aware any other convention that is normally supported in MVC is not supported within a theme Unless specified in the list above Adding Alternates Through Code In addition to methods described above for adding alternates you can add alternates through code To designate an alternate through code you create a class that implements the IShapeTableProvider interface Then you add a handler for OnDisplaying for each type of shape that needs an alternate You specify the shape name as the parameter for the Describe method on the ShapeTableBuilder
471. ooting your system This way you will be sure that all the required services are started from scratch When the system restarts download the Orchard Web l x xx zip file from here Extract the zip file to your Desktop The extracted folder contains several files and an Orchard folder Copy the Orchard Folder to C NnetpubNwwwrootN In Windows Explorer go inside the Orchard Folder Let s start with App Data folder This folder is where Orchard stores site settings Right click App Data folder click Properties and using the Security tab set modify and read permissions for the S TUSRS user Then repeat the same procedure for the following folders Modules This is required if you want to install modules from the gallery We recommend that you remove the read write permissions for production sites e Themes This is required if you want to install themes from the gallery We recommend that you remove the read write permissions for production sites Media This folder is where Orchard stores media files images etc 1 2 Manually installing Orchard from a zip file 11 Read the Docs Template Documentation Release 1 9 2 ii 2 B Orchard 2 F wo Cy Search Orchard P Di nbus sumam cd f nd Tasa Comin k App Data Properties General Sharing Securty Customize Favorites BE Desktop Jp Downloads E Recent places Js Config m vu de Permissions for App_Data lj Homegroup E
472. orcheckbox gt T Display options lt label gt select id Html FieldIdFor m gt m Display name Html FieldNameFor m gt m Display gt Html SelectOption DateTimeFieldDisplays DateAndTime Model Display DateTimeFieldDisplays DateAndTime T Date and time ToString Html SelectOption DateTimeFieldDisplays DateOnly Model Display DateTimeFieldDisplays DateOnly I Date oniy Tostring Html SelectOption DateTimeFieldDisplays TimeOnly Model Display DateTimeFieldDisplays TimeOnly T Time only TOstring lt select gt aHtml ValidationMessageFor m gt m Display fieldset This template creates a label for the setting and then a drop down that enables the site administrator to pick one of the options for the setting Updating the Project File If you are using Visual Studio you should skip this section as your project file has already been updated provided you saved all CTRL SHIFT S Otherwise in order for the Orchard dynamic compilation engine to be able to pick up our new module s cs files we need to add them to the CustomFields csproj file Find the Content Include Properties AssemblyInfo cs gt line in CustomFields csproj If you look at it then you will see that this is inside an lt ItemGroup gt element After that end ItemGroup for that section add in this code lt ItemGroup gt lt Compile Include Drivers DateTimeFieldDriver cs gt lt Compil
473. ore link at the end of the post content Your Site Home About Us Blog Our Blog Friday April 25 2014 8 25 51PM A blog for your website My first post Tags first post Orchard team Friday April 25 20148 26 40PM No Comments This is my first blog post more Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard 82 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 1 7 3 Add a comment to the post Because comments were enabled for the post a new comment can be entered The comment may not appear imme diately after it is submitted That is because Orchard has a setting which requires the site administrator to approve comments before they are published Your Site Home About Us Blog My first post Tags first post Orchard team This is my first blog post No Comments Hi admin Comment My comment Return to the Orchard dashboard and under Settings click Comments There are two options which effect how comments are handled One to require administrator approval before a comment is published and another option for enabling automatic closing of comments for old posts For more details about these features see the Moderating Comments topic Note There are several good modules in the Orchard Gallery to enable spam protection in your blog 1 7 Adding a Blog to Your Site 83 Read the Docs Template Documentation Release 1 9 2 e Your Site Setting
474. oreach var state in states _stateRepository Create state 3 9 Extending Orchard 389 Read the Docs Template Documentation Release 1 9 2 fertum 2 The Address Part Handler The handler for the address part is rather uninteresting and just wires up the repository using Orchard Data using Orchard ContentManagement Handlers using RelationSample Models namespace RelationSample Handlers public class AddressPartHandler ContentHandler public AddressPartHandler IRepository lt AddressPartRecord gt repository Filters Add StorageFilter For repository The Address Part Driver The driver is more interesting as it prepares the shapes for rendering and handles posted back admin forms using JetBrains Annotations using Orchard ContentManagement using Orchard ContentManagement Drivers using RelationSample Models using RelationSample Services using RelationSample ViewModels namespace RelationSample Drivers UsedImplicitly public class AddressPartDriver ContentPartDriver lt AddressPart gt private readonly IAddressService addressService private const string TemplateName Parts Address public AddressPartDriver IAddressService addressService addressService addressService protected override string Prefix get return Address protected override DriverResult Display AddressPart part string displayType dynamic shapeHelper return ContentShape Parts_Address
475. ository lt ContentRewardProgramsRecord gt _contentRewardRepository public RewardService IRepository RewardProgramRecord rewardProgramRepository IRepository ContentRewardProgramsRecord contentRewardRepository rewardProgramRepository rewardProgramRepository contentRewardRepository contentRewardRepository public void UpdateRewardsForContentItem ContentIlItem item TEnumerable lt RewardProgramEntry gt rewards var record item As lt RewardsPart gt Record var oldRewards _contentRewardRepository Fetch r gt r RewardsPartRecord record 3 9 Extending Orchard 403 Read the Docs Template Documentation Release 1 9 2 var lookupNew rewards Where e gt e IsChecked Select e gt e RewardProgram ToDictionary r gt r r gt false Delete the rewards that are no longer there and mark the ones that should stay foreach var contentRewardProgramsRecord in oldRewards if lookupNew ContainsKey contentRewardProgramsRecord RewardProgramRecord lookupNew contentRewardProgramsRecord RewardProgramRecord true else _contentRewardRepository Delete contentRewardProgramsRecord Add the new rewards foreach var reward in lookupNew Where kvp gt kvp Value Select kvp gt kvp Key _contentRewardRepository Create new ContentRewardProgramsRecord RewardsPartRecord record RewardProgramRecord reward 22 public IEnumerable lt RewardProgramRecord gt
476. ources that have been added I have used the word resources so far when describing this feature This is because you can use it for managing both scripts and style sheets Each resource is assigned a plain text name This can then be used in the view and it can also be used if another resource needs to depend on it This class is normally found in the ResourceManifest cs file in the root of your module folder but as long as your class implements the TResourceManifestProvider interface then Orchard will pick it up The example code below is a shortened version of the Orchard Layouts ResourceManifest cs file using Orchard UI Resources namespace Orchard Layouts public class ResourceManifest IResourceManifestProvider public void BuildManifests ResourceManifestBuilder builder var manifest builder Add manifest DefineScript Layouts Lib oOepU L C indo mse Tet hy Eso eae T aoetbependeneres 3Ouerytt s manifest DefineScript Layouts Moders SECU CL Models Min Js yr Moders Ja SetDependencies jQuery Layouts Lib You can see that a few of the features of the resource manifest are being used here The first script called Layouts Lib uses SetUrl to set up minified live and unminified debug filenames for the resource It also sets a dependency on a resource called jQuery This is a common feature that you will see throughout many Orchard modules The jQuery resource comes from the Orch
477. out the Orchard command line interface see Using the command line interface Change History Updates for Orchard 1 8 9 07 14 Updated all the screen shots for Enabling Disabling feaures 3 4 2 Using the Command Line Interface Orchard provides a command line interface for performing many of the functions that are available from the admin panel and some that aren t The command line tool is named orchard exe and is located in the bin directory underneath to root of your site To run the command line tool first open a command prompt on the root of the site i e Orchard Web This can be done for example by SHIFT right clicking on the folder in Windows Explorer and choosing Open command window here From there type binvorchard exe Note that you need to run this tool from the root of your site Using Commands fw Select Administrator Visual Studio Command Prompt 2010 bin orchard exe C OrchardHgDevS sre 0Orchard Web gt bin orchard exe Initializing Orchard session This might take a few seconds Type for help exit to exit cls to clear screen To view a list of available commands type help commands at the prompt 3 4 Managing Websites 183 Read the Docs Template Documentation Release 1 9 2 orchard gt help commands List of available commands help lt command gt Display help text for lt command gt help commands Display help text for all available commands setup SiteName
478. ow used instead of custom MSBuild logic Configuration transform files are visible and editable directly in Solution Explorer visualized as child items of the Web config Host config and Log4net config files and therefore much more discoverable and maintainable See the topic Deploying Orchard to Windows Azure topic for more information Windows Azure SDK 2 1 All Azure specific solution and project files have been migrated to Windows Azure SDK 2 1 You will need to install Windows Azure SDK for NET VS 2012 2 1 using Web Platform Installer to open the Orchard Azure sin solution and to package and publish Orchard to Windows Azure All code that reads settings from Azure role configuration has been updated to use the new platform agnostic Cloud ConfigurationManager class so settings are now read from either Windows Azure Cloud Service role configuration Windows Azure Web Site configuration settings or the Web config lt appSettings gt element All code that uses Windows Azure Blob Storage has been migrated to use version 2 0 of the Windows Azure Storage Client The Azure specific solution Orchard Azure sln has been brought up to date with main solution Orchard sin in terms of project structure etc All referenced assemblies from Windows Azure SDK has been placed in the 1ib folder and are now referenced from there This avoids having to install Windows Azure SDK just to compile and run Orchard from the main solution Orchard sin N
479. p of an overall description of the package itself and then an optional repeating section describing each of the individual features The module can be comprised of a default single feature or a group of individually defined features This allows module developers to specify separate areas of the module and allow users to enable them on a per feature basis Main module txt fields Some of the fields may be overridden if a module defines multiple features These are detailed in the Features sub section fields table below Field Name Description Name OptionalProvides a human readable name for a module If a name is provided it will be used as the module s display name in the Or chard Gallery and in the Orchard ULIf a name is not provided in the manifest the ID is used instead Note The ID of a module is generated internally from the name of the module s folder and is used for programmatic references to the module For example if the module is located in Modules Bing Maps its ID would be Bing Maps To make things more friendly to the end user module developers should provide a name in the manifest such as Bing Mapping Component or even Bing Maps notice that the is removed Path OptionalProvides a name that is used to build more readable URLs for routing purposes compared to URLs that are based on module names or ID values If a path is not
480. package as long ac the version is different Is your module the best Manage My Contributions thing simce sliced bread Is a Ect conbtnbution detadc or emos contributions that yeu have pricurly uploaded Your theme going to start a revolution Create an Register Package Id account and contribute Grab a tera name Tor your module tial you intend bo upheld Already have an account Sign in and cantribute Uploading a package is done in three simple steps Upload a package file or specify a remote URL to the package file 2 Enter the details about your package description tags license etc 3 Specify an optional logo and or screenshots Specifying a Package File In the first step you will be asked to specify a package file either by uploading from your local computer or by a specifying a URL 172 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 ORCHARD HOME IOM uso El iE A a AE Orchard gallery i beade MPACCOUNT SIGH OUT De co EE New Contribution p Upload a package file from my local computer Submit a URL to a package file bocated on my web site 7 Submit your theme or Browse module for others to enjoy To upload a package file browse for a nupkg file on your local computer that you created using the Orchard command line utility You can also specify a URL to a package file if you have published it elsewhere For example if you have rel
481. panel many people prefer to author posts using a client application such as Windows Live Writer These clients use an XML RPC interface to publish posts remotely and offer additional capabilities like saving offline drafts for example to write your blog posts on an airplane and sync up your site later To enable Remote Blog Publishing click Features in the Orchard admin panel To use Windows Live Writer with Orchard you need to enable the Remote Blog Publishing feature To enable Remote Blog Publishing click the Enable link on the feature box Note that if you haven t already created a blog on your site you ll want to do so 105 Read the Docs Template Documentation Release 1 9 2 Your Site ur r E Dashboard Mew Content Blogs Comments Lists Widgets Media Navigation Tags Themes Users v Configuration meatures Modules Settings Reports Manage Features Content Blogs Depends on Common Feeds jQuery Routable Shapes Widgets Disable Lists Depends on Containers Contents Content Publishing Remote Blog Publishing Depends on Blogs Xmifpc Developer Code Generation Enable Input Editor Tinyhice Disable Disable Enable Containers Depends onc Contents Routable Pages Disable Depends ae Contents XmlRpc Enable Now launch Live Writer from your Start menu in Windows 106 Disable User admin Logout Content Types Depends on Contents Publish Later
482. pboard s Layout cshtml i 4 Orchard CMS App Data 3 Inserting some ad hoc shapes bin XXX EL ERE EE TES SEE E ETE ETE EEE EER EET EAE EEE TET TA ee Contig Core WorkContext Layout Header Add New Branding 5 Site name and Media 7 WorkContext Layout Footer Add New BadgeOfHonor 5 Powered by Modules 5 WorkContext Layout Footer Add New User 10 Login and dashboa s zr Themes Last bit of code to prep the layout wrapper SafeMode Pee ee ee ee ee TheAdmin T a TheThemeMachine Model Id layout wrapper Styles var tag Tag Model div using Tag so the layout div gets the Views _ BadgeOfHonor cshtn i tag StartElement F Branding cshtml Bit Model Header null F Saal i8 El header id layout header class group gt E lt div id header gt m Pager cshtml Zone Model Header _ Pager First cshtml jdivs Ld Pager Last cshtml lt fheader gt Lal Placement infa i Bu Theme png if Model Navigation null F Toae div id layout navigation class group gt zone Model Navigation Ba ThemeZonsPreview pn F Web config d CREDITS tet Gif Model Featured null Global asax div id layout featured class group gt wa LICENSE bet flZone Model Featured L Refresh html i lt div gt La robots txt Lj Web config 4i gif Model BeforeMain null div id layout before main class group gt zone Model BeforeMain
483. pecific events such as when the part is activated The content handler enables you to perform actions at particular moments in the lifecycle of the content item It also enables you to set up data repositories and manipulate the data model prior to rendering the content item Typically you define a handler for a content part by creating a class that inherits from ContentHandler The ContentHandler class is a base class that provides the methods and properties you will commonly need when defining your own content handler Alternately you can also create your own content handler by creating a class that implements IContentHandler 430 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 3 10 2 Defining Data Repository and Adding Filters When working with a content part that persists data add a constructor for the handler that accepts an Repository parameter for objects of the type you defined for records in the part The following code shows a basic implementation of a content handler MapRecord is a class defined in a separate file using Map Models using Orchard ContentManagement Handlers using Orchard Dasta namespace Map Handlers 1 public class MapHandler ContentHandler public MapHandler IRepository lt MapRecord gt repository Filters Add StorageFilter For repository You can add other types of filters to the content handler For example you can add an ActivatingFilter to the Filters collec
484. pending on the current theme and then it delegates the rendering work to actual view engines 278 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Similarly we have route providers model binders and controller factories whose work is to act as a single entry point for ASP NET MVC and to dispatch the calls to the properly scoped objects underneath In the case of routes we can have n providers of routes typically coming from modules and one route publisher that will be what talks to ASP NET MVC The same thing goes for model binders and controller factories Content Type System Contents in Orchard are managed under an actual type system that is in some ways richer and more dynamic than the underlying NET type system in order to provide the flexibility that 1s necessary in a Web CMS types must be composed on the fly at runtime and reflect the concerns of content management Types Parts and Fields Orchard can handle arbitrary content types including some that are dynamically created by the site administrator in a code free manner Those content types are aggregations of content parts that each deal with a particular concern The reason for that is that many concerns span more than one content type For example a blog post a product and a video clip might all have a routable address comments and tags For that reason the routable address comments and tags are each treated in Orchard as a separate conte
485. perty we know that we will need IContentManager IWorkContextAccessor IAliasService to turn the route data into an instance of the current ContentItem Taking what we have learned about dependency injection and knowing our service requirements we can now imple ment the next stage of the FeaturedProductDriver class 1 Open up the FeaturedProductDriver cs file located in the Drivers folder 2 Add the following properties to the top of the FeaturedProductDriver class private readonly IContentManager _contentManager private readonly IWorkContextAccessor _workContex tAccessor private readonly IAliasService _aliasService IAliasService will need it s namespace but when you try to add it via Ctrl you will We need to add a reference and update the dependencies of our module l Right click on the References entry in the module s project within the Solution Explorer win dow and choose Add Reference 2 Click the Projects tab on the left Orchard Alias should already be visible Hover your mouse over it and a checkbox will appear Click the checkbox for Orchard Alias Click OK 3 9 Extending Orchard 321 Read the Docs Template Documentation Release 1 9 2 b Assemblies 4 Projects an b COM b Browse Reference Manager Orchard LearnOrchard FeaturedProduct Mame Lucene Markdown MSBuild Orchard Tasks Orchard Orchard Alias Orchard Antispam Orchard ArchiveLater Orchard AuditTrail Orchard Autoroute
486. pes are localizable because they both contain the Localization part You can add the Localization part to other content types that need translation Click Content on the dashboard and then view the items in the Manage Content screen Notice the New Translation link for each content item 122 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Manage Content User admin Logout Content Items Content Types Actions Choose action Create New Content Show any show all ordered by recently modified F Download View Unpublish PER Edit Delete Published No Draft Published 2 days ago Last modified 2 days ago By admin New translation Welcome to Orchard View Unpublish Edit Delete Published No Draft Published 3 days ago Last modified 3 days ago By admin New translation Showing items 1 2 of 2 Note This link appears only if you have more than one culture enabled on the site see previous section and if you have enabled the Localization feature Clicking the New Translation link allows you to define a translated version of the content item to be associated with the parent content item in the site s default culture Each translated content item is treated as a unique content item in the system On the Translate Content editor screen you can define the culture code for the content item The permalink will change accordingly in order to
487. playing it can be done without touching the templates This is possible because Orchard separates layout into two stages Rendering performed by generating HTML from templates or shape methods and e Placement done through the placement info file This way parts can not only specify their default rendering which can be overridden by themes they can also specify where they prefer to be rendered relative to other parts which can also be overridden by themes Best Practice Avoid creating templates for high level Content Types Instead create templates for Content Parts and Content Fields then change their order with placement Specifying placement using the placement info file is the subject of this article Summary Placement works only on parts and some fields of content items Place element attributes are shape names not alternate names Find shape names via shape tracing or in driver code e Match element attributes include ContentType DisplayType and Path e Path can include a x to represent all child paths Override module placements in the theme 3 11 Creating Themes 447 Read the Docs Template Documentation Release 1 9 2 Syntax Overview lt placement gt L Smatch scope gt place Shape Name order alternate wrapper shape gt match lt placement gt The placement info File If you look at the files in your Orchard website you ll see that most modules and themes have
488. ple and click Update 3 9 Extending Orchard 405 Read the Docs Template Documentation Release 1 9 2 In order to use the new part on our customer content items we need to add it to the type Go to the Content Types screen and click Edit next to Customer Click Add next to Parts check the Rewards part and save Edit Content Type Content Types gt Edit Content Type Display Name Customer Content Type Id Customer Fields Name TextField Parts Address Common Rewards If you go back to an existing customer s edit screen or create a new one you ll see a screen such as this 406 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Edit Customer Name Address Street Address 1 lst Street City somewhere state Zip 98008 15ads I Rewards Senior 5 0 96 E Family 10 0 96 Member 15 0 96 Owner admin hard 407 Publish Now Read the Docs Template Documentation Release 1 9 2 On the front end the customer now looks like this Orchard Home Name Joe 1 1st Street Somewhere KS 98008 Rewards Senior 5 0 96 Member 15 0 965 Building a Relation Between Content Items Our third example will establish a relation between content items which is a step up from our previous examples which were establishing relations between records Doing the same thing with items is not fundamentally very differ
489. plied directly into our classes 3 9 Extending Orchard 297 Read the Docs Template Documentation Release 1 9 2 Content part driver Everything you see in Orchard is composed from Shapes If you don t know about shapes you can learn more about them in the accessing and rendering shapes guide A content part driver is a class that composes the shapes that should be used to view and edit content parts Drivers live in their own folder called Drivers A basic driver class will contain three methods a display driver for viewing a content part in the front end an editor driver for presenting an editor form in the admin dashboard and an update method to handle changes submitted from the editor form As the shapes are created in the driver you can also pass data through to a view Views are discussed in the next section but first we need to wire in the plumbing The widget that we are building has no configuration so all this driver will need is the Display method configuring The other methods will be added in when we revisit the widget it part two There aren t any command line scaffolding commands for setting up new drivers so you will need to create it manually 1 Make anew Drivers folder Right click on the module project in the solution explorer click Add New Folder 2 Add a new class called FeaturedProductDriver by right clicking the Drivers folder clicking Add Class andtyping FeaturedProductDriver for the name Visual Studio
490. porting confidential information such as passwords or application keys To import a recipe click Import Export and then click the Import tab Browse to the recipe file and click Import 3 4 Managing Websites 217 Read the Docs Template Documentation Release 1 9 2 Import Import Export Choose a recipe file to import Please consider exporting or backing up your data first Recipe File J Browse Creating a Specialized Distribution of Orchard Recipes simplify the process of creating a specialized distribution of Orchard Using recipes and optionally custom modules you can configure a version of the Orchard platform that is optimized for nearly any type of website you can envision To create a specialized distribution of Orchard Enlist in the Orchard source code For information about how to enlist in Orchard see Setting Up a Source Enlistment 2 Sync to the latest build 3 Create a custom recipe and add it to the Orchard Web Modules Orchard Setup Recipes folder If you want your recipe to be the only option you can remove the other recipe files 4 Add any custom modules to the Orchard Web Modules folder 5 Compile the project 6 Distribute all files under the Orchard Web folder 3 4 9 Creating an Image Gallery Draft topic This document targets Orchard developers Using only the admin dashboard you will create a gallery that renders thumbnails of images that you select from the Media folder Afte
491. pre approval of comments 3 4 6 Managing Users and Roles Orchard provides the ability to manage users and roles for your site with users assigned to one or more roles and different permissions associated to each role To manage the users in your site click the Users link in admin panel By default there is ony one user which is the admin user that is configured in the Orchard setup screen on first install To add an additional user click Add a new user You can also edit remove and disable user accounts from this screen Users Roles Actions Choose action Apply Filter All Users Sort by Name Name Email Actions Q admin Edit Delete Disable When adding a new user specify a user name email and password along with one or more roles for the user The roles determine what permissions a user has on your site in other words what operations they are allowed to perform The effective permissions for a user are the union of permissions for all applied roles Permissions only grant operations to a user they never deny them 3 4 Managing Websites 203 Read the Docs Template Documentation Release 1 9 2 User Name Email Password Confirm Password Roles U Administrator LJ Editor U Moderator U Author J Contributor Save You can also configure the roles in your site by clicking the Roles link in the admin panel 204 Chapter 3 Documentation Read the Docs Template Documentation Rele
492. ps Into Orchard Base URL http localhost 30321 OrchardLocal i Content Definition Enter the fully qualified base URL of the web site eg http localhost 30320 orchardlocal http www yourdomain com Default Site Culture en US Y Determines the default culture used to localize strings and to format and parse numbers date and times Add or remove supported cultures for the site Default Site Calendar Culture calendar Y Determines the default calendar used when displaying and editing dates and times The Culture calendar option means the default calendar for the culture of the current request will be used Default Time Zone UTC Dublin Edinburgh Lisbon London Y Determines the default time zone used when displaying and editing dates and times Page title separator a Edit the content of the website 3 9 Extending Orchard 271 Read the Docs Template Documentation Release 1 9 2 E ES i 9 First Steps Into Orchard Xx Y C fi localhost 30321 OrchardLocal Admin E 12 Post eat a EN o9 o sz 9 First Steps Weker New Post User admin Logout E Dashboard Title Writing a blog post Permalink B Content http localhost 30321 OrchardLocal blog writing a blog post amp Content Definition B Blog Set as home page New Post ee New Blog Body Queries File Edit Insert View Format Table Tools Comments 22 D B Z ty xS Paragraph Taxonomies
493. publishing workflow RSS and Atom feeds Slugs Page templates and syntax Tags Themes Theme includes Users roles and permissions Widgets XML RPC and Live Writer Creating Lists of Content Items CHAPTER 5 Archived Specs 521
494. r Y Go lh Show All ASP NET A A ad RB WES sg uv NET NET MET Error Authorizat Compilation Pages w Manage Website 7 po NET NET Profile NET Roles e Restart Globalization mo NET Trust NET Users Application Right click Sites and Add Website 1 2 Manually installing Orchard from a zip file 13 Read the Docs Template Documentation Release 1 9 2 Internet Information Services IIS Manager S Gl gt WBA Sites gt a File View Help Connections Actions oF Sites Add Website 23 WBA wa operat S 4 E w i pos or Filter 7 Go showa ji Set Website Def af Application Pools he ae aie nan e ERG VIRES ID Status Bind yt Add Website jult Web Site 1 Stopped 80 Refresh Switch to Content View Write your site name and point Physical path to your Orchard folder Click Ok 44 0 0 0000000000000 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Add Website Content Directory Physical path C inetpub wwwroot Orchard Pass through authentication Connect as Test Settings Binding Type IP address Port http w All Unassigned w 80 Host name Example www contoso com or marketing contoso com Start Website immediately OR Cancel Click Yes in the warning dialog about two sites using port 80 1 2 Manually installing Orchard from a zip file 15
495. r any Display type value in the shape name place the type name after a dot at the end of the template name such as Content BlogPost Summary All templates for alternates must reside in the Views folder The Views folder can be located either in the theme or in the module The following table shows which subfolders of Views to use for different types of templates Shape type Template Folder _ Content item ViewsMtems Parts Views Parts Fields Views Fields EditorTemplate Views EditorTemplates template type folder For example an EditorTemplate for a part is located at Views EditorTemplates Parts All other Views For example to create an alternate template for the Tags part you can add a template to the MyTheme Views Parts folder However because the underscore can be converted to either a dot or backslash you can also create a template in the Views folder and add Parts to the beginning of the name A template at either Views Parts Tags ShowTags BlogPost cshtml or Views Parts Tags ShowTags BlogPost cshtml will map to a shape named Parts Tags ShowTags BlogPost If the Orchard framework cannot locate an alternate template that has the expected name the default template will be used for those shapes For example if you do not create an alternate for showing tags the default template for tags located at Views Parts Tags ShowTags cshtml is used The Orchard framework automati
496. r is pointing to download Select Save 64 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Add Layer Name Download lisplayed in the admin pages Description A widget layer for Download at download Layer Rule url download 1 expression that evaluates to true when the widgets in this layer must be displayed http docs orchardproject net Documentation Managing widgets amp AddingaLayer for more inform 1 5 9 Adding a New HTML Widget 3 To check that your layer rule is working you can add a widget to it Ensure that Current Layer is Download Click Add in AsideFirst 1 5 Getting Started with Orchard 65 Read the Docs Template Documentation Release 1 9 2 Current Layer Add a new layer A widget layer for Download at download IE B All Layers Default Header Add Authenticated Navigation Add empty Anonymous empty Main Menu Move to current layer Disabled empty Featured Add TheHomepage Download empty BeforeMain adi AsideFirst 4 Add a new Html Widget Choose A Widget Blog Archives Container Widget Html Widget ER 48 YXAI 1 2a 5 Write a title and a body for it Save it 66 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Title My First Aside Widget The title of the Widget W Check to render the title on the f
497. rId div e rieldsert Note Again we are assuming a small number of customers In a real scenario where there are too many customers to be handled in a drop down list it would be possible to adapt the code in this sample by changing among other things the kind of UI that is used to select the sponsor customer 3 9 Extending Orchard 413 Read the Docs Template Documentation Release 1 9 2 The front end view is as follows aif Model Sponsor null lt text gt Customer sponsored by Model SponsorName lt text gt j Of course the placement file also needs to be updated Placement Place Parts Address Edit Content 10 gt Place Parts Address Content sl0 7 gt Place Parts Rewards bdits Conbtent 1l1 5 Place Parts Rewards Content 11 gt Place Parts Sponsor bEdite cContent 12 75 Place Parts Sponsor Content 12 lt Placement gt Using the Sponsor Part We can now go back to the Customer type definition and add our new part Now when we create a new customer we can choose his sponsor 414 Chapter 3 Documentation Edit Customer Name Douglas Address Street Address 4 Main Street City Orchard City State WA Washington Zip 98052 Rewards E Senior 5 0 25 E Family 10 0 75 E Member 15 0 75 Read the Docs Template Documentation Release 1 9 2 Read the Docs Template Documentation Release 1 9 2 On the front end the sponsor now also
498. rage account for both or any combination of different storage accounts Orchard Azure Web Role 4 X Configuration Service Configuration All Configurations emn Endpoints DP Add Setting X Remove Setting Local Storage Add configuration settings that can be accessed programmatically and dynamically updated Certificates Name Type Value Orchard Azure Settings StorageConnectionString Connection String Caching Orchard Azure Media StorageConnectionString Connection String Orchard Azure OQutputCache Hostldentifier String Orchard Azure Web Orchard Azure OQutputCache CacheName String QutputCache Orchard Azure QutputCache Hostname String x E E E a E Ll am Problem 2 will be addressed by enabling the Windows Azure Output Cache and Windows Azure Database Cache features These don t need any preparation as the cloud service project is already preconfigured for co located role based caching with the appropriate named caches configured Problem 3 is already taken care of for us The cloud service is preconfigured to use the ASP NET session state provider for Windows Azure Cache This takes effect immediately after we deploy This section above describes only the most basic configuration steps and options More detailed steps for enabling the Windows Azure Media Storage Windows Azure Output Cache and Windows Azure Database Cache features for a Windows Azure Cloud Service as well as more advanced confi
499. rame across the bottom of the web page when you navigate to your site similar to the following illustration My VS Orchard Site Home Blog d Edit Welcome to Orchard You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going mto editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head aver to manage themes to change ar install mew themes and really make it your own Once you re happy with a look and feel it s time for some content You can start creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes IF you re locking to add additional functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you 50 if you feel up to it please consider participating Thanks for using Orchard The Orchard Team You ve successfully setup your Orchard Site and this 6 the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel conf
500. ration 11 9 2010 Items to be installed Options Install Exi OQ Mpuons After you accept the license terms Orchard is installed Open a command window and change the current directory to point to the root of the site Then run bin orchard exe C X1netpubxwuwwurootOrchard cd C gt ed inetpub wawroot Orchard C inetpub wwwroot Orchard gt bin orchard Initializing Orchard session This might take a few seconds for help exit to exit cls to clear screen Type help commands to get the list of available commands For now only the help and setup commands are available However as Orchard is developed and modules are activated new commands will become available The Orchard command line executable actually discovers the commands from the modules inside of the application To set up the site enter the following command setup SiteName Orchard AdminUsername admin AdminPassword 123456 DatabaseProvider SqlCe This is equivalent to setting up the site from the web interface 3 9 Extending Orchard 351 Read the Docs Template Documentation Release 1 9 2 Leave the command window open In fact don t close it until you have finished this tutorial Generating Code for the Module Now you are ready to start developing the commerce module Orchard provides a code generation feature that sets up the structure of an empty module to help you get started By default code generation is disabled So you must
501. rchard Theme Machine is a flexible multi zone theme that provides a solid foundation to build your CHEER site It features 20 collapsible widget zones and is flexible enough to cover a wide range of layouts Available ES Classic a Contoso Casa ilio x a F setcurent Preven By Jon Wall By The Orchard Team Version 1 0 Version LO Orchard Classic Blox Theme A subtle and simple OMS theme perfect for any http orchardpraject net modem product or service business website Enable Uninstall http www orehardproject net Enable Uninstall As you can see from the links and buttons on the available themes you have the following options for each theme Preview Lets you preview a theme before you apply it This lets you see how a theme will look on your site but site visitors do not see the new theme until you apply it Set Current Changes the current theme of the site to the selected theme Uninstall Removes a theme from the Available themes section Enable Used for two cases dependent themes and multiple themes For dependent themes you can create a set of themes that depend on each other by specifying a BaseTheme value in the Theme txt file so that activating that theme automatically enables the others For multiple themes you can enable several themes at once even though only one theme is set as the current theme which lets you dynamically change the current theme based on an incoming request These are advanced
502. rchard features e Blog Sets up a site as a personal blog Core Sets upa site that has only the Orchard framework for development use 22 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Choose an Orchard Recipe Orchard Recipes allow you to setup your site with additional pre configured options features and settings out of the box Default Default Blog Core A Ped Pi ho LT 7 Li Lun Peay Ad I v ELE 1 Le a content types comments tags widgets and basic naviga tion Finish Setup For information about recipes and how to make a custom recipe see Making a Web Site Recipe After you ve entered the required information on the setup screen click Finish Setup When the setup process is complete your new site s home page is displayed My Orchard Site Welcome to Orchard Nov B 2012 9 27 AM You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head over to manage themes to change or install new themes and really make it your own Once you re happy with a look and feel it s time for some content You can star
503. rchi d dbo Tenant2 Orchard Blogs BlogPartReco dbo Tenant2 Orchard Comments ClosedC zl dbo Tenant2 Orchard Comments Commer C 3 8 Using Windows Azure Cache 263 Read the Docs Template Documentation Release 1 9 2 Working with Tenant Sites Isolated tenants can each have a unique configuration of content items enabled features and applied themes Tenants all share the same file system view of the application however so the list of available modules and themes will be the same for each tenant In the following screenshots the Alpha tenant and the Beta tenant have different themes applied Alpha Website Welcome admin SignOut Dashboard Wou ve successfully setup your Orchard Site and this is the homepage of your new site Here are a ew things you can look at to get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever oL want st things first You ll probably want to manage your settings and configure Orchard to your king After that you can head over to manage themes to change or install new themes and really nake it your own Once you re happy with a look and feel it s time for some content You can start os new custom content types or start from the built in ones by adding a page or managing ur Menus ally Orchard has been designed to be extended It comes with a few built in modules such as ges and blogs or
504. rcochard demo gt gt J etc hosts If you want to visit the Orchard demo from another machine you will need to modify the machine s etc hosts file in the similar way replacing 127 0 0 1 with your server s IP address Database Setup First make sure you have PostgreSQL installed and running ps ax grep postgres Output of the command should be similar to 1279 2 Ss 0 00 postgres logger process IZJ X Ss 0 00 postgres writer process 12 5 T Ss 0 00 postgres wal writer process 1279 3 Ss 0 00 postgres autovacuum launcher process L200 7 Ss 0 00 postgres stats collector process When PostgreSQL is running and ready type the commands below to create the database and the user sudo i su postgres createuser l D R S P orchard Type the password when prompted and then create the database it will be named orchard createdb E UTF8 O orchard orchard 3 8 Using Windows Azure Cache 255 Read the Docs Template Documentation Release 1 9 2 At this point you must make sure the new orchard user has access rights to the database In order to do it you need to find the pg hba conf file and open it in the editor you must be doing that with administrator root rights The file is located in var lib pgsql data on SuSE and in etc postgresql X Y main on distributions derived from Debian X Y is the major minor version number of your PostgreSQL server After the file is found and opened make sure it contains a line s
505. rd Core EA Orchard Framework 4 A Orchard Web gt m Properties i4 References 143 App Data i i bin Config 2 Default aspx is Global asax 3 Orchard Web sln le Refresh html E Web config C Solutio I RESET Type codegen module Maps IncludeInSolution true at the Orchard command prompt The IncludeInSolution 360 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 switch tells Orchard to wire up a new Maps module project to the Orchard sln file orchard codegen module Maps IncludeInSolution true Creating module Maps Module Maps created successfully After running this command Visual Studio prompts to re load the solution file Accept this prompt i The solution Orchard has been modified outside the environment Press Reload to load the updated solution from disk Press Ignore to ignore the external changes The changes will be used the next time you open the solution The Maps module project appears added to the solution along with some default files and folder to get you started Solution Explorer ba Solution Orchard 34 projects P L4 Futures 4 5 Modules l A Maps gt al Properties gt il References Content Controllers Models Scripts gt L3 Views Module txt amp Web config ES Orchard Blogs A Orchard Comments v A Orchard ContentTypes Open the Module txt file at
506. rd in a Microsoft Azure Web Site because in this environment the file system is shared among instances It is also possible to use this feature is any other hosting environment where you have a server farm with multiple nodes but no shared file system To do this you need to do the following e Add the Orchard Azure Settings StorageConnectionString setting in the lt appSettings gt element of your Web config file and set it to the connection string of the storage account you want to use Configure Autofac to load the AzureBlobShellSettingsManager implementation in your Config Host config file Here s an example Config Host config configuration lt autofac defaultAssembly Orchard Framework components 1 Configure Orchard to store shell settings in Microsoft Azure Blob Storage component instance scope 2 single instance type Orchard FileSystems Media Con component instance scope 2 single instance type Orchard Azure Services Enviroi lt components gt autofac 3 Using Microsoft Azure Media Storage The Microsoft Azure Media Storage feature in the Orchard Azure module configures Orchard to use Microsoft Azure Blob Storage is the underlying file system implementation for storing media Orchard Azure Name Microsoft Azure Media Storage Description Activates an Orchard media storage provider that targets Microsoft Azure Category Hosting There are two main reasons to use this feature e Runn
507. re Module loader module txt Localization lt Core Module loader module txt Modules Foo lt Reference Module loader because a bin Foo dll file exists 3 13 Additional Topics 501 Read the Docs Template Documentation Release 1 9 2 module txt Bar lt Precompiled Module loader because a Modules Bar bin Bar dll bin Bar dlLl module txt Baz lt pynamic Module loader because a Modules Baz Baz csproj fil Controller BazControler cs Baz csproj module txt Disabling the Dynamic Module loader The dynamic module loader should be useless when deploying a website in production as a production enviroment it should not be able to install and load module dynamically But another important reason why it should be disabled is that it creates a lot of FileSystemWatcher instances to detect changes on the modules To disable the module rename the file Config Sample HostComponents config to Config HostComponents config then check the content 1s lt xml version 1 0 encoding utf 8 gt lt HostComponents gt lt Component s Component Type Orchard Environment Extensions ExtensionMonitoringCoordinator Properties Property Name Disabled Value true lt Properties gt lt Component gt lt Components gt lt HostComponents gt Deploy this file and restart the App Pool NB You will have to ensure that the binaries for every modules are available in
508. rest of this page when we refer to Module it should be understand that the concept applies to Theme the same Way Example Here is an example of a Orchard installation which contains 6 modules Common Localization Foo Bar RootFolder Core Common module txt lt Common module from Core Localization module txt lt Localizatiou module from Core Modules Foo module txt lt Foo module Bar module txt lt Bar module Themes T2 theme txt lt Tl1 theme T2 theme txt lt CT2 theme Activation Once Orchard has collected all the Module txt files from the discovery phase Orchard uses distinct strategies or Module Loaders to load these modules in memory Internally the act of loading a module is an activity that takes a module txt file as input and returns a list of System Type as output Note that this is slightly more generic than simply returning a System Assembly as it allows Orchard to support multiple modules per assembly For example the Orchard Core dll assembly currently contains about 10 modules The Orchard framework currently implements the following loaders Referenced Module Loader This loader looks in in bin directory for a assembly name corresponding to the module name specified in mod ule txt If the assembly exists it is loaded and all its types are returned This loader is useful whe
509. rewrite the changes to keep the repository clean 3 12 Developer Tools and Guidelines 497 Read the Docs Template Documentation Release 1 9 2 By updating the commit message if it needs to be shortened or improved For instance if the patch is related to a work item the commit message should look like this 12345 Short message A longer message than can span multiple lines and describe the reasoning behind the change Work Item 12345 By rebasing the changes on the top of the branch to keep a more readable changelog By squashing the changes into a single commit Doing so can be tedious depending on your level of knowledge on git To help with this a specific git alias can be used GIT Alias to Merge changes from codeplex n your user s profile folder e g c users sebros open the file gitconfig Anywhere in the file at the end for instance add a new alias like this alias accept pr f git checkout b PR 1 amp amp git pull 2 3 amp amp git rebase 1 amp amp author gil e Ifthe alias section already exists keep it This accept pr command is now accessible from the git console and will apply all the necessary steps e 51 The branch to apply the PR to e g 1 8 x 1 x e 52 The url of the remote PR e g https gitO01l codeplex com forks jchenga orchard e 3 The branch to pull from the remote PR e g issues 20311 e 54 The commit message for the squashed commit e g 1234 Short n
510. rix Microsoft WebMatrix 2 Open Site Templates App Gallery Do not show this screen on start up Scroll down and select Orchard CMS Enter a name to be used as the folder name for your site For example if the site name Orchard CMS is entered the folder Documents My Websites Orchard CMS will be created Click Next 1 3 Working with Orchard in WebMatrix 25 Read the Docs Template Documentation Release 1 9 2 Quick Start Microsoft WebMatrix Site from Web Gallery All 61 t Blogs 15 P CMS 39 d ex DorTrerrhUw e WordPress illite iai an Psi 2 3 la oh iis HOTELS Downloads 5 8557 Downloads ads 4 Dads ecommerce 16 Forums 8 Galleries 4 L1 T L4 Tools 14 seo e mo joPOrtal J a j i A Made Laay Wiki 4 nopCommerce nop mmer MET CMS i r Orchard CMIS 2755 Moa s 254572 Downloads P7028 Downloads 716388 Downloads L1 L1 ezu wogengess fnoodle Galewseverrro Site Name Orchard CMS Click I Accept to accept the EULA agreement 26 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Quick Start Microsoft WebMatrix Site from Web Gallery PREREQUISITES Accept EULA Review the following list of third party application software Microsoft products and components to be installed and Windows components to be turned on Third party applications and products are provided by the third parties listed here Microsoft grants you no righ
511. rix screenshots Changed a bit the structure of some paragraphs to make them clearer Updated some links Updates for Orchard 1 6 11 07 12 Updated screens for 1 6 installation 4 12 11 Updated screens for 1 1 installation 3 14 11 Added section on using WebMatrix and IIS Express 3 14 11 Added information about recipes in the setup screen 3 15 11 Fixed the IIS section to use the Orchard subfolder from the zip 1 3 Working with Orchard in WebMatrix WebMatrix Microsoft s one stop web development tool lets you create edit and publish websites with unprecedented ease WebMatrix includes a built in web server IIS Express along with a simple editor for editing and customizing applications like Orchard When installing Orchard using the Web Platform Installer you have the option to install to WebMatrix instead of IIS 1 3 1 Links 1 3 2 Installing and Launching WebMatrix Download and launch the Microsoft Web Platform Installer Then click the Add button for Microsoft WebMatrix and click Install Documentation Upload screenshots Install_selectorWebMatrix png Accept the license terms and launch WebMatrix when the installation finishes 1 3 3 Using WebMatrix to create an Orchard Website To create an Orchard Website using WebMatrix click App Gallery on the WebMatrix startup page 24 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Quick Start Microsoft WebMat
512. rl Html Menu Item Add Renders some custom HTML in the menu On the Create Menu Item page you can fill in the Menu text Select Browse and link to any content item e g your Home Page Later when you have prepared your real target content item you can update the menu link 1 6 Navigation and Menus 73 Read the Docs Template Documentation Release 1 9 2 Create Menu ltem User admin Loc Menu text ed vat Should appear in the menu Content Item O localhost 30321 OrchardLocal Admin Orchard ContentPicker callback contentpicker 13982t Recent Content Show any show all d ordered by recently modified Y Welcome to Orchard Page Published No Draft Published 5 hours ago Last modified 5 hours ago By admin Showing items 1 2 of 2 1 1 6 2 Content First Navigation Later Here we first create a new Page or edit a Page Select New Page on the left menu Create an About Us page Give it a title and a body At the bottom check the Show on a menu checkbox to see the menu options for that page The Menu text is the name of your menu item By default the Page link will be added to the Main Menu 74 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Separate multiple tags with commas Show on a menu Main Menu Y Select which menu you want the content item to be displayed on Menu text few The text that should appear in the menu Create
513. rld through the home controller s index action and serves a simple view that gets skinned by the current theme We have done so with only free tools and in a way that differs very little from what you would do in a regular ASP NET MVC area We did get a few things for free by making this an Orchard module such as activation deactivation of the module or theming of the view with no effort on our part Hopefully this will get you started with Orchard and prepare you to build more elaborate modules The code for this topic can be downloaded from here HelloWorld zip 3 9 6 Creating a Module with a Simple Text Editor In this tutorial you will learn how to develop a simple commerce module using only a text editor If you do not have the Web Platform Installer on your computer download it before beginning this tutorial This guide has been marked for review If you are just getting started with Orchard module development you should read the Getting Started with Modules course first It will introduce you to building modules with Orchard using Visual Studio Community a free edition of Visual Studio Setting Up the Orchard Site First you will set up a new Orchard website If you already have a site set up you can skip this section and jump directly to the code generation section To start the setup open IIS Manager right click Sites and click Add Web Site 3 9 Extending Orchard 349 Read the Docs Template Documentation Release 1 9 2
514. rlier How would you like to store your data Use built in data storage SQL Server Compact Use an existing MySql database Connection string Data S5aurcezsqiServerName nitial Catalag dbName Persist Security infos True User IDzuserNams Passwaord passvwaord Database Table Prefix Congratulations Orchard is now fully configured for a single role instance on Windows Azure Using multiple role instances Let s take it up a notch You may want to scale out your cloud service to run on more than one role instance either because you want to support a higher workload or because the site is mission critical and you need some fault tolerance using only a single instance of any one role in a Windows Azure Cloud Service voids the Windows Azure SLA Using multiple instances also known as a web farm or a server farm with Orchard requires some extra consideration In the most basic default configuration of Orchard multiple instances can cause problems Orchard media files are stored in the local file system This won t work as the file systems or the different instances will soon start to diverge as users add remove media 2 Orchard output caching and database caching NHibernate second level cache use local memory for storage This won t work as content might be updated on one instance and any cached copies invalidated there while other instances continue unaware of this change 3 Session state is stored in local memory
515. rns so site administrators should pick from this list what applies best to their particular scenario As always improving performance should involve measuring and analyzing performance data so that changes you propose are demonstrably beneficial Trust Level Orchard is configured out of the box to run in Full trust Medium trust is no longer supported trust level FEnull originUrls t J gt Debug Release On your production server there is no reason to run in debug mode Make sure that the application you deployed was compiled in release mode and that the web config file in Orchard Web specifies release mode compilation debug false targetFramework 4 0 batch true numRecompilesBeforeAppRestart 250 Shared Versus Dedicated Versus Cloud Hosting Shared Hosting Shared hosting environments usually consist of web farms with load balancing The way this is implemented varies greatly between hosting companies and it is usually difficult for customers to get information on the specific config uration being used How well these configurations perform depends on the load on hosted applications and on the architecture of the application itself Shared hosting is a nice solution for Orchard users on a budget but there can be tradeoffs There is a natural contention between the customer who wants his or her site to be immediately available and to run as fast as possible and the hosting company that wants to support as man
516. roductService will need its namespace adding Do it via the Ctr1 shortcut Create a default constructor which will request an instance of IFeaturedProductService public FeaturedProductDriver IFeaturedProductService featuredProductService Make sure you add the public keyword at the start or Aut ofac will thrown an exception Assign the injected constructor parameter to the private variable public FeaturedProductDriver IFeaturedProductService featuredProductService _featuredProductService featuredProductService Update the Display method so that it uses the new service protected override DriverResult Display FeaturedProductPart part string displayType dynamic shapeHelper return ContentShape Parts FeaturedProduct gt return shapeHelper Parts FeaturedProduct IsOnFea turedProductPage featuredProductService IsOnFeaturedProductPage Your FeaturedProductDriver cs class should now look like this using Orchard ContentManagement using Orchard ContentManagement Drivers using Orchard LearnOrchard FeaturedProduct Models using Orchard LearnOrchard FeaturedProduct Services namespace Orchard LearnOrchard FeaturedProduct Drivers public class FeaturedProductDriver ContentPartDriver lt FeaturedProductPart gt 3 9 private readonly IFeaturedProductService featuredProductService public FeaturedProductDriver IFeaturedProductService featuredProductService featuredProductService
517. ront end uncheck to hide ame The technical name of the Widget used for css class and alternates Body a or X Ex A i El 1 B Z i Paragraph erm El A widget for my Donwloads page only 6 Select Your Site in the upper left side of the Dashboard Navigate to Downloads You should see the custom layout Orchard CMS Home Downloads RON VUE RE E EM im My First Aside Widget Download widget for my Donwloads page only 2 Tags To aes Tuesday April 22 2014 4 09 00 PM Description of available downloads Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard 1 5 10 Selecting A Theme To customize the look and feel of the Orchard website you change the theme 15 Getting Started with Orchard ge Read the Docs Template Documentation Release 1 9 2 1 On the Orchard Dashboard select Themes The currently installed themes are listed 2 To download new themes select the Gallery tab 3 Search for PJS Bootstrap to find the PJS Bootstrap Theme Install the PJS Bootstrap theme 4 Select the Installed tab After a theme has been installed it appears as an option in the Available section on the Installed tab In the following illustration the PJS Bootstrap theme has been installed so it appears in the Available section The current theme for the site is PJS Bootstrap 5 To see how your site will look with an available them select
518. ropertySetHandlers Initiala2ingContentContext context SponsorPart part 1 add handlers that will update records when part properties are set part SponsorField Setter sponsor gt part Record Sponsor sponsor null 2 null sponsor ContentItem Record return Sponsor ex Force call to setter if we had already set a value if part SponsorField Value null part SponsorField Value part SponsorField Value The storage filter is as usual setting up the repository of sponsor part records but we also have OnInitializing and OnLoaded event handlers that will respectively set up the setter for the lazy field and the loader of the value that will be executed the first time the field is accessed At loading time we look at the record and if there is a sponsor we get the full content item from the content manager using the record s id The lazy field setter just sets the underlying record s Sponsor property The Driver The driver is relying on the following view model using System Collections Generic using Orchard ContentManagement using RelationSample Models namespace RelationSample ViewModels 410 public class EditSponsorViewModel public int CustomerId get set public int SponsorId get set public IEnumerable CustomerViewModel Customers get set Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 public class CustomerViewModel public int Id get
519. rowser to make sure the application s dynamic compilation feature picks up the new part and record You will know that everything is working if you go to the Features administration screen and see the new SimpleCommerce feature In the command window enable the new feature using the following command feature enable SimpleCommerce Creating the Initial Data Migration File Data migration is a pattern that enables an application or component to handle new versions gracefully without any data loss The main idea is that the system keeps track of the current version installed and each data migration describes the changes to go from one version to the next If the system detects that there is a new version installed and the current data is from a previous version the administrator of the site is prompted to upgrade The system then runs all necessary migration methods until the data version and the code version are in sync Start by creating the initial migration for the new module which will just create the data tables that are needed In the command window enter the following command codegen datamigration SimpleCommerce This creates the following Migrations cs file using System using System Collections Generic using System Data using Orchard ContentManagement Drivers using Orchard ContentManagement MetaData using Orchard ContentManagement MetaData Builders using Orchard Core Contents Extensions using Orchard Daca Mrgratonons
520. rt Orchard supports the following versions of net 3 12 Developer Tools and Guidelines 481 Read the Docs Template Documentation Release 1 9 2 Orchard Version Framework Required _ _ Up to version 1 7 Orchard supports NET 4 0 Version 1 8 Orchard runs on NET 4 5 and IIS 7 or newer Version 1 9 Orchard runs on NET 4 5 1 and IIS 7 or newer Which branch should be using when working on the codebase Branches are discussed on the contributing patches page What types of extensions can write Orchard Modules and Themes are supported There is extensive documentation covering these topics in the main documentation index Where are Modules physically located The projects in the Modules folder are physically located under the src Orchard Web Modules folder This allows modules to contain ASP NET views and static content without having to copy files between projects to be able to run the project The Core modules are physically located under the src Orchard Web Core folder What is a Module txt file This is the module manifest It is YAML format file You can learn more about module txt in the manifest files guide What is the AdminMenu cs file This file has an implementation of the Orchard interface called INavigationProvider Itlets modules hook themselves into the admin menu in the backend This is typically where you declare what links shou
521. rt a bug or issue to the package author please use the Project Site link instead 3 3 Using the Orchard Gallery 167 Read the Docs Template Documentation Release 1 9 2 Contoso By The Orchard Team A subtle and sirnple CMS theme perfect for ary madern product or service business website Project site Report Abuse Theme details Tags business cms madem simple subtle product service Lategory None Downloads 2077 Last updated 1 13 2011 Version 1 Package ID Orchard Theme Contoso No ratings of reviews not implemented yet Average Rating 0 reviews Note that a few key gallery features are remaining to implement and those will be available on the website as soon as they are ready See About the Orchard Gallery Project below for more information Multiple Versions of the Same Package Currently each version of a package module or theme is listed as a unique entry in the web site which can make it somewhat difficult to know whether you are downloading the most recent version Blog ML 0 5 0 Download By Nicholas Mayne A module ta allow the importing and exporting of the Blog Content Type thru the Blog interface More information U comments Tags Import Export blog 119 Downloads Bl Od ML 0 6 0 Download By Nicholxs Mayne 4 module to allow the Importing and ex porting of the Blog Content Ty pe thru the BlogML nterface More information 0 comments Tags Import Export blog 31 Downloads We
522. rt that you ve put together could already be composed from the administration UI into a content type see Creating Custom Content Types but per the goal of this topic you will continue by writing code using a text editor You will now build a new Product content type that will include the Product part and a number of parts that you can get from Orchard So far you have been focused on your specific domain This will now change and you will start integrating into Orchard To build the content type from a new migration open the Migrations cs file and add the following method to the class public ant UpdsStekrom2 4 ContentDefinitionManager AlterTypeDefinition Product cfg gt cfg WithPart CommonPart WithPart RoutePart WithPart BodyPart WithPart ProductPart WithPart CommentsPart WithPart TagsPart WithPart LocalizationPart Creatable Indexed return 3 j Also add using Orchard Indexing to the top of the file What you are doing is creating or updating the Product content type and adding to it the ability to have its own URL and title RoutePart to have a rich text description BodyPart to be a product to be commented on Comment sPart to be tagged TagsPart and to be localizable LocalizationPart It can also be created which will add a Create Product menu entry and it will also enter the search index Indexed To enable your new module open the Orchard dashb
523. rtificates E Bertrand Le Roy Subscnptii i Hosted Services 1 g Vulu Hosted Se fy Storage Accounts 1 CI Certificates ta User Management 2c Orchard 1 0 Deployme E VM Images a Orchard Azure Web Role 8 Orchard Azure Web IN O0 Instance Ca CDN fy Home Hosted Services Storage M Accounts amp CDN Database jx Reporting 4 Service Bus Access Control amp Caching wa Virtual Network 238 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Upgrade Deployment Subscription Bertrand Le Roy Service name Vulu Target environment Staging Role to upgrade All Upgrade mode Automatic i Manual Deployment name Orchard 1 0 Package location Orchard Azure Web cspkg Browse Locally Configuration file ServiceConfiguration csctg Browse Locally Browse to the package and config file click OK Log in and go to admin Go into the dashboard Modules should have already upgraded themselves automatically In rare cases you may be prompted to upgrade features Click Modules and upgrade each of the modules one by one until they are all up to date If this doesn t work it means that something is wrong with your install and or one of the modules you re using and you should investigate further in logs e Some versions of Orchard come with version specific upgrade features Go to Modules and locate the Upgrade feature Enable
524. rward you can customize the gallery with CSS and an alternate HTML template Create the Image Gallery Content Type From the admin dashboard click Content Definition The Manage Content Types page will open Click Create new type 218 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Give the new type a Display Name e g My Image Gallery Click Create Attachments Creating an image gallery new content type Jjpg When you click create Orchard will open the Add Parts page Check Widget then click Save The Edit Content Type page will now show Change the Stereotype to Widget and click Save Then click Add Field The Add New Field page will open Choose Media Library Picker Field Name the field e g My Media Library Picker Field Click Save Attachments Creating an image gallery add new field jpg e After you click save click on the down carat beside the new field Check Allow multiple content items Click Save at the bottom of the page You will now have the following Content Type It has both a Widget Part and a Media Library Picker Field 3 4 Managing Websites 219 Read the Docs Template Documentation Release 1 9 2 Edit Content Type My Image Gallery My Image Gallery settings have been saved Display Name My Image Gallery Content Type Id MylrmageGallery Creatable Determines if an instance of this content type can be created through the Ul
525. ry Updates for Orchard 1 8 9 05 14 Updated all screen shots for Scheduling and Publishing Draft 3 1 5 Creating Custom Content Types Although Orchard includes the Page and Blog Post content types by default it is very easy to create a custom content type or even extend the definition of an existing content type using the admin panel By default the Content Types feature is enabled This feature must be enabled to create a custom content types If needed you can manually enable the feature in the Manage Features page Features Installed Recipes Gallery Filter content Actions Choose action ES Content Content Control Wrapper Enable Content Localization Enable ContentTypes Disable Add an Edit button on the front end for authenti Enables localization of content items ContentTypes modules enables the creation and Depends on Contents Depends on Settings Depends on Contents To create a content type Click Content Definition and select the Content Types link in the admin panel 130 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Q ECKEN E MG Manage Content lypes E Dashboard Content Types Content Parts Filter Content Content Definition Audio Media I Blog Blog Y Queries El Comments Blog Archives widget Taxonomies m Spam mi m i On this screen you can see the available content types in the system Notice that it is possible to create an
526. s Comments Comments must be approved before they appear Check if you want to manually approve comments before they can be disp Automatically close comments after 0 days JeTInition Number of days after comments are automatically closed Leave to 0 to ha Dect Save J m MM n Lt J w Queres i C mi mi a m c LL La Taxonomies Widgets Comments 1 J Media 84 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 1 7 4 Using Tags in blogs Orchard provides the ability to browse content by the tags that are added to the content Click one of the tags for example Orchard in the blog post to see a list of all content that has that tag For more information about managing tags see Organizing Content with Tags Your Site Home About Us Blog Contents tagged with orchard My first post Tags first post Orchard team Friday April 25 20148 26 40PmM 1 Comment This is my first blog post more Download Tags download orchard Description of available downloads more Notice the URL for browsing tagged content as well O localhost 30321 OrchardLocal Tags Orchard If the URL is shortened to just the Tags portion the list of tags used in your site 1s displayed 1 7 Adding a Blog to Your Site 85 Read the Docs Template Documentation Release 1 9 2 Your Site Home About Us Blog Tags download orchard e first post eam Powere
527. s ContentPart RewardsPartRecord 7 Properties 7 Properties Discount 8 Rewards Id Name GE RewardProgramRecord ContentRewardProgramsRecord E Class Properties Id LT wA RewardsPartRecord RewardsPartRecord amp Class ContentPartRecord 7 Properties Rewards Methods RewardsPartRecord The Rewards Part Record The part record has just one property the collection of rewards using System Collections Generic using Orchard ContentManagement Records namespace RelationSample Models public class RewardsPartRecord ContentPartRecord public RewardsPartRecord Rewards new List ContentRewardProgramsRecord j public virtual IList ContentRewardProgramsRecord Rewards get set 398 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 The Rewards Part The rewards part itself proxies the Rewards property to the record using System Collections Generic using System Ling using Orchard ContentManagement namespace RelationSample Models public class RewardsPart ContentPart lt RewardsPartRecord gt public IEnumerable lt RewardProgramRecord gt Rewards get return Record Rewards Select r gt r RewardProgramRecord The Reward Program Record Reward programs have a name and a discount rate namespace RelationSample Models public class RewardProgramRecord public virtual int Id get set public
528. s Template Documentation Release 1 9 2 You can add modules to Orchard in two ways The first and easiest is to install a module from the online gallery The second is to upload a module package from your local computer and install it in your site If you simply want to use an existing module in your Orchard site you can install the module directly from the gallery to your site If you want to modify a module package or if you want to upload it to multiple Orchard sites you will probably want to download the module from the gallery to your local computer Installing a Module from the Gallery When you install a module its package file is downloaded from the gallery and the source files are extracted from the package and added to your site After you install a module its features are available for use To install a module from the gallery click Modules on the dashboard then click the Gallery tab The Gallery tab displays a list of available online modules from the gallery feed or feeds registered for your site 188 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Modules User admin Logout Features Installed Gallery Updates 0 Feed All feeds Sortby Downloads v Code Generation Version 1 0 20 Install Download Tools to create Orchard components Last Updated 1 13 2011 9 37 35 AM Author The Orchard Team Downloads 2629 Website httpy orchardproject net Rating tii Hi
529. s Template Documentation Release 1 9 2 dynamic shapeHelper return ContentShape Parts FeaturedProduct Edit gt shapeHelper EditorTemplate TemplateName Parts FeaturedProduct Model part Prefix Prefix protected override DriverResult Editor FeaturedProductPart part IUpdateModel updater dynamic shapeHelper updater TryUpdateModel part Prefix null null return Editor part shapeHelper Passing data to the view We have already passed data to the view in previous parts but we didn t stop to examine it in detail return ContentShape Parts FeaturedProduct Edit gt shapeHelper EditorTemplate TemplateName Parts FeaturedProduct Model part Prefix Prefix These parameters are dynamic which means you can add any parameter you want This means that we could update the Display method to pass through a value by changing the code to shapeHelper Parts FeaturedProduct FavoriteColor Green The view would then be able to use this by using Model FavoriteColor We want to implement some logic into the Display method which will result in answering the question IsOnFeaturedProductPage so that this can be passed through to the view We will do this by declaring bool isOnFeaturedProductPage false atthe top of the method It will be given a default value of false to start with Then throughout the next few sections we will perform tests to see if it is in fact t rue Modify the first
530. s and Guidelines 495 Read the Docs Template Documentation Release 1 9 2 SharpZipLib SharpZipLib is used for zipping unzipping files For example the Orchard media manager module uses this library to unzip uploaded media files SpecFlow This BDD style library is used in Orchard for integration tests TESI Collections Orchard uses the Tesi collections library which supports a SET collection that contains no duplicates TinyMCE TinyMCE is currently used for editing CMS pages content WCat WCat is a lightweight HTTP load generating tool used for performance testing YUI We use parts of YUI for easier CSS 3 12 5 Code Conventions Definitions e Camel case is a casing convention where the first letter is lower case words are not separated by any character but have their first letter capitalized Example thisIsCamelCased e Pascal case is a casing convention where the first letter of each word is capitalized and no separating character is included between words Example ThisIsPascalCased C Coding Conventions We are using the C coding conventions described in this document C Coding Guidelines with the following excep tions Opening braces are on the same line as the statement that begins the block with a space before the brace this is consistent with what we do in JavaScript a k a K amp R convention If you have the Rebracer Visual Studio extension installed it will automatically configure the editor t
531. s as well as uploading a zip file that contains multiple image files If you have a large set of images to upload it can be more efficient to first add them all to a zip file and then just upload the zip file instead of uploading the images one by one 88 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 To see how this works create a zip file on your computer that contains several image files and then click Upload The Extract zip checkbox is selected by default which will cause the uploaded images in the zip to be extracted and added to the folder Add Media User admin Logout Media Folders gt HtmlWidget gt Pictures gt Add Media File Path multiple files must be in a zipped folder C food zip Extract Zip Ei After your files have been uploaded you can edit the titles and descriptions Upload The uploaded and extracted images are displayed in their parent folder Manage Folder User admin Logout Media file s uploaded Folder Properties Media Folders gt HtmlWidget gt Pictures gt Manage Folder Actions Delete Add a folder Add media l Name Author Last Updated Type Size E bread jpg 3 16 2011 4 16 59 PM jpg 99 KB E carrot_cake jpg 3 16 2011 4 16 59 PM jpg 90 KB F lemon tartjpg 3 16 2011 4 16 59 PM jpg 80 KB To see or edit the details of an individual uploaded image click it 1 8 Adding and Managing Media Content 89 Read the Docs Template Doc
532. s before 2 10 You can also use before and after qualifiers to position shapes before or after a certain position For example Header after positions the shape at the next available position following everything that s defined using numeric positions Placement order examples 1 A weight of 5 in local content zone gt Place Parts TagCloud Content 5 lt Before the top level header zone gt Place Parts TagCloud Header Before lt After the top level asidefirst zone with a weight of 5 gt Place Parts TagCloud AsideFirst After 5 Suppression 66 99 There is a special value that suppresses the shape rendering instead of sending it to a zone Suppression examples 1 Suppress Parts TagCloud everywhere gt Place Parts TagCloud Suppress Parts TagCloud in views using SummaryAdmin gt Match DisplayType SummaryAdmin Place Parts TagCloud Match Alternate Added in v1 1 Use alternate to specify shape alternates from Place elements For example if you want to enable a theme author to specify a different template for rendering the tags for blog posts you can do the following Match ContentType BlogPost Place Parts Tags ShowTags Header 1 Alternate Parts Tags ShowTags BlogPost Match A theme author can then provide a Parts Tags ShowTags BlogPost cshtml file that customizes the display of tags for
533. s can be injected into zones but the most common ones are widgets Not all zones need to be exposed in the manifest only those that are intended to host widgets 3 11 Creating Themes L 4d Read the Docs Template Documentation Release 1 9 2 This is the BeforeContent zone Zone Demo Tags demo zones wiigets This is the content for the Zone Demo page This is the AfterContent zone FooterQuadFirst 2 FooterQuadSecond FooterQuadThird FooterQuadFourth POC ee eet eee Pe Ce re tre ee re eee Cer ee ee er er Footer This is the Footer zone This illustration shows 19 zones which is typically more than you need for a site The zones include a header and footer which are zones situated on the top and bottom of the page There is a navigation zone which is typically where navigation menus would be inserted The Featured zone is where you might put a site banner BeforeMain and 442 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 AfterMain surround the main zones on the top and bottom AsideFirst and AsideSecond are sidebars that are rendered on the left and right of the main content In the center of the page there is a Messages zone where notifications go followed by BeforeContent the content itself the Content zone and the AfterContent zone On the bottom of the page there are TripelFirst TripelSecond and TripelThird that you can use if you want three columns on the bottom and the Foot erQua
534. s creatingprojectionwidget png Rendered Result Upload Proje ctions renderedresult png 3 4 12 Create Dynamic Forms The Dynamic Forms module is used to capture information from site visitors on the front end Dynamic Forms can work in combination with a Content Type or standalone Dynamic Forms can be used to create Contact Us and Subscribe widgets pages to name a couple The information is then stored in Orchard and can be exported later Enable the Dynamic Forms Module The Dynamic Forms module is different from the custom forms module because it can work in combination with a Content Type to capture input on the front end or you can choose to just store the form submission If you choose to just store the submission you will find it in the Form Submissions section of the admin The information submitted is stored and can be exported using the Import Export module Let s start by enabling the Dynamic Forms module that is shipped with Orchard by going to the Modules section in the admin Documentatio n upload dynamic forms enable dynamic forms png Once the module has enabled the feature a new content type called Form will appear in the create new content section of the admin As stated before the Dynamic Forms module works with a content type either create a submission or create forms on the front end of the site In the New content section of the admin you can click on Form to create a new form an edit form screen will popup a
535. s file and then use Script Require filename css to include it 332 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 1 In the Solution Explorer right click onthe Styles folder within the module Choose Add New Item from the context menu Select Visual C then Web from the categories down the left hand side Find Style Sheet in the list and give ita Name of FeaturedProduct css Click Add Open Views Parts FeaturedProduct cshtml ao en dM er ae Copy the css content from within the style tag don t include the lt style gt tag itself and drop it into the FeaturedProduct css style sheet 8 Go back to FeaturedProduct cshtml and replace the now empty lt style gt lt style gt with this code Style Include FeaturedProduct css If you don t specify a folder then Orchard will automatically check the Styles folder first This is a quick solution but not a best practice solution so let s improve it a bit further The problem with Style Include is that it blindly includes the file whenever requested Orchard supports something called a ResourceManifest class which can help you manage your external resources in a more intelligent way Using the resource manifest class you can assign extra information to your CSS files This could be alternative URLs to use for debug live content delivery networks setting the version of the script or setting dependencies on other other res
536. s for users so be sure to war SchemaBuilder DropTable MapRecord ContentDefinitionManager DeletePartDefinition typeof MapPart Name By including ContentPartRecord with your properties in the definition of the database schema you en sure that other essential fields are included in the table In this case an id field is included with Latitude and Longitude The return value is important because it specifies the version number for the feature You will use this version number to update the schema You can update the database table by adding a method with the naming convention UpdateFromN where N is the number of the version to update The following code shows the migration class with a method that updates version by adding a new column namespace Map DataMigrations public class Migrations DataMigrationImpl public int Create Creating table MapRecord SchemaBuilder CreateTable MapRecord table gt table ContentPartRecord Column Latitude DbType Double Column Iongrtude DbDrTybe Double 3 10 Working with Data 429 Read the Docs Template Documentation Release 1 9 2 ContentDefinitionManager AlterPartDefinition typeof MapPart Name cfg gt cfg Attachable return 1 public int UpdateFroml SchemaBuilder AlterTable MapRecord table gt table AddColumn Description DbType String recur 43 The update method returns 2 because after the column is a
537. s in Code Orchard 1 1 provides simplified access to objects in code because you can directly access content part objects without having to use casting or extension methods The following examples show how to access a Title property on a widget part The first code ex ample shows the older way of access the property from Orchard version 1 0 20 found in the Mod ules Orchard Widgets Views Widget Wrapper cshtml file Note that the code casts the returned object to the IContent interface and uses an As extension method to access the property var title IContent Model ContentItem As WidgetPart Title Here is the updated and simplified way that you can access the property in Orchard 1 1 var title Model ContentItem WidgetPart Title 3 11 Creating Themes 465 Read the Docs Template Documentation Release 1 9 2 Here is a second example of Orchard object access that has been simplified in version 1 1 The following code is in Orchard version 1 0 02 to access the fields for a content item This example is from a content shape so the Content Item object is accessed directly on the Model object The first line of code casts to Content Item and then the second line uses an As extension method to access the collection of fields on the content part The return value of the code is the picture width var contentItem ContentItem Model ContentItem var picture ImageField contentItem As lt ProfilePart gt Fields First f gt Na
538. s to upload and share modules and themes with others You can also browse modules and themes from the gallery using the Orchard admin panel Refer to Installing modules and themes from the gallery for more information To view the gallery website navigate to http gallery orchardproject net in your browser 162 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 a F l ORCHARDHOME JOIN US or E El B Orchard gallery A ign In Modules Themes Contribute New to Orchard Submit Your Idea Join the Community Visit Orchard Project net Get Orchard is easy to extend Just Stay in touch with the Orchard started by reading our installation add new modules and themes community by subscribing to our and setup guide then pick a few You can also contribute your own discussions lists walkthroughs to try themes or modules and share them with others Join our mailing list Create an account Participate in discussion forums Install Orchard Contribute a module or theme Contribute to Orchard About the Orchard Gallery Here you can browse and download optonal modules and themes for installing to your Orchard based site You can subn t your custom modules or themes to this site be registering for new secpunt and dicking the Contribuie tab Ta browse the avadable modules and themes an the gallery using the Orchard admin panel enable the Gallery feature As always we look forward to hearing your feedbac
539. same name and the same methods In other words Orchard does not require strictly strongly typed interface correspondence which enables plug ins to extend an extensibility point without taking a dependency on the assembly where it s defined This is just one implementation of the Orchard event bus When an extensibility point calls into injected implementa tions a message gets published on the event bus One of the objects listening to the event bus dispatches the messages to the methods in classes that derive from an interface appropriately named Commands Many actions on an Orchard site can be performed from the command line as well as from the admin UI These commands are exposed by the methods of classes implementing CommandHandler that are decorated with a Com mandName attribute The Orchard command line tool discovers available commands at runtime by simulating the web site environment and inspecting the assemblies using reflection The environment in which the commands run is as close as possible to the actual running site Search and Indexing Search and indexing are implemented using Lucene by default although that default implementation could be replaced with another indexing engine 3 9 Extending Orchard 281 Read the Docs Template Documentation Release 1 9 2 Caching The cache in Orchard relies on the ASP NET cache but we expose a helper API that can be used through a dependency of type ICache by calling the Get met
540. save the page as a draft You can continue working on the file until it is ready to be published In the Manage Content page you can see the files that are currently saved as drafts Documentation Upload screenshots 675 draftunpublish png A draft is listed as Not Published and you can use the links to publish edit or remove the page Clicking the Publish link immediately changes the draft to a published page and visitors will be able to see it immediately Publish Now Option To publish a page immediately click Publish Now For a draft page click the Publish link in Manage Content In the Manage Content page you see the files that are published Documentation Upload screenshots 675 draftpublished png You can click links to view unpublish edit or remove the page Clicking Unpublish immediately turns the published page into a draft 3 1 Authoring Websites 129 Read the Docs Template Documentation Release 1 9 2 Publish Later Option You can schedule the publication of a page for a future time by setting a date and time and clicking the Publish Later option Documentation Upload screenshots_675 publishlater png The page will remain as a draft until the publication date and time No further action is needed to publish the page In the Manage Content page you can see the date and time the draft is scheduled to be published Documentation Upload screenshots_675 pagepublishlater png Change Histo
541. se It will get you started with a gentle introduction to extending Orchard at the code level You will build a very simple module which contains a widget that shows an imaginary featured product It will teach you some of the basic components of module development and also encourage you to use best practices when developing for Orchard If you haven t read the previous parts of this course then you can go back to the overview to learn about the Getting Started with Modules course This final part will look at applying some best practices to improve the quality of the module s codebase What s left to do So far in the course we have covered a pretty impressive list of topics You might be tempted to think that the items in this last part are extras but just because we saved them until last doesn t mean they aren t important In fact the only reason these weren t covered earlier was because they aren t essential to being able to load up the module in Orchard and there was already plenty to discuss Your module is not really complete though until you ve incorporated these techniques into your development process 3 9 Extending Orchard 329 Read the Docs Template Documentation Release 1 9 2 The topics in this article will help you add polish to your module and if you re going to release them to the public it will mean the difference between a beginners module and a professional module Customize the manifest file Starting with an easy
542. ses templates and shapes to build views Templates are conceptually similar to partial views in ASP NET MVC and they provide the basic structure for rendering shape data in a page A template can contain web page content such as HTML markup CSS styles and JavaScript code to help render shape data In addition a template can contain server code blocks so that you can access and render shape data in a web page Shapes are dynamic data models that represent content structures such as menus menu items content items documents and messages Shapes provide the data for dynamic views as opposed to the static ASP NET views in MVC that templates render at run time For more information about working with shapes see Accessing and Rendering Shapes The view engine is responsible for parsing the template and rendering the shape data into a web page The default view engine for Orchard is the Razor view engine which is installed with ASP NET MVC 3 In order for the Razor view engine to correctly parse a template you must write the template using the Razor syntax which defines a small set of rules for writing web page templates that contain a mixture of static web page content such as HTML markup and programming code This topic gives an overview of the Razor syntax used in templates and layout pages It then shows you how to create your own shape template Razor Syntax Primer Using the simple rules of the Razor syntax you can embed server based code
543. set site culture culture name Set culture for the site feature disable lt feature name 1 gt feature name n Disable one or more features feature enable feature name 1 feature name n Enable one or more features feature list Summary true false Display list of available features help command Display help text for command help commands 184 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Display help text for all available commands package create lt extensionName gt lt path gt Create a package for the extension lt extensionName gt an extension being a module or a theme The package will be output at the lt path gt specified The default filename is Orchard Module Theme lt extensionName gt lt extensionVersion gt nupk For example package create SampleModule c temp will create the package e temp Orchard Module SampleModule 1 0 0 nupkg package install packageld location Version lt version gt Install a module or a theme from a package file package uninstall packageId Uninstall a module or a theme Ihe lt packageld gt should take the format Orchard Module Theme lt extensionName gt For example package uninstall Orchard Module SampleModule will uninstall the Modu package uninstall Orchard Theme SampleTheme will uninstall the Theme under the user create UserName username Password password Email
544. si Oz 7 pumgarrght fL float right margin 0 923em 0 0 923e0m 0 923em j a focus a hover text decoration underline a color c03 text decoration none fheader background 000 Qolors 0005 WLoth LOOS height 50px maeroqin bottom 40px boranding hl 3 11 Creating Themes 435 Read the Docs Template Documentation Release 1 9 2 tonbtosrzeo 24095 Color HLE padding Spx 0 0 40px TROT UO LUTS KK KK KK KK KK KK KK KK KK KK KK KK KK KKK KK KK KK KK KKK KK KK KKK KEK KEK KEK KKK KKK KEK layout navigation widen 960px Mekorn 0 ce displays block border bottom 1px solid dbdbdb nav ul padding Opx margin 0px Navy Ub 3x border lpx solid dbdbdb background f 6f6f6 display block float left marginso9 2px lpx 0 nav ul li current border bottom Tpx solid fff backoround F T nav ul a padding 9p display block float left Colors Foo tont srzes 20 rem text decoration none line height 24px x Main ck ckckckckckckckckckokokckckckckckckokckokckokckockckokckckckckokckokckokckckckckckckckckckckokckck ck ck ckckckckckckckck kc k k fmain margin 0 auto 40px WO 600 DK x Secondary KK KK KK KK KK KK KKK KK KK KK KK KKK KK KK KK KK KK KKK KKK KKK KKK KEK KKK KKK KK KEK 436 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Forms ck KK KK KK KK KK KK KK KK KK KK KK KK KKK KK KK KK KK KK KKK KK KK KK
545. sion 1 0 Install Download 4 subtle and simple CMS theme perfect for any modem product or service business website may Last Updated 1 13 2011 8 40 11 AM Author The Orchard Team Downloads 4117 PEPIISTSIRE ARGLIamsguT Website http www orchardproject net Rating Tic dx Terra Version 1 0 1 install Download Terra is a highly flexible theme based in shades of brown And if you are looking for further customization of this theme discover Bind Tuning our online configuration tool Create a fully customized Terra theme in just a few clicks just like if you had a design team working for you visit http tuning bind pt Last Updated 3 16 2011 7 17 13 PM Author BIND Downloads 2074 Website http tuning bind pt Rating Classic Version 1 0 remm XP Install Download EU Lo Orchard Classic Blog Theme mp BEDS UE u mI GE men Eme Last Updated 1 14 2011 2 31 29 AM Author The Orchard Team Downloads 1517 m ey Website htto forchardpraject net Rating ww AAA After you have installed a theme click the Installed tab on the Themes screen Any newly installed themes appear in the Available section 3 2 Customizing Websites 147 Read the Docs Template Documentation Release 1 9 2 Themes User admin Logout Installed Gallery Updates 0 Current Theme Thro Mariae The Theme Machine By jcwall mibach laude heskew Version 1 0 20 httpz archardproject net A O
546. site He can edit the settings of an existing theme if provided or create one A theme is everything that plays in the visual representation of the website It is sometimes called skin or template It transforms the content user generated data into HTML that can be displayed in a browser Eg When 272 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 you write a blog post the theme defines where and how to show the menu title body comments etc Depending on how much customization is required the designer may edit some or all elements of the theme These elements are of the following types Documents defining the layout and its zones This is the overall representation of a page on the website without any actual content Eg It says if the website should have one two or three columns So a zone is a container that is part of the layout and ready to receive any content Note that a flexible theme like the one provided by Orchard can adapt to hide empty zones So although Figure 6 shows a lot of zones most of them will not be visible on actual pages because they aren t being used Views Visual representation of a specific content A view is typically a file with the extension CSHTML or ASPX It provides the HTML code to use when displaying a specific type of content So a page with many contents menu blog post comments etc will be created by using the composition of all the relevant individual
547. site down As you deploy make sure that the target settings txt files aren t overwritten so that the production site continues to point to the production database While you deploy you might want to shut the site down by dropping an app offline htm file into the root Remove that file once you re done Once deployed manual upgrade actions for example those from the Upgrade feature need to be performed again on the deployed production site Upgrading An Orchard Site In Place It is possible to upgrade a site in place if you can t or don t want to work with a local copy and then publish it The procedure is less clean but it works Backup everything site and database Download the new version to your local machine e Add app offline htm to the root of the site during the upgrade This effectively tells the web server to return this page for all requests You should put a message such as The site is currently being updated Thank you for your patience Please try again later in the file Delete what s in bin This ensures that old versions of binaries that won t get replaced will not continue to be picked up by the application e Delete the App DataNDependencies folder Orchard will rebuild this folder on startup This ensures that old versions of module assemblies will not be picked up by the application Extract the new version s zip file and copy what s in its Orchard folder over the server s Orchard web directory
548. sor Id 3 ContentDefinitionManager AlterPartDefinition SponsorPart builder gt builder Attachable Ierurm 93 We are in known territory here the table uses the convention that we have already applied twice in the previous examples where the name of the column establishing the relation is the concatenation of the column names in both records We also make the new SponsorPart attachable as usual The Sponsor Handler The handler is going to be a little more elaborate than usual because of the use of lazy fields using Orchard ContentManagement using Orchard Dsta using Orchard ContentManagement Handlers using RelationSample Models namespace RelationSample Handlers public class SponsorPartHandler ContentHandler private readonly IContentManager _contentManager public SponsorPartHandler TRepository lt SponsorPartRecord gt repository IContentManager contentManager 3 9 Extending Orchard 409 Read the Docs Template Documentation Release 1 9 2 Filters Add StorageFilter For repository _contentManager contentManager OnInitializing lt SponsorPart gt PropertySetHandlers OnLoaded SponsorPart LazyLoadHandlers void LazyLoadHandlers LoadContentContext context SponsorPart part add handlers that will load content just in time part SponsorField Loader gt part Record Sponsor null null contentManager Get part Record Sponsor Id Static void P
549. st change to the content part will be to let it know about this record class Then we will add a public property which mirrors the data class and specifies how it will store its data 1 Open the ContentPart file located in N ModelsNFeaturedProductPart cs 2 Add a generic type parameter to the FeaturedProductPart class by changing this 304 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 public class FeaturedProductPart ContentPart To this public class FeaturedProductPart ContentPart lt FeaturedProductPartRecord gt 3 Add the public property to the class DisplayName Is the featured product on sale public bool IsOnSale get return Retrieve r gt r IsOnSale set Store r gt r IsOnSale value 4 Add the namespace for the DisplayName attribute The DisplayName attribute is a feature provided by ASP NET MVC Later on when we build the editor view for the admin dashboard it will use this phrase instead of simply displaying IsOnSale You should now end up with a FeaturedProductPart cs file that looks like this using System ComponentModel using Orchard ContentManagement namespace Orchard LearnOrchard FeaturedProduct Models public class FeaturedProductPart ContentPart lt FeaturedProductPartRecord gt DisplayName Is the featured product on sale public bool IsOnSale get return Retrieve r gt r IsOnSale set Store r gt r IsOnSale value
550. system storage Microsoft Azure Cloud Services is an example of this For this reason when deploying Orchard to a Microsoft Azure Cloud Service using the Orchard Azure sin solution the resulting package is already preconfigured to store shell settings in Microsoft Azure Blob Storage The only thing you need to change before deploying is the connection string of the storage account you want to use Orchard Azure Web Role X Configuration Service Configuration All Configurations v iEn Endpoints 3 Add Setti ng X Remove Settin g Local Storage Add configuration settings that can be accessed programmatically and dynamically updated Certificates Mame Type Value Orchard Azure Settings StorageConnectionStri Connection String UseDevelopmentStorage true Orchard Azure Media StorageConnectionString Connection String UseDevelopmentStorage true Caching a tel i ee Ein a Ee 2E 3 8 20 2 RE Cal eee ia Pe el A amp I LAP 1 Open Orchard Azure sln 3 6 Using shell settings storage 251 Read the Docs Template Documentation Release 1 9 2 2 Navigate to Orchard Azure CloudService double click the role Orchard Azure Web to bring up its property page and navigate to the Settings tab 3 Set the Orchard Azure Settings StorageConnectionString setting to be the connection string of the storage account you want to use 4 Deploy the cloud service NOTE It is not necessary to use this feature when running Orcha
551. t Media Turns a content type into a Media Note you need to set the stereotype to Media as well Menu Types fields and parts can have settings as well The specific settings that are available on the fields or parts is determined by the features that are activated in Orchard If we have enabled the Indexing feature there is a setting to Index this content type for search and on each field a setting to Include in the index Select these options for the Location field of the custom Event type This will enable visitors of your site to search by location on the front end when the Search feature is enabled Hit Save 3 1 Authoring Websites 137 Read the Docs Template Documentation Release 1 9 2 Display Name Event Content Type Id Event Index this content type in orchardsearch W Creatable Determines if an instance of this content type can be created through the UI 4 Draftable Determines if this content type supports draft versions stereotype Optional The stereotype of the content type e g Widget Menultem 138 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Fields v Location Text Field Include in the index Check to add content of this field in the selected indexes Display options Large d Required Check to ensure the user enters a value in this field Help text The help text is written un
552. t open the Orchard Dashboard and click Widgets You can then select the layer and zone where you want to display the widget The following image shows the Manage Widgets page 384 Chapter 3 Documentation Manage Widgets Current Layer Default Add a new layer Header Navigation Featured BeforeMain AsideFirst Messages BeforeContent Content AfterContent AsideSecond AfterMain TripelFirst First Leader Aside TripelSecond Second Leader Aside TripelThird third Leader Aside FooterQuadFirst FooterQuadSecond 3 9 Extending Orchard FooterQuad Third FooterQuadFourth Read the Docs Template Documentation Release 1 9 2 BBEBBBEBEBEB Move to current layer n Move to current layer n Move to current layer BB User admin Logout theme preview image layer visibility 385 Read the Docs Template Documentation Release 1 9 2 For information about how to display your widget see Managing Widgets Sharing Your Widget To share the widget with others or to upload it to the widget gallery you first need to package you widget to a module zip file This is done the same way any module is packaged in Orchard For information see Packaging and sharing a module 3 9 11 Creating 1 N and N N Relations It is very common for contents to consist in part of lists or choices in lists For example an address can have a state or region property where the value is
553. t option and press enter That s all you need to do for your first ContentPart class Your FeaturedProductPart cs file should now look like this using Orchard ContentManagement namespace Orchard LearnOrchard FeaturedProduct Models 1 public class FeaturedProductPart ContentPart Data migrations When your module is enabled in the admin dashboard Orchard will execute a data migration process The purpose of the data migration is to register a list of the features contained in the module and any data it uses We aren t going to use this yet but the migration is also used for upgrades As you work on your modules you will want to add and remove bits The data migration class can make changes and you can transform your existing data to meet your new requirements The data migration class can be created by hand following a similar process as the last section but we can also scaffold it with the orchard exe command line Let s dive back in to the command line and add a data migration class to the module 1 Press the Save A11 button or press Ctrl Shift S Its a good practice to always save before using the command line utility Many of its commands will make changes to your solution and if you have unsaved changes you will get merge conflicts 2 In the Solution Explorer scroll down to the Orchard Web project It should be the very last project in the solution 3 Right click on the Orchard Web project and choose Open
554. t Azure management portal that you used to create your storage or ask you dev ops admin to provide them for you To configure the connection string after deploying 1 Deploy the web site 2 In the management portal navigate to your web site and select the Configure tab 3 Under App settings add a setting named Orchard Azure Media StorageConnectionString and set its value to be the connection string of the storage account in which you want to store media content 3 7 Using Microsoft Azure Media Storage 253 Read the Docs Template Documentation Release 1 9 2 4 Click Save You can now enable the feature Microsoft Azure Media Storage in the admin dashboard NOTE For multi tenancy scenarios the Orchard Azure Media StorageConnectionString setting can optionally be prefixed with a tenant name 3 3 Enabling for any other hosting To enable the feature when running Orchard in any other hosting environment use the Web config method de scribed above Once the connection string has been added to the lt appSettings gt element can enable the feature Microsoft Azure Media Storage in the admin dashboard 3 7 4 Using a custom domain name for blob storage Microsoft Azure Blob Storage allows the use of your own custom domain instead of the default endpoint hostname nystorageaccount blob core windows net However registering and configuring a custom domain in your storage account is not enough to make Orchard use it Unless you also recon
555. t MapPart gt protected override DriverResult Display MapPart part string displayType dynamic shapeHelper return ContentShape Parts Map gt shapeHelper Parts Map Longitude part Longitude Latitude part Latitude GET protected override DriverResult Editor MapPart part dynamic shapeHelper return ContentShape Parts Map Edit gt shapeHelper EditorTemplate TemplateName Parts Map Model part Prefix Prerix HLPOST protected override DriverResult Editor MapPart part IUpdateModel updater dynamic shapeHelper 3 9 Extending Orchard 365 Read the Docs Template Documentation Release 1 9 2 updater TryUpdateModel part Prefix null null return Editor part shapeHelper We can now add the display and editor views in Visual Studio First add Parts and EditorTemplates Parts folders to the Views folder in the Maps project and then add Map cshtml files into the Views EditorTemplates Parts and the Views Parts folders as follows Views EditorTemplates Parts Map cshtml model Maps Models MapPart lt fieldset gt lt legend gt Map Fields lt legend gt lt div class m editor label Tiz Html LabelFor model gt model Latitude lt div gt SOIV Qlessettecdruor rasaedbog Html TextBoxFor model gt model Latitude aHtml ValidationMessageFor model gt model Latitude S div class editor label gt Html LabelFor model gt model Lon
556. t Types section of the Orchard admin panel Let s add it to an existing content type namely the custom Event content type that we built in the Creating custom content types topic If you haven t read that topic yet or don t have the Event type go ahead and add the Map to the Page content type instead following the same steps below On the Manage Content Types admin screen click on Edit to edit the definition of this type you may need to enable the Orchard ContentTypes feature first Event Create Mew Event In the list of parts for the Event type click on Add to add a part Parts gt Comments Menu gt Publish Later Route gt Tags The Map part displays in the list of available parts to add Select it and click Save 3 9 Extending Orchard Remove Remove Remove Remove Remove List Items 367 Read the Docs Template Documentation Release 1 9 2 Add Parts To Event Body Common Localization Now go the Manage Content and edit an event content item Notice that the Map part adds Latitude and Longitude fields to this item Type some valid coordinates and re publish the content item Edit Event Tithe Publish Settings Nerd Dinner Tonight Save Draft 9 Publis edens Publish Now http localhost 91 nerd dinner tonight Set as Publish Later home page Save Location Crossroads Food Court Date Tuesday August 3rd Tags nerds dinners
557. t creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re looking to add additional functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Second Leader Aside Third Leader Aside Lorem ipsum dolor sit amet consectetur Lorem ipsum dolor sit amet consectetur Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor adipiscing elit Curabitur a nibh ut tortor adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh dapibus vestibulum Aliquam vel sem nibh dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Suspendisse vel condimentum tellus Suspendisse vel condimentum tellus Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard You are now on the Orchard home page and can begin configuring your site 1 2 Manually installing Orchard from a zip file 23 Read the Docs Template Documentation Release 1 9 2 1 2 6 Change History Updates for Orchard 1 8 4 9 14 Added screenshots and more detail to the IIS section Updated Webmat
558. t plays into providing that capability 3 9 Extending Orchard 275 Read the Docs Template Documentation Release 1 9 2 Content Data that is typically displayed on the front end website I use this term as a generic way of calling anything that is user generated Content Type amp amp Item A content type is like a dynamic class it defines a structure of data for a specific type of content That structure can be changed even by the administrator A content item is an instance of content type So BlogPost can be a content type and when you write one that one is a content item Content Part Because many content types share many aspects these aspects can be created independently and reused in each content type That s what a content part is Eg A blog post can have comments a photo can also have comments so instead of implementing the comments feature twice we can create it as a content part and reuse it for both content types Content Field In the same spirit of reusability we can have smaller types that must behave in a certain way Eg Most content types will need Date phone number email address etc They aren t simple properties since we can attach some behavior like validation rules but they aren t content parts either too small Record In order to be able to save a content type part in a SQL database it needs to be linked to a record It is a class with all the properties that should be saved E
559. t to create a new tenant on DotNest DOTNEST ABOUT PRICING KNOWLEDGE BASE Tenant Management Dashboard My Tenants 3 Hill in the required details to create a New Tenant 42 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 MY TENANTS ABOUT PRICING KNOWLEL Back to My Tenants Title Testing DotNest You can give the tenant any title that you can use to identify it since this will be displayed here in the tenant list Tenant Properties Tenant Name testingdotnest Technical name of the tenant can only contain lowercase letters numbers an underscores This will be also us Description Testing DotNest Suspended If the tenant is suspended it won t respond to requests but its data will remain intact Use this if Hosts o http testingdotnest dotnest com Testing DotNest Home Welcome to Orchard Thursday September 4 2014 7 46 44 AM You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at to get familiar Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you wat First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head over to man install new themes and really make it your own Once you re happy with a look and feel it s time for some content You can start creat
560. t types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re looking to add additional functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Edit Second Leader Aside Edit New Third Leader Aside Edit Lorem ipsum dolor sit amet consectetur Lorem ipsum dolor sit amet consectetur My new third leader aside adipiscing elit Curabitur a nibh ut tortor adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Suspendisse vel condimentum tellus Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard 4 Select the Edit link for the TripelFirst zone of the home page 5 Change the title and optionally change or remove the existing body text for the zone Inserting a Media Item 6 Select Insert Media Item 56 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 Edit Widget User admin Logout Zone TripelFirst Layer TheHomepage e Position ai Title Tulips Body da 5 X aA 2
561. tContent j But where do all of these supporting classes like aliasService and contentManager come from Dependency injection in Orchard The modular design of Orchard means that each feature of Orchard tries to be as independent as it can This means that when the Widget is building it s shape it doesn t automatically know about the wider context of the page being requested It is a specialized unit of code which completes it s task as efficiently and simply as possible When it s required the module can request access to parts of the larger Orchard system through the use of Orchard s service classes Orchard provides service classes that allow you to leverage Orchard features at the code level When you need to do things like pulling content out of the content manager displaying notifications logging or working with the URL you can turn to these services classes These classes are grouped together by a common inheritance they implement IDependency When you need one of them you simply need to add it to your constructor and an instance will be injected into your class at run time This is called dependency injection You can get many frameworks that will enable this but in Orchard the service is provided by Autofac Each of these support classes specialize in providing a single feature This means you only open communication channels to the main system for the parts which you actually need keeping the system decoupled Constructor i
562. tail Upload Proje ctions savelayout png 5 Previewing the query result Upload Proje ctions clickpreview png Upload Proje ctions queryresult png Adding Properties to the Html List Layout Change Display Mode to Properties Upload Proj ctions changedisplaymode png 1 Title Property Upload Projections titleproperty png Open Rewrite Results gt Select Rewrite output Rewriting the output for the Title Property and using Tokens to the Title and Url fields lt hi gt lt a href Content Fields ExternalPost Url target _blank gt Content Fields Extern 228 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Upload Proje ctions titlerewrite png 2 Author Property Upload Projections addingproperties png Rewriting the output for the Author Property and using Tokens lt p gt Posted By lt b gt Content Fields ExternalPost Author lt b gt on Content Date lt p gt Upload Proj ctions authorrewrite png Creating a Projection Page for ExernalPostQuery Unordered Html List Upload Proj ctions projectionpage png Select the Show Pager check box to add a pager to the list Upload Projections creatingprojectionpage png Rendering Results using Projection Widget Upload Proj ctions projectionwidget png Select ExernalPostQuery Unordered Html List For Query 3 4 Managing Websites 229 Read the Docs Template Documentation Release 1 9 2 Upload Proje ction
563. targets and was tested with the Orchard 1 8 release This topic shows the steps you need to perform to install Orchard using the zip file We will use three different approaches e JIS WebMatrix and IIS Express e Visual Studio and the Visual Studio Development Server Note If you prefer using the Web Platform Installer or if you plan to use WebMatrix to develop your site you may want to see the topic Installing Orchard which installs Orchard from the Web Platform Installer and includes WebMatrix in the installation 1 2 1 Downloading the zip File Navigate to the Releases Section of Orchard in GitHub You will find two zip files e Orchard Web I x xx zip In this file the site has already been built and can be run without additional compilation It does not includes all the source code e Orchard Source 1 x xx zip This file includes the source code If you plan to develop modules you probably prefer this one It is easier to use with Visual Studio and you have plenty of source files to see how everything is done 1 2 2 Running the Site Using IIS This procedure was tested with a clean installation of Windows 8 1 Enterprise Edition First let s setup the server Search for Add or Remove Programs in your system And execute it 1 2 Manually installing Orchard from a zip file 9 Read the Docs Template Documentation Release 1 9 2 Search Everywhere w add or remove prog rams L Uninstall apps to free up disk
564. tarted with Modules course 302 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Expanding the widget to make it more dynamic In the first version of the widget we took the bare minimum of steps that we could in order to get something up and running This meant we missed out a few classes that would be in a normal data driven module and some of the classes we did add were pretty much empty Now that you understand the basic workflow of building a module we re going to go back and take a second look at it adding in some new classes and expanding out the Widget By the time we have finished with this part we will have made the widget more dynamic To achieve this goal we are going to e Add a Boolean property to signify if the item is on sale e Dip into the Orchard API to hide the widget if the page we are viewing is the featured product Getting setup for the lesson You should have already completed part one of this course before you move on to this part This means you should have a copy of Orchard with the completed module work If you have the original Solution and module files available then 1 Open Visual Studio 2 Open the Solution you created in the first part of the course If for some reason you don t have these files you can play catch up by following these steps 1 Follow the setting up for a lesson guide 2 Download the completed module source code from part 1 3 Extract the archive
565. tation Release 1 9 2 Publishing Post to Blog Publishing Post to Our Blog View in browser after publishing 3 1 2 Creating Global Ready Applications Orchard s localization management is hosted on an external service Crowdin the project is available for the public and contributions are welcome Orchard supports two kinds of localization Localization of text strings in the Orchard application and in installed modules Localization of database driven content items This topic describes both of these features Localizing the Orchard Application and Orchard Modules All strings in the Orchard application are output through a single T method that can look up a translated string based on the default site culture By default Orchard includes strings for English en US but you can add support for additional cultures Translations for the dashboard UI and all static strings in the front end can also be added to the application through translation files in po format To localize a site for a culture you download and install the appropriate set of po files and then you update your site settings as shown in this section Note In NET Framework applications localization is usually done using resx files and satellite assem blies Orchard takes a more lightweight approach that uses po files In Orchard the number of translation files is the number of modules multiplied by the number of supported cultures That number could rapidly
566. tegorized Orchard LearnOrchard FeaturedProduct Description for feature Orchard LearnOrchard FeaturedProduct Click Enable to activate the plugin Modules Orchard LearnOrchard FeaturedProduct was enabled 5 You can now add the Widget to a layer in the site Click Widgets from the navigation menu 6 Inthe AsideFirst section of the Widgets page click the Add button DEU ENVIAM mamni AsideFirst Add Messages Add 7 The Featured Product Widget will be in the list click the item to select it Content Widget Featured Product Widget Html Widget 8 You can leave most of the Widget settings on their defaults Just set the Title to Featured Product Title Featured Product The title of the Widget Check to render the title on the front end uncheck to hide 9 Click Save at the bottom of the page If you go back to the main site now you will see the module in the site 3 9 Extending Orchard 301 Read the Docs Template Documentation Release 1 9 2 Home Featured Product Welc Todays featured product is the Sprocket 9000 Wednes You ve few thi need tl want Click here to view it First tk After tl We haven t created a page for the Sprocket 9000 so clicking the button will give a 404 at the moment Download the code for this lesson You can download a copy of the module so far at this link e Download Orchard LearnOrchard FeaturedProduct Part1
567. tent from malicious sul Category Security Dependencies Orchard Tokens Orchard jQuery Akismet Filter Name Akismet Anti Spam Filter Description Provides an anti spam filter based on Akismet Category Security Dependencies Orchard AntiSpam TypePad Filter Name TypePad Anti Spam Filter Description Provides an anti spam filter based on TypePad Category Security Dependencies Orchard AntiSpam Notice the structure that is used for each feature described in the Features field The FeaturelId of the feature is listed followed by a colon Then on a new line for each field you can specify the other relevant fields including Name Description Category and Dependencies For more information about how to create a module including how to generate a manifest file and how to modify the manifest see these guides Getting Started with Modules course Writing a Content Part Writing a Content Field Building a Hello World Module Theme manifest fields A theme manifest can have the following fields Field Name Description Name Provides a human readable name for a theme that is an alternative to using the theme s ID The ID of a theme is the name of the theme s folder in the virtual base path the default virtual base path is Themes and is used for programmatic references For example for a theme whose ID is Orchard Theme Contoso you might provide a name in the ma
568. tentShape Parts Map Edit gt shapeHelper EditorTemplate TemplateName Parts Map Model part POST protected override DriverResult Editor MapPart part IUpdateModel updater dynamic shapeHelper updater TryUpdateModel part Prefix null null return Editor part shapeHelper 454 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 The Editor method marked GET uses the Content Shape method to create a shape for an editor template In this case the type name is Parts Map Edit and the shapeHelper object creates an EditorTemplate shape This is a special shape that has a TemplateName property and a Model property The TemplateName property takes a partial path to the template In this case Part s Map causes Orchard to look for a template in your module at the following path Views EditorTemplates Parts Map cshtml The Mode1 property takes the name of the part s model file but without the file name extension Naming Shapes and Templates As noted the name given to a shape type binds the shape to the template that will be used to render the shape For example suppose you create a part named Map that displays a map for the specified longitude and latitude The name of the shape type might be Parts Map By convention all part shapes begin with Parts followed by the name of the part in this case Map Given this name Parts Map Orchard looks for a template in your module at the
569. ter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 gi So 0 orchard Microsoft WebMatrix E Mm Home Remote Source Control 7 EfOpen I E Add Existing a iF Sin ep Run Publith B 3 Restart New Paste orchard Cg App Data E bin Ca Config Dg Core Media C Modules Themes REDITS tet A Globalasas LICENSE txt _a Pefresh html _ Web contig yl Site Files Databases Tm Reports Logs Find Results Error List ua Replace H Find TN cm sign in f a g X View Launch Galleries Resources Create a new file Choose from one of many templates The first time Orchard is launched you see in your browser the Orchard setup screen 1 1 Installing Orchard T T T Read the Docs Template Documentation Release 1 9 2 Get Started Please answer a few questions to configure your site What is the name of your site My Orchard Site Choose a user name admin Choose a password Contirm the password How would you like to store your data amp Use built in data storage SQL Server Compact Use an existing SQL Server SQL Express database Use an existing MySql database Choose an Orchard Recipe Orchard Recipes allow you to setup your site with additional pre configured options features and settings out of the box Default The default recipe for an Orchard site that includes pages blogs custom content t
570. tever you want First things first You ll probably want to manage your settings and configure Orchard to your liking After that you can head over to manage themes to change or install new themes and really make it your own Once you re happy with a look and feel it s time for some content You can start creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few built in modules such as pages and blogs or themes If you re looking to add additional functionality you can do so by creating your own module or by installing one that somebody else built Modules are created by other users of Orchard just like you so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Second Leader Aside f Third Leader Aside Lorem ipsum dolor sit amet consectetur Lorem ipsum dolor sit amet consectetur Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor adipiscing elit Curabitur a nibh ut tortor adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh dapibus vestibulum Aliquam vel sem nibh dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Suspendisse vel condimentum tellus Suspendisse vel condimentum tellus Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboar
571. the Docs Template Documentation Release 1 9 2 NoteThe template extension can be any extension supported by an active view engine such as cshtml vbhtml or ascx From Template File Name to Shape Name More generally the rules to map from a template file name to the corresponding shape name are the following Dot and backslash change to underscore _ Note that this does not mean that an example cshtml file in a myviews subdirectory of Views is equivalent to a myviews_example chtml file in Views The shape templates must still be in the expected directory see above e Hyphen changes to a double underscore __ For example Views Hello World cshtml will be used to render a shape named He 110_Wor1d and Views Hello World amp 5 cshtml will be used to render a shape named Hello World 85 Alternate Shape Rendering As noted an HTML widget in the AsideSecond zone for example could be rendered by a widget cshtml template by a widget htmlwidget cshtml template or by a widget asidesecond cshtml if they exist in the current theme When various possibilities exist to render the same content these are referred to as alternates of the shape and they enable rich template overriding scenarios Alternates form a group that corresponds to the same shape if they differ only by a double underscore suffix For example He11o World Hello World 85 and Hello World DarkBlue are an alternate group for a Hello Worldshape Hello Worl
572. the pages should be kept in cache on the server Max Age 0 When defined a cache control header with a max age property will be added Use this in order to enable kernel cache on IIS Headers Ignore no cache headers When checked any request containing a Content Cache no cache header will still return cached values if available Vary Query String Parameters When defined using comma separated values sets caching to vary via specified query string parameters Vary Request Headers When defined using comma separated values sets caching to vary via specified request headers Ignored urls Change History Updates for Orchard 1 8 9 8 14 Updated screen shots for dashboard settings Added cache section Updates for Orchard 1 1 3 29 11 Added sections for new screens in the dashboard Updated existing screen shots 3 4 5 Moderating Comments The Comments feature of Orchard provides the ability to monitor and manage the comments for content items on your site This topic describes two sets of tools that Orchard provides for working with site comments tools for managing existing comments and site level settings for comments Managing Comments To access the comment management screen click Comments on the Orchard dashboard 198 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Your site Comments User admin Logout Actions Chaose action Y Choose action Approve
573. the root of the Maps module project This file defines the information about your module such as a name description version author and a categorized of features exposed by the module The Module txt file can also contain additional information such as dependencies which we will not cover here Our module is pretty simple and only contains a single Maps feature with no additional dependencies Edit the Module txt file as indicated below Name Maps AntiForgery enabled Author The Orchard Team Website http orchardproject net Version 1 0 0 OrchardVersion 1 0 0 3 9 Extending Orchard 361 Read the Docs Template Documentation Release 1 9 2 Description Adds a map image to content items based on longitude and latitude Features Maps Description Adds a map image to content items based on longitude and latitude Category Geolocation Now let s begin to write the Map part To begin with we need a class to contain the data for the part Data classes are conventionally added to the Models folder of the project Right click the Models folder in Visual Studio and choose Add gt Class from the context menu and name the new file Map cs UA Maps 34 Properties i References Content Controllers Models Convert to Web Application Scripts Check Accessibility C3 Views oe 3 Module tet z New Item Ctrl Shift A Add i Web config zs Existing Item Shift Alt A Exclude From Proje
574. the root of your site for the service account that is being used as the IIS appli cation pool identity However you should remove the write permissions on a production server Accessing and Enabling the Gallery The gallery feature is enabled by default in Orchard When the gallery is enabled a Gallery tab appears at the top of the both the Themes screen and the Modules screen in the dashboard Themes Installed Gallery Updates 0 Note If the gallery feature has been disabled there will be no Gallery tab visible in the Themes or Modules dashboard screens To enable the gallery click Modules in the dashboard find the gallery feature and then click Enable on the feature Installing a Theme from the Gallery To access the gallery for themes click Themes in the dashboard On the Themes screen click the Gallery tab A set of themes appears with a pair of Install and Download links next to each theme 158 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Themes User admin Logout Installed Gallery Updates 0 Show All feeds r Sorby Downloads Search Dark Version 1 0 22 Install Download Dark is a highly flexible theme based in shades of black And if you are looking for further customization of this theme discover Bind Tuning our online configuration tool Create a fully customized Dark theme in just a few clicks just like if you had a design team working for you visit httpz
575. themes Ef you re looking to add additional functionality you can do so by ting your own module or by installing one that somebody else built Modules are created by er users of Orchard just like you so if you feel up to it please consider participating Thanks for using Orchard The Orchard Team 264 Chapter 3 Documentation Beta WEBSITE gt Home Welcome to Orchard Apr amp 2011 3 13 PM Read the Docs Template Documentation Release 1 9 2 Edit You ve successfully setup your Orchard Site and this is the homepage af your new site Here are a few things you can look at to get familiar with the application Once you ael confident you don t need this amore you can remove i by going inta editing mode and replacing it with whatever you want First things first You ll probably want to manage your settings and canfigure Orchard to your liking After that you can head over ta manage themes to change ar install new themes and really make it pour own Once you re happy with a look and feel it s time far some content You can start creating new custom content types or start fram the built in ones by adding a page or managing your Finally Orchard has been designed to be extended It comes with faw built in modules such as pages and blogs or themes IF yau re looking to add additional functionality you can do so by creating your own module ar by installing one that somebody else built Modules are created by other users of Orchard j
576. there is a model M for the data a controller C that orches trates the UI and determines how it operates on the model and a view V whose only responsibility is to display what the controller hands it In the case of our Hello World module we won t have any data so the model will be of no concern to us We will just have a controller and a view All the rest will be some necessary plumbing to declare what we re doing to Orchard We will come back to these concepts and recapitulate once we ve built our module Modules in Orchard are sets of extensions that can be packaged in order to be re used on other Orchard sites Modules are implemented as MVC Areas Areas in MVC are sub sites that contain a set of features that act in relative isolation from the other parts of the site An Orchard module is simply an area with a manifest file It may use Orchard APIs but it doesn t necessarily have to Generating the Module Structure Before you can generate the file structure for your module you need to download install and enable the Code Generation feature for Orchard For more information see Command line Code Generation Once you have code generation enabled open the Orchard command line and create the HelloWorld module with the following command codegen module HelloWorld Modifying the Manifest You should now have a new HelloWorld folder under the Modules folder of your Orchard web site In this folder you ll find a module txt file
577. tibulum Aliquam vel sem nibh dapibus vestibulum Aliquam vel sem nibh dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Suspendisse vel condimentum tellus Suspendisse vel condimentum tellus Powered by Orchard The Theme Machine 2010 Welcome admin Sign Out Dashboard 1 3 4 Running your website from Web Matrix At any point in time you can run your website from WebMatrix by selecting the project node and clicking Run 30 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 e 0e Orchard CMS Microsoft WebMatrix p EN Home Remote B Stop Requests Extensions Restart a Orchard CMS Orchard CMS B 1 1 mmu Requests 1 3 5 Working with Files You can use WebMatrix to edit the files in your Orchard installation WebMatrix provides a simple editor that includes colorization for HTML CSS JavaScript and code files Although WebMatrix does not provide a build system for compiling code files Orchard itself provides dynamic com pilation for code files when they are edited For more information see Orchard Dynamic Compilation 1 3 Working with Orchard in WebMatrix 31 Read the Docs Template Documentation Release 1 9 2 s ld i I Orchard CMS Microsoft WebMatrix o E File Home Remote v Start jus aen dp Cut E m 4 W Stop iY Add Existing j Copy ah Aes Restart dia 25 Close All dois Lana MN Launch as prout Site Files Cli
578. tion of the application and its modules is done by wrapping string resources in a call to the T method aT This string can be localized See Using the localization helpers for more details and guide lines Orchard s resource manager can load localized resource strings from PO files located in specific places in the application Content item localization is done through a different mechanism localized versions of a content item are physically separate content items that are linked together by a special part The current culture to use is determined by the culture manager The default implementation returns the culture that has been configured in site settings but an alternate implementation could get it from the user profile or from the browser s settings 282 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Logging Logging is done through a dependency of type ILogger Different implementations can send the log entries to various storage types Orchard comes with an implementation that uses Castle Core Logging for logging Orchard Core The Orchard Core assembly contains a set of modules that are necessary for Orchard to run Other modules can safely take dependencies on these modules that will always be available Examples of core modules are feeds navigation or routable Modules The default distribution of Orchard comes with a number of built in modules such as blogging or pages but third party modu
579. tion story ex alert Foo badArgument Foo badArgument Teh argument was bad Don t worry about string concatenation unless you have specific evidence that regular concatenation is signifi cantly harming performance in your specific scenario e Use the K amp R style for opening braces put the opening brace on the opening line This is because in JavaScript the semicolon is optional which can cause difficult to spot bugs see http msmvps com blogs luisabreu archive 2009 08 26 the semicolon bug aspx for an example 3 12 6 Continuous Integration There are currently two builds configured Continuous Builder that runs on every check in and Full Build that runs nightly They are currently identical but eventually the nightly will also run functional tests Code Coverage Code coverage data is being generated with each run of both builders The code coverage data can be viewed by clicking the Code Coverage tab of the project or by going into the artifacts tab and downloading the source and coverage zips that can then be used from the NcoverExplorer to explore code coverage to the level of the line of code 3 12 7 Merging Pull Requests Challenges of integrating a Pull Request When a Pull Request has been reviewed and is ready to be merged it s usually marked with a GG comment meaning Good to Go At this point any dev with commit rights should be able to merge it in the main repository However we might need to
580. tion to define how the part is added to a type 3 10 3 Built in filter types e StorageFilter class Takes care of persisting the data from repository object to the database Its usage is shown in the example above e ActivatingFilter class Attaches a part to a content type from code As opposed to attaching parts via migrations parts attached using this filter will neither be displayed in the Dashboard nor users will be able to remove them from types It s a legitimate way of attaching parts that should always exist on a given content type 3 10 4 Lifecycle Events In addition to defining the repository you can add code for handling events You use the following methods to add the code that is executed for the event e OnActivated e OnCreated e OnCreating e OnDestroyed e OnDestroying e OnGetContentItemMetadata e OnGetDisplayShape e OnGetEditorShape e OnIndexed e OnIndexing OnInitialized Oninitializing 3 10 Working with Data 431 Read the Docs Template Documentation Release 1 9 2 OnLoaded OnLoading OnPublished OnPublishing OnRemoved OnRemoving OnUpdated OnUpdateEditorShape OnUpdating OnUnpublished OnUnpublishing OnVersioned OnVersioning For example the TagPartHand1ler class contains code to take action for the Removed and Indexing events as shown in the following example public class TagsPartHandler ContentHandler public TagsPartHandler IRepository TagsPartRecord repository ITagService tag
581. tion we should consider please post it to OrchardGallery CodePlex com 3 3 4 Contributing a Module or Theme to the Gallery Have you created an Orchard module or theme that you want to share with other Orchard users The Orchard Gallery makes this easy and you can always update and manage your contributions to the gallery as you have new versions to share or when you want to make changes to existing contributions To get started click on the Contribute tab of the gallery site L Pa Orchard gallery Home tere MES Themes Contribute DETCHARD HOME CUA L5 ON E e A EE Iri Contribute to Orchard Gallery Add New Module or Theme Upload and publish your package for other Orchard users to download and enjcy You can upload Get Started multiple Pens os the zamie package 25 long ur That wertion iz dd Terent ls your module the best Manage My Contributions thing since sliced bread Is your theme going to start a revolution Create an Register Package Id account and contribute Grab Ect contaboutionm detads or Remove contribution that yeu have preeacusly uploaded Grab a era names Tor your module that you intend ba Peis j Already have an account Sign in and contribute Creating a User Account To submit a module or theme to the gallery you must first create a user account on the gallery Click the Sign In link in the header area of the site to
582. tionary of strings to values of the field s type whereas the content type is a list of part types without names This gives another way of choosing between part and field if you think people would want more than one instance of your object per content type it needs to be a field Anatomy of a Content Type A content type as we ve seen is built from content parts Content parts code wise are typically associated with a Record which is a POCO representation of the part s data e a model class that is the actual part and that derives from ContentPart T where T is the record type arepository The repository does not need to be implemented by the module author as Orchard will be able to just use a generic one 3 9 Extending Orchard 279 Read the Docs Template Documentation Release 1 9 2 handlers Handlers implement IContentHandler and are a set of event handlers such as OnCreated or OnSaved Basically they hook onto the content item s lifecycle to perform a number of tasks They can also partici pate in the actual composition of the content items from their constructors There is a Filters collection on the base ContentHandler that enable the handler to add common behavior to the content type For example Orchard provides a StorageFilter that makes it very easy to declare how persistence of a content part should be handled just do Filters Add StorageFilter For myPartRepository and Orchard will take care of persisting to t
583. to any content type Populating the State Table Note this section is included for completeness of the sample code but is far from essential to understand ing how to implement relationships in Orchard Please consider it as sample data generation If you re following along and want to import this data you can find code in the migrations cs file This is included in the downloadable source code example link at the end of this guide Because the list of states is going to be relatively stable I did not make them content items although that would be entirely possible with just a little more work Instead I m populating the table with a list of states right in the migration code The migration class has a reference to the state repository private readonly IRepository lt StateRecord gt stateRepository Le public RelationSampleDataMigration IRepository StateRecord stateRepository _stateRepository stateRepository It also has the list of states to add to the database private readonly IEnumerable lt StateRecord gt _states new List lt StateRecord gt new StateRecord Code UAL Name Alabama new StateRecord Code AK Name Alaska eer new StateRecord Code WS Name Western Australia The population of the table is done by the following code public int UpdateFroml if _stateRepository null throw new InvalidOperationException Couldn t find state repository f
584. to the server before installing Install a theme from your computer Theme Package Install Your new theme appears under Available 3 11 Creating Themes se File No file chosen 471 Read the Docs Template Documentation Release 1 9 2 Themes User admin Logout 472 Installed Gallery Updates 0 Current Theme Theme Machine The Theme Machine x By jowall mibach loudej heskew og E http orchardproject net os Po Orchard Theme Machine is a flexible multi zone theme ES that provides a solid foundation to build your site It n mI features 20 collapsible widget zones and is flexible ee O m enough to cover a wide range of layouts Available Install a theme from my computer iE MyFirstTheme n Wieltoma t Orchard Fee i kep bab birep a E a d Lr sul ben ma pien Bee pcr bere hiyi leer ber pah ers aor pe den you des oie T eT Oui CM Ciel TE En ice E G oh ma oly ae ashram e ROG bma epi ep ere er ee cad ee dun B cc p a cT Peta LDTIIIT NE pi dai ee e E aja Pea e Te IL LLLI LU IL T ee SN LI td T ETE bruer arie Pea Lar iaj ee eee eee ou ed ndum nm Mik a Dy nf Bi on baji Peai ede ee re Fan lpp ua bee gee Ee E A a a A a Bahh et a pgi h l ee s F i E h da ai Ti IE L katraa yma mr fm en iry marier mrt eee ruines 2 oem Pai eS us TE ey pra eee Poe sar ey le ia ee d LI ITI By The Orchard Team Version 1 0 Description for the theme http www orchardproje
585. topics that aren t covered here Note You do not have to click the Enable link to carry out the other operations on themes such as previewing a theme or setting the current theme 148 00000000000 Qhapter3 Documentation Read the Docs Template Documentation Release 1 9 2 Previewing and Applying Themes To experiment with the theme features click Preview on an available theme The following illustration shows a site in preview mode for the Contoso theme The drop down list lets you preview other themes Cancel um m 7 Er j T 7 P Fa L E r re Pyare A e E Ir le Welcome admin Sign Out Dashboard A c y MU M Welcome to Orchard You ve successfully setup your Orchard Site and this is the homepage of your new site Here are a few things you can look at ta get familiar with the application Once you feel confident you don t need this anymore you can remove it by going into editing mode and replacing it with whatever you wart First things first You ll probably want to manage your settings and configure Orchard te your liking After that you can head over to manage themes to Change or instal new themes and really make it your own Once youre happy with a look and feel it s time for some content You can start creating new custom content types or start from the built in ones by adding a page or managing your menus Finally Orchard has been designed to be extended It comes with a few bu
586. torage mechanism dynamically for the cache data as distributed setups where more widely used This is why there are two distributed storage provider one based on the Database and the other one based on Memcached Here is the set of related modules e http orchardcache codeplex com https bitbucket org sebastienros contrib cache database e https bitbucket org sebastienros contrib cache memcached Not a single Orchard website should go into production without this module Not only does it improve responsiveness but also throughput and finally it frees your CPU from unneeded cycles Using the Max Age setting you also enable IIS Kernel caching plus public proxy cache which makes your application even faster You can get thousands of requests per seconds with a very small server Business Data Caching Using Orchard Caching Because of the limitations of the CacheManager in terms of distributed caching another set of modules was necessary to cache business data which has to be shared across servers This module can set and get entries by a key only and invalidate by name or time This is the only requirement for storage providers in this module which allows its usage on farms This is implemented in e https bitbucket org sebastienros orchard caching https bitbucket org sebastienros orchard caching memcached Why Memcached Implementing Memcached providers by default is done for a specific reason which is that Azure Caching Ser
587. triaged and should have been assigned a release The release usually is one of the planned releases Planned releases are usually the ones we are currently working on plus a Future Versions release that we use for bugs and features that we want to handle but don t think we can do in the current cycle The Assigned to field is only set when the bug is scheduled to be fixed in the current iteration or cycle If it s in Future Versions it is usually unassigned Impact is usually set during triage but a Low value does not necessarily mean much this is the default value so it might just mean that it hasn t been touched It s OK to investigate with the team on the impact of a bug you care about Developer Troubleshooting Record Names Your implementations of the ContentPartRecords shouldn t have properties that are known keywords to NHibernate Examples include Identity Version 3 12 Developer Tools and Guidelines 485 Read the Docs Template Documentation Release 1 9 2 3 12 2 Setting Up a Source Enlistment Enlisting in the Source Code Using Git and Git Extensions The Orchard project source code is hosted on GitHub and can be accessed using a Git client This page explains how to set up your development environment This setup allows you to work on the project as a developer fix issues build your own site from it or build modules When using a distributed source control system such as Git it s important to understand that
588. ts for third party software You are responsible for and must separately locate read and accept these third party license terms Orchard CMS 11 34 MB a Direct Download Link Total Download Size 11 34MB I Decline A new subfolder Orchard CMS will be added to your My Websites folder Click OK Your Orchard site will then be opened in Web Matrix and the Orchard Setup page will be launched in a new browser window 1 3 Working with Orchard in WebMatrix 27 Read the Docs Template Documentation Release 1 9 2 s ld gi v C Orchard CMS Microsoft WebMatrix Home Remote T m o o B Stop Run Publish Requests Extensions Admin Add Add Restart Module Theme Galleries Resources a Orchard CMS Orchard CMS ER Requests Settings URL http localhost42861 Path C Users Karen Documents My Web Sites Orchard CMS Getting Started with Orchard Welcome to the Orchard community We want your experience with your new site to be as smooth as possible Please read this to get started site Free Pluralsight Training on Orchard Watch Pluralsight s free introduction to Orchard course Files Datab i databases More documentation We have documentation available on a variety of topics Reports Enter basic information about your site on the Orchard Setup page Specifically the name of the site the name of a user of the site the user s password the kind of database
589. ttings section and then click Gallery 178 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 The Gallery Feeds screen displays currently registered feeds Title Url Orchard Gallery http packages orchardproject net FeedService svc As the illustration shows by default an Orchard site provides a single registered gallery feed from http packages orchardproject net FeedService svc You can add feeds or delete existing feeds To register an additional feed click the Add Feed button In the Add a Feed screen enter a URL and then click Add Feed Add a Feed User admin Logout Feed Url Note For information about publishing a module or theme to the default Orchard gallery feed visit the gallery website To learn how to create and expose a custom gallery of themes or modules see the reference implementation of a gallery website at OrchardGallery CodePlex com and Gallery Server CodePlex com To view the contents of a feed in your browser click the feed link in the Gallery Feeds screen If you are using Internet Explorer and it renders the gallery instead of displaying the feed contents go to Internet Options and turn off the feed reading feature 3 3 Using the Orchard Gallery 179 Read the Docs Template Documentation Release 1 9 2 lt xml version 1 0 encoding UTF 8 standalone true gt lt service xmlnsz http www w3 org 2007 app xmlns appz http www w3 org 2007 app xmlns atomz h
590. ttings section of the admin 3 13 Additional Topics 503 Read the Docs Template Documentation Release 1 9 2 Email Sender email address admin yourdomain com The default email address to use as a sender Host name smtp yourdomain com The SMTP server domain e g smtp mailprovider com Port number 25 The SMTP server port usually 25 Check if the SMTP server requires SSL communications W Require credentials User name admin yourdomain com The username for authentication Password The password for authentication 504 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Emails can be sent from the local host with the below settings be sure to replace the from address with an appropriate email address Settings updated Email Sender email address admin yourdomain com The default email address to use as a sender Host name 127 0 0 1 The SMTP server domain e g smtp matlprovider com Port number 25 The SMTP server port usually 25 Enable SSL communications Check if the SMTP server requires SSL communications Require credentials Save And that s it Well mostly Orchard is capable of sending emails now but how do we tell it to send email There s 3 13 Additional Topics 505 Read the Docs Template Documentation Release 1 9 2 different reasons when it would be desirable for emails to be sent one such reason would be when a new message is rece
591. ttlenecks can include a fragmented file system or a congested network connection to a NAS Checking the speed of the file system and then optimizing it can be a way to get better performance Memory The more memory is available on a server the better it will perform If you can afford it increasing memory might be among the most efficient ways of improving performance assuming it s properly configured Increasing processing power is more expensive and often has a lower return on investment App Pool Recycling If you have access to IIS settings and if your site has few hits over extended periods of time consider increasing the default value for app pool recycling This can be done by going into IIS Manager going to Application Pools selecting the app pool for your application and clicking Recycling 3 5 Hosting and Deploying Websites 241 Read the Docs Template Documentation Release 1 9 2 Cy Application Pools This page lets you view and manage the let of application pools on the server Application pools are associated with worker processes contain one or more applications and provide isolation among different applications Application Pool Tasks Filter Go ie yShow All Groupby No Grouping b Start V Regular time intervals in minutes Fixed number of requests 1 3 Example 8 00 PIM 12 00 AM wirtual memory usage in KE Private memory usage n KB Removing the tim
592. ttp www w3 org 2005 Atom xml basez http packages orchardproject net FeedService svc workspace lt atom title gt Default lt atom title gt lt collection href Packages gt lt atom title gt Packages lt atom title gt lt collection gt lt collection href Screenshots gt lt atom title gt Screenshots lt atom title gt lt collection gt lt workspace gt lt service gt Change History Updates for Orchard 1 8 9 04 14 Updated the gallery feed and the screen shots Updates for Orchard 1 1 3 23 11 Updated screens and UI options for registering feeds 3 4 Managing Websites 3 4 1 Enabling and Disabling Features You can add additional functionality to your site by enabling and disabling features exposed by the modules that are installed to Orchard To view the available features click Features under the Modules heading in the Orchard admin panel User admin Logo 39 Oe ENV aa Modules Installed Recipes Gallery EJ Dashboard New Filter Actions Choose action Es Content Content Content Definition Alias Disable Alias UI Enable Archive Later Enable D Blog Y Queries EI Comments Taxonomies amp Widgets 4 Media 2 Navigation amp Tags Modules E Themes a Workflows Lists 3 Users fi Reports Maps friendly urls to specific module actions Autoroute Disable Enables the Autoroute part for tokenized routing Depends on
593. tures that Orchard has to offer provided as a step by step guide If this is your first time using Orchard this document is for you 1 5 1 Getting Started with Orchard Being new to Orchard you should know the right place where you can find the resources and latest information about Orchard 1 Orchard Beginner 2 Orchard in GitHub Orchard Code Repository 3 Orchard Discussion Forum Discussion area for Orchard 4 Orchard Documentation Documentation area for Orchard 5 Orchard Community Websites Community sites on Orchard from all over the world 6 Orchard CMS Weekly Meeting This topic assumes that you have already installed Orchard and set up your website If you haven t follow the instructions in Installing Orchard There are plenty of options to get up and running with Orchard without installing Orchard on your local machine or local IIS Server 1 5 2 Try Orchard Try Orchard is a showcase for the Orchard content management framework you can try how Orchard feels by checking out an already running demo site where you can play with Orchard as you wish No registration no setup nothing required you can just go to Try Orchard open one of the continuously re installed demo sites and play with it This is the simplest way of taking the first steps with Orchard Be aware though that Try Orchard is really just for testing since the demo sites are wiped out hourly you don t try to publish your blog there 15 Getting St
594. tween words in selectors Remove unused CSS selections except for reset styles Use lowercase for color definitions Use shorthand notation where possible such as for color codes use collapsed properties when practical Use IDs instead of classes where possible Using IDs for template elements makes it easy to identify the important selectors in CSS and HTML Use one line per property definition Use tab nested selectors For more information see CSS DIY Organization CSS File Structure The recommended CSS structure was partly adapted from suggestions provided by Dan Cederholm of SimpleBits This structure resides in the Style css file The file comprises the following sections l 10 3 11 Info A commented section for the theme that the style is associated with the author website and any copyright information Color Palette A commented section that defines the overall color scheme for the theme It provides a single place to define colors and makes it easy for users to find replace and modify color definitions Reset Definitions that are used to normalize settings across browsers Clearing Floats Definitions that are used to clear parent items that contain children that float Typography Optional Contains CSS code or a reference to a typography reset framework such as YUI Fonts that normalizes font sizes across browsers General Definitions for global HTML elements such as b
595. tweight Enabled Orchard Search Disabled Orchard Setup Disabled Orchard Tags Enabled Orchard Themes Enabled Orchard Users Enabled Orchard Widgets Enabled PackagingServices Enabled Profiling Disabled Reports Enabled Routable Enabled SafeMode Disabled Scheduling Enabled Settings Enabled Shapes Enabled TheAdmin Disabled TheThemeMachine Enabled TinyMce Enabled XmlRpc Disabled Batched or scripted Commands There are two specific Non interactive modes single command and response file Each allow for useful batching of commands in a non interactive context Commands still need to have been enabled and orchard exe still needs to be launched from the correct location for each command type Single Command Single command is exactly as you would expect A single command can be run and the or chard exe tool will exit directly after completion From the Orchard Web bin path orchard package create Orchard Blogs c temp Response File A response file simply contains a series of lines each one representing a command to be executed This is an excellent way to run multiple commands without the large footprint of the orchard context initialisation Example response file text myfile txt package create Orchard Blogs c NNtempNN package create Orchard Users c temp To execute this response file run the orchard exe in the single command mode as above but note the prefix
596. tyle formatting Don t try to concatenate them For example if you had a snippet that looked like this lt p gt Today s featured product is the Model ProductName lt p gt 3 9 Extending Orchard 331 Read the Docs Template Documentation Release 1 9 2 The correct way to format this would be lt p gt T Today s featured product is the 0 Model ProductName lt p gt Don t use concatenation because the position of the variable might change in different translations This is BAD lt p gt UT You have Model SmsCredits GT credits left p This is GOOD lt p gt T You have 0 credits left Model SmsCredits lt p gt Let s update the front end view so that it follows the correct localized development best practices 1 Open Views Parts FeaturedProduct cshtml 2 Wrap each of the four blocks of text in their own T calls if Model ContentPart IsOnSale 9 T CON SALE In the model class we used the DisplayName attribute on the TsOnSale property The DisplayName is an ASP NET MVC attribute which allows you to automatically inject a descriptive label into your UI Unfortunately Orchard s localization system doesn t intercept this information so when creating localized labels we need to pass the display name in each time There is a pull request currently being discussed for this issue which will hopefully bring in a LocalizedDisplayName attribute that will solve this issue To local
597. u delete a submission you will lose the download count history for that package version To see all of the packages that you previously uploaded to the gallery visit the Contribute tab and click the Manage My Contributions link ORCHARD ROME JOIM US ON E Orchard gallery Home Modules Themes Contribute A Saar Iri Contribute to Orchard Gallery Add New Module or Theme Upload and publish your package for other Orchard users to download and enjcy You can upload multiple revisions of the came package as long at the version is diferent Get Started Is your module the best thing since sliced bread Is your theme going to start a revolution Create an Register Package td account and contribute Manage My Contributions L Et conbibution details or Remove contribution that yeu his priecurly uploaded Grab a recen names Tor your module had you intend bo upteuas Already have an account Sign in and contribute 176 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Assigning Additional Owners to a Package By default you will be the only owner for packages that you contribute and only you can edit delete or manage owners for the package However by assigning additional owners you can grant permissions to other users of the gallery to perform these operations on your package too Be careful that you trust users you grant ownership rights as they will be able t
598. u download install and manage modules and features on your site For more information see Installing Modules and Themes from the Gallery Enabling and Disabling Features and Installing and Upgrading Modules Themes Lets you install new themes and apply themes to your site For more information see Installing Themes and Previewing and Applying a Theme Workflows Lets you manage your workflows Through workflows your site can perform simple or complex tasks based on system events or user interaction Users Lets you manage users and roles for your site For more information see Managing Users and Roles Reports Lets you manage and view reports that Orchard generates for your site Settings Lets you configure a variety of site settings such as the site name and culture the default number of items per page URLs for Gallery feeds whether user added comments must be approved media file types that can be uploaded and user registration settings For more information see Modifying Site Settings Change History Updated for Orchard 1 8 38 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 4 20 14 Updated screenshot Updated available settings on 1 8 Updated for Orchard 1 1 3 15 11 Updated screen shot and table to show 1 1 version of the dashboard 1 5 Getting Started with Orchard This topic targets and was tested with the Orchard 1 8 release This walkthrough provides a glimpse of the fea
599. u use website recipes A recipe is an XML file that contains the startup configuration for an Orchard website When you start Orchard for the first time you can select a recipe that best matches the type of site you want to set up For example if you want your website to be a blog you can select the Blog recipe and much of the configuration work will be done for you You can create your own recipes and customize the process of setting a website and configuring Orchard features Recipes can also instruct Orchard to download and install modules and themes from the Orchard Gallery during website setup This article describes how to use recipes how to create custom recipes export or import recipes and how to create a specialized distribution of Orchard using recipes Using a Recipe to Create a Website When you first set up an Orchard website the setup page that is displayed contains a list of recipes You can choose a recipe to base your new website on 3 4 Managing Websites 209 Read the Docs Template Documentation Release 1 9 2 9 Welcome to Orchard Get Started Please answer a few questions to configure your site What is the name of your site My Site Choose a user name admin Choose a password ELELEE Confirm the password ELELEE How would you like to store your data Use built in data storage SQL Server Compact Use an existing SQL Server or SQL Express database Choose an Orchard Recipe
600. u want to display Tip Use ctrl click to select multiple images at once Then click the Select button in the lower left of the modal it s a bit hidden The Add Widget page will again display Click Save Visit the front end of your site to see the scaffolding of an image gallery Customize the Look of the Gallery Turn on Shape Tracing 3 4 Managing Websites 221 Read the Docs Template Documentation Release 1 9 2 Create an Alternate for the Fields_MediaPickerLibrary e Edit the HTML and add CSS Here are example alternate templates courtesy of Bertrand Le Roy s Codeplex Reply Fields MediaLibraryPicker cshtml using Orchard ContentManagement using Orchard MediaLibrary Fields Qusing Orchard Utilrby Excensrons var field MediaLibraryPickerField Model ContentFielg string name field DisplayName var contents field MediaParts section class media library picker field media library picker field iname HtmlClassify foreach var content in contents lt div gt Display BuildDisplay content Summary lt div gt lt section gt Media Summary cshtml using Orchard MediaLibrary Models using Orchard Utility Extensions MediaPart mediaPart Model ContentItem MediaPart lt a href mediaPart MediaUrl gt lt img src Display ResizeMediaUrl Width 200 Height 200 Mode crop Alignment alt mediaPart Caption class thumbnail gt x a
601. uTTY When installation has completed you will find that you have extra Git Ext options when you right click in Windows Explorer Documentati n Attachments Setting up a source enlistment git ext context menu png Step 2 Enlist in the Source Code Using Git Extensions In Windows Explorer navigate to the local directory where you want your copy of the source code to live right click and choose GitEx Clone 486 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Home Share View L Local Disk Sources v Cj Search Sources E Sort by Group by Refresh Customize this folder Paste Paste shortcut Undo Rename Ctrl Z HE GitEx Clone m GItEx Create new repository a Git Extensions Share with s Hg Workbench a TortoiseHg SVN Checkout 4 TortoiseSVN New Properties In the clone window you have four fields to fill out e Inthe Repository to clone field type https github com OrchardCMS Orchard e The Destination field will already be filled out with your current directory When you paste the repository url it will also fill out the Subdirectory to create field If you want to change this to a project name you can e Selecting the Branch dropdown will show you all of the current branches This is loaded from GitHub so it may take a few seconds to load the list For the latest stable branch select master The rest of the settings can be left as is Click Clone 3
602. udio it is not strictly necessary to have Visual Studio to develop a content part feel free to use your editor of choice In this tutorial we are going to build a custom Map part that can be configured with latitude and longitude values in 358 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 order to display a map image for a content item Important Before you can generate the file structure for your module you need to download install and enable the Code Generation feature for Orchard For more information see Command line Code Generation We are going to add a new Maps module to contain our Map part implementation as a new project in the Orchard solution Assuming you have enlisted in the Orchard source tree launch Visual Studio 2010 and open the Orchard sIn file under the src folder of your enlistment 3 9 Extending Orchard 359 Read the Docs Template Documentation Release 1 9 2 Solution Explorer a 4 l Solution Orchard 33 projects 4 Futures 4 2 Modules EA Lucene EA Orchard Blogs i Orchard Comments A Orchard ContentTypes i Orchard DevTools 4 Orchard Indexing i33 Orchard Media EA Orchard Modules EA Orchard MultiTenancy i Orchard Packaging EA Orchard Roles EA Orchard Sandbox GA Orchard Search EA Orchard Setup i Orchard Tags EA Orchard Themes i Orchard Users 53 TinyMce L4 Tests pP L3 Tools B Orcha
603. ull source code enlistment are being used in this topic It is possible to build this module without it by simply manipulating the csproj file and adding the relevant files in there Please consult Creating a module with a simple text editor for an example of module building without Visual Studio Objectives Learn the steps to add a new field type to Orchard The goal is to have a Date and Time editor so that any existing or new Content Type can let the user select a Date or a Time very easily Orchard Edit Event Dashboard v Blogs Title Create New Blag Merd dinner v Content Permalink Manage Content http localhost 90 nerd dinner Manage Content Types Create Event 8 10 2010 10 30 AM Create Page 01 Ot 03 Od 05 DS oF DOR 05 10 11 12 v a gs oo 15 30 45 Manage Te AM PM v Comments Creating a Module We will create the new field type inside a new Orchard module so that it can be easily distributed We will use Code Generation feature for that Important Before you can generate the file structure for your module you need to download install and enable the Code Generation feature for Orchard For more information see Command line Code Generation Once the Code Generation feature has been enabled you can type the following codegen command on the Orchard command line codegen module CustomFields IncludeInSolution true This should create a new CustomFields folder under Modules pre populated with a few folders an
604. umentation Release 1 9 2 Edit Media bread jpg User admin Logout Media Folders gt Htmlwidget gt Pictures gt Edit Media Size 99 KB Added on 3 16 2011 4 16 59 PM Embed lt img src Media Default HtmlWidget Pictures bread_jpa h Copy this html to add this image to your site Mame bread jpg 1 8 1 Change History Updates for Orchard 1 1 3 16 11 Updated all screen shots and menu choices text 1 9 Managing Widgets In Orchard a widget is a fragment of UI such as HTML and code such as a content part that can be easily mapped to any location or zone in the active theme such as a sidebar or footer zone Examples of widgets include navigation menus image galleries ads videos and tag clouds This article explains the basics of widgets and shows you how to manage them 90 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 1 9 1 Layers Zones and Widgets In Orchard you manage widgets by clicking Widgets in the dashboard The Widgets screen lists the available widgets and lets you assign the widget to a ayer and a zone You can think of a ayer as a set of rules for displaying a widget or group of widgets For example a layer might display a widget on a specific page only if the user is logged in A zone helps to position a widget on a page The following image shows the Widgets screen Your Site Widgets User admin Logout Current Layer Default
605. urly brace here extra space to write additional lines of code here return shapeHelper Parts FeaturedProduct return keyword and semicolon curly brace here An alternative solution to expanding out this Display method would have been to do our preparation at the start of the method something like this protected override DriverResult DisplayCat FeaturedProductPart part string displayType dynamic shapeHelper extra code here return ContentShape Parts FeaturedProduort gt shapeHelper Parts FeaturedProduct What s the difference and why is this a bad idea The Display method gets called to prepare the shapes each time a visitor requests a page With the modularity of the Orchard code you might still end up having something else on the page influencing it s display so that the shape doesn t make it to the final output When the setup code is passed within the lambda it doesn t get run until it s actually needed This means that if you need to do some expensive setup code you don t want to run it unless you re sure it s going to be used In this context expensive means heavy resource usage it could require complicated database calls or data crunching or time consuming you might rely on calling a 3rd party web service to get some information You don t want to waste your resources and slow down the page being displayed by running unnecessary setup code so that s why you shoul
606. ust like you 26 if you feel up to it please consider participating Thanks for using Orchard The Orchard Team First Leader Aside Lorem ipsum dolor sit amet consectetur adipiscing e Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Ed Second Leader Aside Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortar dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Edit Third Leader Aside Lorem ipsum dolor sit amet consectetur adipiscing elit Curabitur a nibh ut tortor dapibus vestibulum Aliquam vel sem nibh Suspendisse vel condimentum tellus Edit Powered by Orchard The Theme Machine 2010 Welcome admin Sign Qut Dashboard You can take a tenant site offline at any time Under List of Site s Tenants for your default site click Suspend for the site you want to take offline List of Site s Tenants User admin Logout Add a Tenant Suspend Edit Edit Alpha http alpha localhost 14964 Beta http beta localhost 14964 Default http localhost 14964 3 8 Using Windows Azure Cache 265 Read the Docs Template Documentation Release 1 9 2 To bring the tenant site back online click Resume Removing Tenants Currently there is no UI to remove a tenant but it can be done by going to the App_Data Sites directory of the site locating the subdirectory for the tenant to r
607. ve been added by the code generation command Compile Include Migrations cs Navigate to the Features screen in the dashboard You see a warning that indicates that one of the features needs to be updated and the Simple Commerce module is displayed in red Click Update to ensure that the migrations are run and that the module is up to date Adding a Handler A handler in Orchard is analogous to a filter in ASP NET MVC It s a piece of code that is meant to run when specific events happen in the application but that are not specific to a given content type For example you could build an analytics module that listens to the Loaded event in order to log usage statistics To see what event handlers you can override in your own handlers examine the source code for ContentHandlerBase The handler you need in the module is not going to be very complex but it will implement some plumbing that is necessary to set up the persistence of the part We hope that this kind of plumbing will disappear in a future version of Orchard possibly in favor of a more declarative approach such as using attributes Create a Handlers folder and add a ProductHandler cs file to it that contains the following code using Orchard ContentManagement Handlers using SimpleCommerce Models 354 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 using Orchard Data namespace SimpleCommerce Handlers public class ProductHandler
608. vices are binary compatible with it So this implementation works by default on both custom Memcached servers and also Azure services 3 9 14 Custom Site Settings Sometimes you may need to persist some global settings eg license code service login default width etc to be reused across your module Orchard makes it really simple and I ll show you how to do it Basically there are two scopes you can define your settings in 1 Site scope for global site settings 2 Content type scope for settings common to all items of a given type eg a Page a Blog a BlogPost and so on Defining site scope settings Orchard 1 8 Onwards Orchard 1 8 drastically simplifies creation of site settings removing the previous need for Part Records and mi gration files To create new site settings for your module you now only need three classes A ContentPart a Handler and potentially a view file if you want the settings to be edited via the Site Settings area of Admin For a real world example look for the RegistrationSettingsPart RegistrationSetttingsPartHandler and Users RegistrationSettings cshtml files in the Orchard Users module 422 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 The Content Part public class ShareBarSettingsPart ContentPart public string AddThisAccount get return this Retrieve x gt x AddThisAccount set this Store x gt x AddThisAccount value j j
609. w via shapes and added on many modifications We added dependencies then we built private variables into it finally we wrote lines of business logic into the shape factory lambda diluting its focus The modifications we made are also tied directly to that driver class It s entirely plausible that you might want to extend the module and need to reuse that information 3 9 Extending Orchard 335 Read the Docs Template Documentation Release 1 9 2 The Orchard Layouts module which is used to manage the contents of pages within Orchard has the concept of building Elements They are like widgets that you can place on to the layout Canvas If you wrote a custom element for this module then it would need to duplicate the code we wrote in widget driver class This code should live in a central location We have already used a built in version of the solution to this problem the Orchard services such as TContentManager These services are used throughout Orchard so that they can share their functionality Each of the services implements Dependency to share this access In exactly the same way that we used dependency injection to request access to various Orchard services we can write our own IDependency and let the driver ask for this By writing our own service we will wrap up all the driver modifications into its own class and then supply a single method which can answer the question for the driver Is the current page the featured item pa
610. will be rendered as bold Use gt angle bracket paragraphs to highlight a whole paragraph Code Inline code should be surrounded by ticks and multi line code samples should be in paragraphs indented with 4 spaces This is a code block Try to break code lines so that the code blocks do not have horizontal scroll bars Escaping Markdown If you need to use sequences of characters in your text that would normally be parsed as wiki markup such as or _ but that you want to appear as they are without being parsed add a backlash in front or surround those sequences with code delimiters You can look at the source of this document click the edit link in the sidebar for many examples of this The list of characters that can be escaped can be found here Images Images should not be wider than 675 pixels if they are going to be embedded into a topic Wider images are acceptable as targets of a link from a page The link to such a wide image should itself be a 675 pixel wide thumbnail of the image When including a large image do it as a 675 pixels wide image linking to the high resolution version Images narrower than 675 pixels should be included with their natural width and should not be enlarged Images should be checked into github in a subdirectory of the Attachments directory that has the same name as the topic s markdown file If the image exists in small and large versions the small one should be named the same
611. with addresses and states you can see the convention for relations in action here the columns for the association record table are of type integer the type of the id of each of the associated tables and bears the name of the linked table an underscore and the name of the key column of the associated table Populating the Reward Program Table Like we did with states we pre populate the reward program table from the migration class In a real world scenario the rewards could be content items and you could have a specific management screen for them There would be nothing specific about that coming from the fact that these items happen to be at one end of a n n relation private readonly IRepository RewardProgramRecord rewardProgramRepository 55 private readonly IEnumerable lt RewardProgramRecord gt rewardPrograms new List lt RewardProgramRecord gt new RewardProgramRecord Name Senior Discount 0 05 new RewardProgramRecord Name Family Discount 0 10 new RewardProgramRecord Name Member Discount 0 15 by Lo public int UpdateFrom3 if rewardProgramRepository null throw new InvalidOperationException Couldn t find reward program repository foreach var rewardProgram in rewardPrograms rewardProgramRepository Create rewardProgram return 4 400 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 The Reward Handler There is nothing rem
612. wnload Orchard Separate multiple tags with commas Show on a menu Main Menu Y Select which menu you want the content item to be displayed on Menu text Downloads e text that should appear in the menu Created On Owner admin Publish Now Publish Later 7 Select Your Site in the upper left side of the Dashboard to view the modified home page with the new menu Clik Downloads and you will see your new page 15 Getting Started with Orchard gg Read the Docs Template Documentation Release 1 9 2 1 5 8 Adding New Layer for a Page To change the layout of your new page without affecting the rest of the site you can create a new layer that will be applied only to the Downloads page Then you can place some widgets on that layer and they will be visible only in the Downloads page 1 Go to the Dashboard and select Widgets Then click add a new layer to add a new layer for this page which will allow you to customize the layout for the new page at a later point in time Widgets Current Layer Default The widgets in this layer are displayed on all pages B All Layers 9 Default Header Add Authenticated Navigation Add empty Anonymous em Main Menu Remove Disabled empt Featured Add TheHomepage 2 Write a name for the layer a description and a layer rule url download This will instruct the Orchard System to show the widgets in this layer only when the url of the browse
613. x content parts involving arbitrary data relations There is actually not much to it as the system already knows how to persist and bind such complex objects Rather it s a matter of building the model according to the conventions in place You may download the code for this topic from this link Orchard Module RelationSample 0 5 0 zip 3 9 12 Manifest Files for Modules and Themes In the Orchard CMS modules and themes are important tools for extending and customizing an application Every module and theme is required to have a manifest which is a text file named module txt or theme txt that resides in the root folder of the associated module or theme A manifest stores metadata that Orchard uses to describe modules and themes to the system such as name version description author and tags This topic is a reference for manifest files If you create a custom module or theme or if you write code that accesses modules or themes you must understand the metadata fields in a manifest The data in a manifest is structured into name value pairs in the form Field Name Value The following sections describe the available fields in a manifest for themes and for modules Because a theme is a type of module many of the same metadata fields occur in both theme manifests and module manifests Module manifest fields The manifest for a module should be called module txt and should be located in the root of the project A module s manifest is made u
614. xample shows how to start with the default recipe default recipe xml and add the Bing Maps module and a theme both of which will be downloaded and enabled during setup The recipe also creates a blog and a page that displays the map widget Finally the recipe adds layers and menu tabs for the blog and map page cxml versrone t l 0 25 sOrcnagro Recipe lt Name gt Custom Recipe lt Name gt lt Description gt A recipe that includes a landing page with blog on a second tab lt Descript lt Author gt The Orchard Team lt Author gt WebSite http orchardproject net WebSite lt Tags gt lt Tags gt lt Version gt 1 0 lt Version gt lt IsSetupRecipe gt true lt IsSetupRecipe gt 212 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 lt Recipe gt Module packageId Orchard Module Bing Maps gt Theme packageId Orchard Theme Dark current 2 true Feature enable 2 Orchard Blogs Orchard Comments Orchard Tags Orchard Lasts TanyMee Orcheard Medna Orchard MedraPpicker Orchard Publash Orchard jQuery Orchard Widgets Orchard Widgets PageLayerHinting Orchard Orchard sccrpting Orchard Scrdptuings Lrghtwesgbt PackagingServices Orchard Packaging Gallery Gallery Updates TheThemeMachine Bing Maps Metadata lt Iypes gt Page ContentTypeSettings Draftable True TypeIndexing Included true TagsPart LocalizationPart lt Page gt lt BlogPost Co
615. y a default style to any global element defined in the general section Example p padding 0 10px line height 15090 Typography Use relative font sizes and set a default base size to ensure consistent font sizes across browsers and to allow browser users to increase font size to enhance readability However remember that relative sizes are cumulative For example if you set the size of div tags to 2em then you then embed a div element inside another div element and another inside that you ll end up with an effective setting of 8em for the innermost div element The following list shows the methods by which you can enhance readability Method 1 Use ems and set the base font size on the body element The default size for medium text in all modern browsers is 16px First reduce this size for the entire document by setting font size in the body element to 62 5 You can then think in pixels but still set sizes in terms of ems lem is 10px 0 8em is 8px 1 6em is 16px etc For more information see How to size text using ems Method 2 Use a framework reset such as YUI 2 Fonts CSS Clearing Floats There are two methods you can use to clear floats without adding markup Method 1 Us the position if everything method with semantic modification as suggested by SimpleBits This method involves applying a clear property to any parent element that contains items that you want to float The SimpleBits modificat
616. y sites as possible on a single computer In order improve site density hosting companies can be very aggressive about app domain recycling causing sites to shut down often if they are not accessed frequently or if they consume too much memory There are mitigations for these situations such as using a pinging service or a module that accesses the site on a fixed interval to prevent the app domain from shutting down due to a timeout A mitigation like this might seem like a good idea but ultimately it ruins the site density objective and penalizes everyone 240 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Another mitigation is to improve the perceived startup time of the application so that a shutdown ceases to be a significant problem The Orchard Warmup module new in Orchard 1 1 is a good way to make the most commonly accessed pages of your site immediately accessible even while the app domain is restarting Hosting companies can optimize for Orchard by setting up machine affinity so that a given instance always runs on the same server This can in turn enable the local file system to be used rather than a network appliance This can make a real difference because Orchard can make a heavy use of the file system such as when performing dynamic compilation or when using SQL Server Compact databases Dedicated Hosting A dedicated hosting environment is typically more expensive than a shared hosting account
617. ying a Theme Installing a Theme from your Local Computer To install a theme from your local computer in the Themes screen of the dashboard click the link to Install a theme from your computer This displays a screen that lets you install a theme 150 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Install a Theme Theme Package Browse Browse to a local package file that contains a theme the file will have a nupkg extension select it and then click Install The theme package is installed in your site and you will see the theme listed in the Available section of the Themes screen Note A theme contains a number of files and folders packaged in a ZIP file that has a nupkg file extension The packaging feature is provided by the NuGet package management system Packaging themes and other add ons is beyond the scope of this topic but you can learn more at http nuget codeplex con The following illustration shows the Terra theme which was previously downloaded to the local computer from the Gallery after clicking the Install a theme from your computer link and installing it to an Orchard site The installed theme appears in the Available section 3 2 Customizing Websites 151 Read the Docs Template Documentation Release 1 9 2 Themes User admin Logout The theme has been successfully installed It can be enabled in the Themes page accessible from the menu Installed Ga
618. you scope a particular set of Place tags Match elements can have the following scope at tributes e DisplayType COonvenlLivype e Path Match elements can be nested 3 11 Creating Themes 451 Read the Docs Template Documentation Release 1 9 2 DisplayType Scopes the contained P lace tags to a specific display type You can define your own custom display types when developing content parts or fields but Orchard uses standard ones Detail Used when rendering a single item e g a blog post e Summary Used when rendering a list of items e SummaryAdmin Used when rending a list of items in the admin panel Some modules have registered their own such as Layout Added in v1 9 Used by the Orchard Layouts module when an element is rendering a shape like a ContentField or ContentItem Design Added in v1 9 Used by the Orchard Layouts module when showing an element in the admin panel ContentType Scopes the contained P lace tags to a specific content type or stereotype Content Type Such as BlogPost or Page e Stereotype Added in v1 1 Such as Widget Path The Path attribute was added in v1 1 Scopes the contained P lace tags to a specific path or to a path and its children e Specific Path For example Path About enables changes that only affect the About page assuming you have one e Path and it s Children For example Path MyBlog x affects everything that is under the path MyBlog such
619. ypes comments tags widgets and basic navigation 6 Chapter 1 Getting Started Read the Docs Template Documentation Release 1 9 2 By default Orchard includes a built in database that you can use without installing a separate database server How ever if you are running SQL Server or SQL Server Express you can configure Orchard to use either of those products instead by specifying a connection string Optionally you can enter a table prefix so that multiple Orchard installations can share the same database but keep their data separate How would you like to store your data Use built in data storage SQL Server Compact amp Use an existing SQL Server SQL Express database Use an existing MySql database Connection string server local database orcharddb user orcharduser password orcharduser Data Source sqiServerName lnitia Catalog dbName Persist Security Info True User ID userName Password passward Database Table Prefix default The setup screen also includes a section where you can choose an Orchard recipe to set up your site You can choose from the following Orchard recipes e Default Sets up a site with frequently used Orchard features e Blog Sets up a site as a personal blog Core Sets upa site that has only the Orchard framework for development use 1 1 Installing Orchard 7 Read the Docs Template Documentation Release 1 9 2 Choose an Orchard Recipe Orchard Recipes allow you to setup your
620. ything is correct Check that you haven t included any passwords or other sensitive data If you have you will need to change the passwords as they are already public on your GitHub account When you re happy with the pull request click the green Create pull request button near the top of the Comparing changes page 8 On this final screen you can give your pull request a title and a description 514 Chapter 3 Documentation Read the Docs Template Documentation Release 1 9 2 Qa Write Preview CO Markdown supported Ei Edit in fullscreen Attach images by dragging amp dropping selecting them or pasting from the clipboard You should make your description as detailed as possible You can use markdown to add headings and other formatting You can also copy paste screenshots into the description and it will automatically upload and insert them for you IMPORTANT GitHub supports automatically closing issues via pull requests If you are working on issue 1234 then be sure to add the phrase fixes 1234 somewhere in your description When the pull request is accepted it will automatically close the corresponding issue You can actually use several different keywords depending on whichever you prefer to achieve this same effect 9 The final step is to click the Create pull request below your description Your pull request has now been created and will be reviewed by the community and the core team Don t forget Your pull request

Download Pdf Manuals

Related Search

Related Contents

Au-delà des évidences.    disponibles - Formation continue Université de Lorraine  SKYROCKET II/III DOME  Digitus Gigabit desktop N-Way 5-port switch  MANUAL DE INSTRUCCIONES QJY230C-E  BB-8_App_Enabled_Droid_User_Manual_2015 Draft    Beigbeder, Frédéric - Dernier Inventaire Avant Liquidation  

Copyright © All rights reserved. Failed to retrieve file