Documentation

About the Project¶

• What is Orchard?
  • Overview
  • Our project roadmap
  • What’s happening now?
    

Documentation¶

• Getting Started
  • Installing Orchard
  • Building your first Orchard site
    

• Authoring Web Sites
  • Getting around the admin panel
  • Adding pages to your site
  • Adding a blog to your site
  • Blogging with LiveWriter
  • Adding and managing media content
  • Saving, scheduling and publishing drafts
  • Navigation and menus
  • Organizing content with tags
  • Creating global-ready applications
  • Search and indexing
  • Creating custom content types
    

• Customizing Web Sites
  • Previewing and applying a theme
  • Installing themes
    

• Managing Web Sites
  • Enabling and disabling features
  • Using the command-line interface
  • Installing and upgrading modules
  • Module gallery feeds
  • Modifying site settings
  • Moderating comments
  • Managing users and roles
  • Understanding permissions
    

• Hosting and Deploying Web Sites
  • Deploying Orchard from staging/development to production servers
  • Configuring Orchard in shared hosting environments
  • Deploying Orchard to Windows Azure
  • Setting up a multi-tenant Orchard site
    

• Extending Orchard
  • How Orchard works
  • Content types, parts, and fields
  • Command-line scaffolding
  • Creating a module with a simple text editor
  • Creating a module in Visual Studio
  • Writing a content part
  • Writing a content field
  • Packaging and sharing a module
  • Understanding data access
  • Understanding content handlers
  • Understanding content drivers
  • Writing data migrations
  • Adding admin panel menu items
  • Adding custom settings
  • Adding-custom-permissions
  • Exposing and handling events
  • Creating content types in code
  • Writing a command-line handler
  • Localizing modules
  • Routing
  • Permissions
    

• Developer Tools and Guidelines
  • Developer FAQ
  • Setting up a source enlistment
  • Source code organization
  • Dependencies and libraries
  • Code conventions
  • Continuous integration
    

• Additional Topics
  • Working with Orchard in WebMatrix
  • Orchard dynamic compilation
    

• Troubleshooting
  • Common issues
  • Filing bugs
    

• Getting Involved
  • Orchard community resources
  • Contributing documentation
    • Documentation style guidelines
  • Contributing modules
  • Contributing translations
  • Contributing patches
  • Getting involved in forums
    

User Experiences¶

• Walkthroughs and UI Mockups
  

Scenarios and Designs¶

• Blogs
• Comments
• Content types
• Definitions
• HTML doctype
• Linkbacks: Pingbacks, Refbacks and Trackbacks
• Media management
• Navigation
• Page editing
• Page management and publishing
• Page 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
  

Additional Developer Information¶