docs.django-cms.orgdjango CMS documentation — django cms 3.7.4 documentation

-- Tutorials 1. Installing django CMS 1.1. Requirements 1.2. Your working environment 1.2.1. Create and activate a virtual environment 1.2.2. Update pip inside the virtual environment 1.2.3. Use the django CMS installer 1.2.4. Start up the runserver 2. Templates & Placeholders 2.1. Templates 2.2. Placeholders 2.3. Static Placeholders 2.4. Rendering Menus 3. Integrating applications 3.1. Incorporate the polls application 3.1.1. Install polls 3.1.2. Improve the templates for Polls 3.2. Set up a new polls_cms_integration application 3.2.1. Create the application 3.2.2. Add it to INSTALLED_APPS 4. Plugins 4.1. Create a plugin model 4.1.1. The Plugin Class 4.1.2. The template 4.2. Test the plugin 5. Apphooks 5.1. Create an apphook 5.1.1. Create the apphook class 5.1.2. Remove the old polls entry from the project’s urls.py 5.1.3. Restart the runserver 5.2. Apply the apphook to a page 6. Extending the toolbar 6.1. Add a basic PollToolbar class 6.1.1. Add a menu to the toolbar 6.1.2. Add buttons to the toolbar 6.2. Further refinements 6.3. The complete cms_toolbars.py 7. Extending the navigation menu 7.1. Create the navigation menu 8. Content creation wizards 9. Integrating a third-party application 9.1. Basic installation 9.2. Django settings 9.2.1. INSTALLED_APPS 9.2.2. THUMBNAIL_PROCESSORS 9.2.3. ALDRYN_BOILERPLATE_NAME 9.2.4. STATICFILES_FINDERS 9.2.5. TEMPLATES 9.3. Migrate the database 9.4. Create a new apphooked page 9.5. Add new News & Blog articles How-to guides Set-up Install django CMS by hand Install the django CMS package Create a new project Minimally-required applications and settings Database Using cms check for configuration Further required configuration Adding content-handling functionality Launch the project Next steps Using core functionality Use placeholders outside the CMS Get started Adding content to a placeholder Serve multiple languages Multilingual URLs Store the user’s language preference Working in templates Configuring language-handling behaviour Work with templates static_placeholder CMS_TEMPLATE render_model Manage caching Set-up Enable frontend editing for Page and Django models Template tags Page titles edit Page menu edit Editing ‘ordinary’ Django models Filters Context variable Create sitemaps Sitemap Configuration django.contrib.sitemaps Manage Page Types Creating Page Types Managing Page Types Selecting a Page Type Creating new functionality Create plugins The simplest plugin Troubleshooting Storing configuration Advanced Create apphooks The basics of apphook creation Using an apphook Managing apphooks Adding menus to apphooks Managing permissions on apphooks Automatically restart server on apphook changes Apphooks and placeholder template tags Manage complex apphook configuration Attaching an application multiple times Apphook configurations An example apphook configuration Extend the Toolbar Create a cms_toolbars.py file Define and register a CMSToolbar sub-class Populate the toolbar Finding existing toolbar items Control the position of items in the toolbar Control how and when the toolbar appears Modifying an existing toolbar Detecting URL changes to an object Frontend Customise navigation menus Menus Attach Menus Navigation Modifiers Create content creation wizards Create a content-creation wizard Extend Page & Title models Title vs Page extensions Implement a basic extension Using extensions Complete toolbar API Test your extensions Testing Apps Testing Plugins Contributing Contribute a patch The basics How to write a test Submitting your code Reference API References cms.api Functions and constants Example workflows cms.constants cms.app_base Command Line Interface Informational commands cms list cms check Plugin and apphook management commands cms delete-orphaned-plugins cms uninstall cms copy cms copy lang cms copy site Moderation commands cms moderator cms publisher-publish Maintenance and repair fix-tree fix-mptt Configuration The INSTALLED_APPS setting The MIDDLEWARE setting cms.middleware.utils.ApphookReloadMiddleware Custom User Requirements Required Settings CMS_TEMPLATES Basic Customisation CMS_TEMPLATE_INHERITANCE CMS_TEMPLATES_DIR CMS_PLACEHOLDER_CONF CMS_PLUGIN_CONTEXT_PROCESSORS CMS_PLUGIN_PROCESSORS CMS_APPHOOKS Internationalisation and localisation (I18N and L10N) CMS_LANGUAGES Unicode support for automated slugs Media Settings CMS_MEDIA_PATH CMS_MEDIA_ROOT CMS_MEDIA_URL CMS_PAGE_MEDIA_PATH Advanced Settings CMS_INTERNAL_IPS CMS_REQUEST_IP_RESOLVER CMS_PERMISSION CMS_RAW_ID_USERS CMS_PUBLIC_FOR CMS_CACHE_DURATIONS CMS_CACHE_PREFIX CMS_PAGE_CACHE CMS_PLACEHOLDER_CACHE CMS_PLUGIN_CACHE CMS_TOOLBARS CMS_TOOLBAR_ANONYMOUS_ON CMS_TOOLBAR_HIDE CMS_DEFAULT_X_FRAME_OPTIONS CMS_TOOLBAR_SIMPLE_STRUCTURE_MODE CMS_PAGE_WIZARD_DEFAULT_TEMPLATE CMS_PAGE_WIZARD_CONTENT_PLACEHOLDER CMS_PAGE_WIZARD_CONTENT_PLUGIN CMS_PAGE_WIZARD_CONTENT_PLUGIN_BODY Form and model fields Model fields Form fields Menus and navigation show_menu Some Examples show_menu_below_id show_sub_menu show_breadcrumb Properties of Navigation Nodes in templates Modifying & Extending the menu Menu system classes and function menu application cms application Models Permissions Placeholders Plugins CMSPluginBase Attributes and Methods Reference CMSPlugin Attributes and Methods Reference Sitemaps Template Tags CMS template tags Placeholders render_placeholder render_uncached_placeholder show_placeholder show_uncached_placeholder page_lookup page_url page_attribute render_plugin render_plugin_block render_model render_model_block render_model_icon render_model_add render_model_add_block page_language_url language_chooser Toolbar template tags Titles The Toolbar Classes and methods Parameters django CMS constants used in toolbars Content creation wizards Base Wizard Base Wizard methods get_description get_title get_success_url get_weight user_has_add_permission wizard_pool Wizard pool methods is_registered register unregister get_entry get_entries Key topics Plugins Why would you need to write a plugin? Components of a plugin CMSPluginBase CMSPlugin Application hooks (“apphooks”) Multiple apphooks per application Apphook configurations Publishing Code and Pages Serving content in multiple languages Basic concepts How django CMS determines the user’s preferred language How django CMS determines what language to serve What django CMS shows in your menus Internationalisation URLs How django CMS determines which language to serve Permissions Permission modes Key user permissions Permissions in Page permissions mode Global and per-page permissions Page permission options Per-page permissions Permission strategies Use permissions on Groups, not on Users Use Groups to build up permissions Using touch-screen devices with django CMS General Device support Your site’s frontend Known issues General issues CKEditor issues Django Admin issues How the menu system works Basic concepts Soft Roots Registration Generators and Modifiers Nodes Menu system logic The ShowMenu.get_context() method The MenuPool.get_nodes() method Menu Modifiers Some commonly-used plugins django CMS Core Addons Other addons of note Deprecated addons Search and django CMS Frontend integration Development & community django CMS’s development community Divio AG Core developers Current core developers Retired core developers Becoming a core developer Technical board Role Composition of the board Development policies Reporting security issues Review Formal approval Proposal and discussion of significant changes Release schedule Branches Commits Commit messages Squashing commits Changelog Contributing code In a nutshell Basic requirements and standards Syntax and conventions Process Frontend Styles Icons JS Bundling Contributing documentation Building the documentation Spelling Install the spelling software Check spelling Making a pull request Documentation structure Documentation markup Sections Inline markup Rules for using technical words References Contrib...