integreat-cms

First Steps

  • Installation
    • Prerequisites
      • Prerequisites on common distributions
    • Download sources
    • Install dependencies and local package
  • Development Server
    • Database
    • Webserver
  • Tutorials
    • GitHub, local development environment [German]
    • First issue, project structure, Django [German]
  • Developer Tools
    • Installation
    • Development Server
    • Database
    • Translations
    • Testing
    • Management Commands
    • Code Quality
    • Release Notes
    • Documentation
    • GitHub Review Checker
    • Included Functions
    • Debugging
  • Troubleshooting
    • Not a git repository
    • ⚠ Unauthorized (CircleCI)
    • MacOS on M1
    • Webpack Compilation Errors

Reference

  • Integreat CMS
    • API
      • Middleware
        • Json Debug Toolbar Middleware
      • V3
        • Chat
        • Feedback
        • Events
        • Imprint
        • Languages
        • Location Categories
        • Locations
        • Offers
        • Pages
        • PDF Export
        • Push Notifications
        • Regions
        • Social Media Headers
      • Apps
      • Decorators
      • Urls
    • CMS
      • Constants
        • Administrative Division
        • All Day
        • Allowed Media
        • Countries
        • Custom Translations
        • Duplicate Pbo Behaviors
        • Events Time Range
        • Feedback Ratings
        • Feedback Read Status
        • Frequency
        • Language Color
        • Linkcheck
        • Machine Translation Permissions
        • Machine Translation Providers
        • Matomo Periods
        • Mirrored Page First
        • Months
        • Opening Hours
        • POIcategory
        • Position
        • Postal Code
        • Push Notifications
        • Recurrence
        • Region Status
        • Roles
        • Status
        • Text Directions
        • Translation Status
        • Weekdays
        • Weeks
      • Forms
        • Chat
        • Contacts
        • Events
        • Feedback
        • Imprint
        • Language Tree
        • Languages
        • Media
        • Offer Templates
        • Organizations
        • Pages
        • POI Categories
        • POIs
        • Push Notifications
        • Regions
        • Roles
        • Statistics
        • Translations
        • Users
        • Custom Content Model Form
        • Custom Filter Form
        • Custom Model Form
        • Custom Tree Node Form
        • Icon Widget
        • Machine Translation Form
        • Object Search Form
      • Models
        • Chat
        • Events
        • External Calendars
        • Feedback
        • Firebase
        • Languages
        • Media
        • Offers
        • Pages
        • POI Categories
        • POIs
        • Push Notifications
        • Regions
        • Users
        • Abstract Base Model
        • Abstract Content Model
        • Abstract Content Translation
        • Abstract Tree Node
        • Decorators
      • Templatetags
        • Arithmetic
        • Base Filters
        • Content Filters
        • Form Icon Filters
        • Linkcheck Filters
        • Model Tags
        • Page Filters
        • Parse Struct Time
        • PDF Filters
        • POI Filters
        • Push Notification Filters
        • Settings Tags
        • Svg Tags
        • Tagifnotempty
        • Text Filters
        • Tree Filters
        • Url Tags
        • User Filters
      • Urls
        • Protected
        • Public
      • Utils
        • Account Activation Token Generator
        • Content Edit Lock
        • Content Translation Utils
        • Content Utils
        • Email Utils
        • External Calendar Utils
        • File Utils
        • Internal Link Checker
        • Internal Link Utils
        • Link Utils
        • Linkcheck Utils
        • Media Utils
        • MFA Utils
        • PDF Utils
        • Repair Tree
        • Round Hix Score
        • Shadow Instance
        • Slug Utils
        • Stringify List
        • Text Utils
        • Tinymce Icon Utils
        • Totp Utils
        • Translation Utils
        • User Utils
        • Welcome Mail Utils
      • Views
        • Analytics
        • Authentication
        • Chat
        • Contacts
        • Dashboard
        • Error Handler
        • Events
        • External Calendars
        • Feedback
        • Imprint
        • Language Tree
        • Linkcheck
        • Media
        • Organizations
        • Pages
        • POI Categories
        • POIs
        • Push Notifications
        • Region Condition
        • Regions
        • Release Notes
        • Roles
        • Settings
        • Statistics
        • Translations
        • Users
        • Utils
        • Bulk Action Views
        • Content Version View
        • Delete Views
        • Form Views
        • List Views
        • Mixins
      • Admin
      • Apps
      • Auth
      • Decorators
      • Linklists
      • Rules
    • Core
      • Formats
        • De
        • En
      • Management
        • Commands
        • Debug Command
        • Log Command
      • Middleware
        • Access Control Middleware
        • Region Middleware
        • Timezone Middleware
      • Signals
        • Auth Signals
        • Contact Signals
        • Feedback Signals
        • Hix Signals
        • Organization Signals
      • Utils
        • Decorators
        • Machine Translation API Client
        • Machine Translation Provider
        • Strtobool
        • Word Count
      • Apps
      • Authentication Backends
      • Circleci Settings
      • Context Processors
      • Docker Settings
      • Logging Formatter
      • Settings
      • Sphinx Settings
      • Storages
      • Urls
      • Wsgi
    • Deepl API
      • Apps
      • Deepl API Client
      • Deepl Provider
    • Firebase API
      • Apps
      • Firebase API Client
      • Firebase Data Client
      • Firebase Security Service
    • Google Translate API
      • Apps
      • Google Translate API Client
      • Google Translate Provider
    • Gvz API
      • Apps
      • Utils
    • Integreat Celery
      • Migrations
      • Apps
      • Celery
    • Matomo API
      • Apps
      • Matomo API Client
    • Nominatim API
      • Apps
      • Nominatim API Client
      • Utils
    • Sitemap
      • Apps
      • Sitemaps
      • Urls
      • Utils
      • Views
    • SUMM.AI API
      • Apps
      • SUMM.AI API Client
      • SUMM.AI Provider
      • Utils
    • Textlab API
      • Apps
      • Textlab API Client
      • Utils
    • XLIFF
      • Apps
      • Base Serializer
      • Generic Serializer
      • Utils
      • XLIFF 1.2 Serializer
      • XLIFF 2.0 Serializer
  • Tests
    • API
      • API Config
      • Test API Chat
      • Test API Feedback
      • Test API Push Page
      • Test API Result
      • Test API Social
    • CMS
      • Utils
        • Test Content Utils
        • Test Disable Hix Post Save Signal
        • Test External Calendar Utils
        • Test Internal Link Checker
        • Test Repair Tree
        • Test Rounded Hix Value
        • Test Slug Utils
        • Test Translation Utils
      • Views
        • Status Code
        • Test Public View Status Code
        • Test View Redirect
        • Utils
        • View Config
      • Test Duplicate Regions
      • Test Language
      • Test Login
      • Test Media Library
      • Test Page Filters
    • Core
      • Management
        • Commands
        • Utils
    • Firebase API
      • Test Firebase API Client
      • Test Firebase Data Client
    • Mt API
      • Deepl API Test
      • Google Translate API Test
      • Mt API Test
      • Mt Provider Assignment Test
      • Utils
    • PDF
      • Dummy Django App
        • Static Urls
      • Test PDF Export
    • Sitemap
      • Sitemap Config
      • Test Sitemap
    • SUMM.AI API
      • SUMM.AI Test
      • Utils
    • XLIFF
      • Dummy Django App
        • Static Urls
      • Utils
      • XLIFF Config
      • XLIFF Test
    • Conftest
    • Mock
    • Utils
  • API Documentation
    • Sending the Development Header
    • Regions
      • REQUEST
      • RESPONSE
      • REQUEST
      • RESPONSE
    • Social Media
      • REQUEST
      • RESPONSE
    • Languages
      • REQUEST
      • RESPONSE
    • Offers / Extras
      • REQUEST
      • RESPONSE
    • Pages
      • REQUEST
      • RESPONSE
    • Locations
      • REQUEST
      • RESPONSE
    • Location Categories
      • REQUEST
      • RESPONSE
    • Events
      • REQUEST
      • RESPONSE
    • Single Page
      • REQUEST
      • RESPONSE
    • Page Children
      • REQUEST
      • RESPONSE
    • Page Parents
      • REQUEST
      • RESPONSE
    • PDF
      • REQUEST
      • RESPONSE
    • FCM
      • REQUEST
      • RESPONSE
    • Imprint / Disclaimer
      • REQUEST
      • Response
    • Push Page Content
      • REQUEST
      • Response
    • Feedback
      • Legacy-Endpoint for Page/Event/Disclaimer
        • REQUEST
      • Categories
        • REQUEST
      • Page
        • REQUEST
      • POI
        • REQUEST
      • Event
        • REQUEST
      • Events
        • REQUEST
      • Imprint Page
        • REQUEST
      • Map
        • REQUEST
      • Search
        • REQUEST
      • Offers
        • REQUEST
      • Offer
        • REQUEST
    • Chat
      • REQUEST
      • RESPONSE
      • REQUEST
      • RESPONSE
    • Zammad Webhook
      • REQUEST
      • RESPONSE

Extended Reference

  • Integreat CMS
    • API
      • Middleware
        • Json Debug Toolbar Middleware
      • V3
        • Chat
        • Feedback
        • Events
        • Imprint
        • Languages
        • Location Categories
        • Locations
        • Offers
        • Pages
        • PDF Export
        • Push Notifications
        • Regions
        • Social Media Headers
      • Apps
        • ApiConfig
      • Decorators
        • feedback_handler()
        • json_response()
        • matomo_tracking()
      • Urls
        • app_name
        • urlpatterns
    • CMS
      • Constants
        • Administrative Division
        • All Day
        • Allowed Media
        • Countries
        • Custom Translations
        • Duplicate Pbo Behaviors
        • Events Time Range
        • Feedback Ratings
        • Feedback Read Status
        • Frequency
        • Language Color
        • Linkcheck
        • Machine Translation Permissions
        • Machine Translation Providers
        • Matomo Periods
        • Mirrored Page First
        • Months
        • Opening Hours
        • POIcategory
        • Position
        • Postal Code
        • Push Notifications
        • Recurrence
        • Region Status
        • Roles
        • Status
        • Text Directions
        • Translation Status
        • Weekdays
        • Weeks
      • Forms
        • Chat
        • Contacts
        • Events
        • Feedback
        • Imprint
        • Language Tree
        • Languages
        • Media
        • Offer Templates
        • Organizations
        • Pages
        • POI Categories
        • POIs
        • Push Notifications
        • Regions
        • Roles
        • Statistics
        • Translations
        • Users
        • Custom Content Model Form
        • Custom Filter Form
        • Custom Model Form
        • Custom Tree Node Form
        • Icon Widget
        • Machine Translation Form
        • Object Search Form
      • Models
        • Chat
        • Events
        • External Calendars
        • Feedback
        • Firebase
        • Languages
        • Media
        • Offers
        • Pages
        • POI Categories
        • POIs
        • Push Notifications
        • Regions
        • Users
        • Abstract Base Model
        • Abstract Content Model
        • Abstract Content Translation
        • Abstract Tree Node
        • Decorators
      • Templatetags
        • Arithmetic
        • Base Filters
        • Content Filters
        • Form Icon Filters
        • Linkcheck Filters
        • Model Tags
        • Page Filters
        • Parse Struct Time
        • PDF Filters
        • POI Filters
        • Push Notification Filters
        • Settings Tags
        • Svg Tags
        • Tagifnotempty
        • Text Filters
        • Tree Filters
        • Url Tags
        • User Filters
      • Urls
        • urlpatterns
        • Protected
        • Public
      • Utils
        • Account Activation Token Generator
        • Content Edit Lock
        • Content Translation Utils
        • Content Utils
        • Email Utils
        • External Calendar Utils
        • File Utils
        • Internal Link Checker
        • Internal Link Utils
        • Link Utils
        • Linkcheck Utils
        • Media Utils
        • MFA Utils
        • PDF Utils
        • Repair Tree
        • Round Hix Score
        • Shadow Instance
        • Slug Utils
        • Stringify List
        • Text Utils
        • Tinymce Icon Utils
        • Totp Utils
        • Translation Utils
        • User Utils
        • Welcome Mail Utils
      • Views
        • Analytics
        • Authentication
        • Chat
        • Contacts
        • Dashboard
        • Error Handler
        • Events
        • External Calendars
        • Feedback
        • Imprint
        • Language Tree
        • Linkcheck
        • Media
        • Organizations
        • Pages
        • POI Categories
        • POIs
        • Push Notifications
        • Region Condition
        • Regions
        • Release Notes
        • Roles
        • Settings
        • Statistics
        • Translations
        • Users
        • Utils
        • Bulk Action Views
        • Content Version View
        • Delete Views
        • Form Views
        • List Views
        • Mixins
      • Admin
      • Apps
        • CmsConfig
      • Auth
        • WPBCryptPasswordHasher
      • Decorators
        • modify_mfa_authenticated()
        • permission_required()
        • region_permission_required()
      • Linklists
        • ActiveLanguageLinklist
        • EventTranslationLinklist
        • ImprintTranslationLinklist
        • NonArchivedLinkList
        • OrganizationLinklist
        • POITranslationLinklist
        • PageTranslationLinklist
      • Rules
        • is_page_author()
        • is_page_editor()
        • can_edit_all_pages()
        • can_publish_all_pages()
        • is_in_responsible_organization()
        • can_delete_chat_message()
    • Core
      • Formats
        • De
        • En
      • Management
        • Commands
        • Debug Command
        • Log Command
      • Middleware
        • Access Control Middleware
        • Region Middleware
        • Timezone Middleware
      • Signals
        • Auth Signals
        • Contact Signals
        • Feedback Signals
        • Hix Signals
        • Organization Signals
      • Utils
        • Decorators
        • Machine Translation API Client
        • Machine Translation Provider
        • Strtobool
        • Word Count
      • Apps
        • CoreConfig
      • Authentication Backends
        • EmailAuthenticationBackend
      • Circleci Settings
        • DEEPL_AUTH_KEY
        • DEEPL_ENABLED
        • FCM_CREDENTIALS
        • FCM_ENABLED
        • GOOGLE_APPLICATION_CREDENTIALS
        • GOOGLE_PROJECT_ID
        • GOOGLE_TRANSLATE_ENABLED
        • LINKCHECK_DISABLE_LISTENERS
        • LOGGING
        • LOG_LEVEL
        • MESSAGE_LOGGING_ENABLED
        • SECRET_KEY
        • SUMM_AI_API_KEY
        • SUMM_AI_ENABLED
        • TEXTLAB_API_ENABLED
        • TEXTLAB_API_KEY
      • Context Processors
        • constants_processor()
        • settings_processor()
        • version_processor()
      • Docker Settings
        • DATABASES
      • Logging Formatter
        • ColorFormatter
        • RequestFormatter
      • Settings
        • ADMINS
        • ALLOWED_HOSTS
        • API_EVENTS_MAX_TIME_SPAN_DAYS
        • AUTHENTICATION_BACKENDS
        • AUTHOR_CHAT_HISTORY_DAYS
        • AUTH_PASSWORD_VALIDATORS
        • AUTH_USER_MODEL
        • AVAILABLE_BRANDINGS
        • AVAILABLE_LANGUAGES
        • BASE_DIR
        • BASE_URL
        • BLOG_URLS
        • BRANDING
        • BRANDING_TITLE
        • CACHEOPS
        • CACHEOPS_DEFAULTS
        • CACHEOPS_DEGRADE_ON_FAILURE
        • CACHES
        • CELERY_BROKER_URL
        • CELERY_RESULT_BACKEND
        • CELERY_TASK_TIME_LIMIT
        • CELERY_TASK_TRACK_STARTED
        • CELERY_TIMEZONE
        • COMPANY
        • COMPANY_URL
        • CORS_ALLOW_HEADERS
        • CORS_ORIGIN_ALLOW_ALL
        • CSRF_FAILURE_VIEW
        • CURRENT_TIME_ZONE
        • CUSTOM_LOCALE_PATH
        • DATABASES
        • DEBUG
        • DEBUG_TOOLBAR_PANELS
        • DEEPL_API_URL
        • DEEPL_AUTH_KEY
        • DEEPL_ENABLED
        • DEEPL_GLOSSARIES_ENABLED
        • DEFAULT_AUTO_FIELD
        • DEFAULT_BLOG_URL
        • DEFAULT_BOUNDING_BOX
        • DEFAULT_FROM_EMAIL
        • DEFAULT_LANGUAGES
        • DEFAULT_REQUEST_TIMEOUT
        • DEFAULT_RSS_FEED_URL
        • DEPS_LOG_LEVEL
        • EMAIL_BACKEND
        • EMAIL_HOST
        • EMAIL_HOST_PASSWORD
        • EMAIL_HOST_USER
        • EMAIL_PORT
        • EMAIL_USE_SSL
        • EMAIL_USE_TLS
        • EXTERNAL_CALENDAR_CATEGORY
        • FCM_CHANNELS
        • FCM_CREDENTIALS
        • FCM_DATA_URL
        • FCM_ENABLED
        • FCM_HISTORY_DAYS
        • FCM_NOTIFICATION_RETAIN_TIME_IN_HOURS
        • FCM_SCHEDULE_INTERVAL_MINUTES
        • FCM_URL
        • FORMAT_MODULE_PATH
        • GOOGLE_APPLICATION_CREDENTIALS
        • GOOGLE_PARENT_PARAM
        • GOOGLE_PROJECT_ID
        • GOOGLE_TRANSLATE_ENABLED
        • GOOGLE_TRANSLATE_LOCATION
        • GOOGLE_TRANSLATE_VERSION
        • GVZ_API_ENABLED
        • GVZ_API_URL
        • HIX_REQUIRED_FOR_MT
        • HOSTNAME
        • IMPRINT_SLUG
        • INSTALLED_APPS
        • INTEGREAT_CHAT_BACK_END_DOMAIN
        • INTEGREAT_CHAT_BACK_END_TIMEOUT
        • INTERNAL_IPS
        • INTERNAL_URLS
        • LANGUAGES
        • LANGUAGE_CODE
        • LEGACY_FILE_UPLOAD
        • LINKCHECK_COMMAND_RUNNING
        • LINKCHECK_DISABLE_LISTENERS
        • LINKCHECK_EMAIL_ENABLED
        • LINKCHECK_IGNORED_URL_TYPES
        • LINKCHECK_MAX_URL_LENGTH
        • LINKCHECK_PHONE_ENABLED
        • LINKCHECK_SITE_DOMAINS
        • LOCALE_PATHS
        • LOGFILE
        • LOGGING
        • LOGIN_REDIRECT_URL
        • LOGIN_URL
        • LOGOUT_REDIRECT_URL
        • LOG_LEVEL
        • MATOMO_TRACKING
        • MATOMO_URL
        • MAX_EVENT_DURATION
        • MEDIA_MAX_UPLOAD_SIZE
        • MEDIA_OPTIMIZED_SIZE
        • MEDIA_ROOT
        • MEDIA_THUMBNAIL_CROP
        • MEDIA_THUMBNAIL_SIZE
        • MEDIA_URL
        • MESSAGE_LOGGING_ENABLED
        • MESSAGE_STORAGE
        • MIDDLEWARE
        • MT_CREDITS_ADDON
        • MT_CREDITS_FREE
        • MT_SOFT_MARGIN
        • MT_SOFT_MARGIN_FRACTION
        • NOMINATIM_API_ENABLED
        • NOMINATIM_API_URL
        • NUM_REGIONS_QUICK_ACCESS
        • OUTDATED_THRESHOLD_DAYS
        • PDF_DEACTIVATED_LANGUAGES
        • PDF_ROOT
        • PDF_URL
        • PER_PAGE
        • REDIS_CACHE
        • RELEASE_NOTES_DIRS
        • RESERVED_REGION_PAGE_PATTERNS
        • RESERVED_REGION_SLUGS
        • ROOT_URLCONF
        • RSS_FEED_URLS
        • SECRET_KEY
        • SERIALIZATION_MODULES
        • SERVER_EMAIL
        • SHORT_LINKS_URL
        • SITE_DOMAIN
        • SOCIAL_PREVIEW_IMAGE
        • STATICFILES_DIRS
        • STATICFILES_FINDERS
        • STATIC_ROOT
        • STATIC_URL
        • SUMM_AI_API_KEY
        • SUMM_AI_API_URL
        • SUMM_AI_EASY_GERMAN_LANGUAGE_SLUG
        • SUMM_AI_ENABLED
        • SUMM_AI_GERMAN_LANGUAGE_SLUG
        • SUMM_AI_HTML_FIELDS
        • SUMM_AI_HTML_TAGS
        • SUMM_AI_INHERITED_FIELDS
        • SUMM_AI_IS_INITIAL
        • SUMM_AI_MAX_CONCURRENT_REQUESTS
        • SUMM_AI_MAX_RETRIES
        • SUMM_AI_RATE_LIMIT_COOLDOWN
        • SUMM_AI_SEPARATOR
        • SUMM_AI_TEST_MODE
        • SUMM_AI_TEXT_FIELDS
        • SUMM_AI_TIMEOUT
        • SYS_LOG_LEVEL
        • TEMPLATES
        • TEST
        • TEXTLAB_API_BULK_COOL_DOWN_PERIOD
        • TEXTLAB_API_BULK_WAITING_TIME
        • TEXTLAB_API_CONTENT_TYPES
        • TEXTLAB_API_DEFAULT_BENCHMARK_ID
        • TEXTLAB_API_ENABLED
        • TEXTLAB_API_KEY
        • TEXTLAB_API_LANGUAGES
        • TEXTLAB_API_URL
        • TEXTLAB_API_USERNAME
        • TIME_ZONE
        • USER_CHAT_TICKET_GROUP
        • USER_CHAT_WINDOW_LIMIT
        • USER_CHAT_WINDOW_MINUTES
        • USE_I18N
        • USE_L10N
        • USE_TZ
        • WEBAPP_URL
        • WEBPACK_LOADER
        • WEBSITE_URL
        • WIKI_URL
        • WSGI_APPLICATION
        • XLIFF_DEFAULT_FIELDS
        • XLIFF_DOWNLOAD_DIR
        • XLIFF_EXPORT_VERSION
        • XLIFF_LEGACY_FIELDS
        • XLIFF_ROOT
        • XLIFF_UPLOAD_DIR
        • XLIFF_URL
      • Sphinx Settings
        • SECRET_KEY
        • USE_I18N
      • Storages
        • MessageLoggerStorage
      • Urls
        • urlpatterns
      • Wsgi
        • application()
    • Deepl API
      • Apps
        • DeepLApiClientConfig
      • Deepl API Client
        • DeepLApiClient
      • Deepl Provider
        • DeepLProvider
    • Firebase API
      • Apps
        • FirebaseApiConfig
      • Firebase API Client
        • FirebaseApiClient
      • Firebase Data Client
        • FirebaseDataClient
      • Firebase Security Service
        • FirebaseSecurityService
    • Google Translate API
      • Apps
        • GoogleTranslateApiClientConfig
      • Google Translate API Client
        • GoogleTranslateApiClient
      • Google Translate Provider
        • GoogleTranslateProvider
    • Gvz API
      • Apps
        • GvzApiConfig
      • Utils
        • GvzApiWrapper
        • GvzRegion
    • Integreat Celery
      • Migrations
      • Apps
        • IntegreatCeleryConfig
      • Celery
    • Matomo API
      • Apps
        • MatomoApiConfig
      • Matomo API Client
        • MatomoApiClient
        • MatomoException
    • Nominatim API
      • Apps
        • NominatimApiConfig
      • Nominatim API Client
        • NominatimApiClient
      • Utils
        • BoundingBox
    • Sitemap
      • Apps
        • SitemapConfig
      • Sitemaps
        • EventSitemap
        • OfferSitemap
        • POISitemap
        • PageSitemap
        • WebappSitemap
      • Urls
        • app_name
        • urlpatterns
      • Utils
        • get_sitemaps()
      • Views
        • SitemapIndexView
        • SitemapView
    • SUMM.AI API
      • Apps
        • SummAiApiConfig
      • SUMM.AI API Client
        • SummAiApiClient
      • SUMM.AI Provider
        • SummAiProvider
      • Utils
        • HTMLField
        • HTMLSegment
        • PatientTaskQueue
        • SummAiException
        • SummAiInvalidJSONError
        • SummAiRateLimitingExceeded
        • SummAiRuntimeError
        • TextField
        • TranslationHelper
        • worker()
    • Textlab API
      • Apps
        • TextlabApiConfig
      • Textlab API Client
        • TextlabClient
        • TextlabResult
      • Utils
        • check_hix_score()
        • dict_path()
        • format_hix_feedback()
    • XLIFF
      • Apps
        • XLIFFConfig
      • Base Serializer
        • Deserializer
        • Serializer
        • XMLGeneratorWithCDATA
      • Generic Serializer
        • Deserializer
        • Serializer
      • Utils
        • get_translation_key()
        • get_xliff_import_diff()
        • get_xliff_import_errors_and_clean_translation()
        • page_to_xliff()
        • pages_to_xliff_file()
        • xliff_import_confirm()
        • xliffs_to_pages()
      • XLIFF 1.2 Serializer
        • Deserializer
        • Serializer
      • XLIFF 2.0 Serializer
        • Deserializer
        • Serializer
  • Tests
    • API
      • API Config
        • API_ENDPOINTS
        • API_FEEDBACK_VIEWS
      • Test API Chat
        • test_api_chat_create_attachment_success()
        • test_api_chat_first_chat()
        • test_api_chat_force_new_chat()
        • test_api_chat_get_attachment_incorrect_chat_failure()
        • test_api_chat_get_attachment_missing_attachment_failure()
        • test_api_chat_get_attachment_success()
        • test_api_chat_get_messages_failure()
        • test_api_chat_get_messages_success()
        • test_api_chat_incorrect_auth_error()
        • test_api_chat_missing_auth_error()
        • test_api_chat_ratelimiting()
        • test_api_chat_send_message()
        • test_api_is_chat_enabled_for_user()
      • Test API Feedback
        • test_api_feedback_errors()
        • test_api_feedback_invalid_method()
        • test_api_feedback_success()
      • Test API Push Page
        • test_api_push_page_content()
      • Test API Result
        • test_api_result()
      • Test API Social
        • test_api_result()
    • CMS
      • Utils
        • Test Content Utils
        • Test Disable Hix Post Save Signal
        • Test External Calendar Utils
        • Test Internal Link Checker
        • Test Repair Tree
        • Test Rounded Hix Value
        • Test Slug Utils
        • Test Translation Utils
      • Views
        • Status Code
        • Test Public View Status Code
        • Test View Redirect
        • Utils
        • View Config
      • Test Duplicate Regions
        • test_duplicate_regions()
        • test_duplicate_regions_no_translations()
      • Test Language
        • test_create_new_language_node()
        • test_delete_language_node()
        • test_move_language_node()
        • test_update_language_node()
      • Test Login
        • test_login_failure()
        • test_login_success()
      • Test Media Library
        • test_create_directory()
        • test_delete_directory()
        • test_delete_file()
        • test_directory_path()
        • test_edit_directory()
        • test_edit_file()
        • test_get_directory_content()
        • test_get_file_usages()
        • test_get_search_result()
        • test_move_file()
        • test_replace_file()
        • test_upload_file()
      • Test Page Filters
        • test_page_filters()
    • Core
      • Management
        • Commands
        • Utils
    • Firebase API
      • Test Firebase API Client
        • TestFirebaseApiClient
      • Test Firebase Data Client
        • TestFirebaseDataClient
    • Mt API
      • Deepl API Test
        • setup_deepl_supported_languages()
        • setup_fake_deepl_api_server()
        • test_deepl_bulk_mt_api_error()
      • Google Translate API Test
        • FakeClient
        • setup_fake_google_translate_api()
        • setup_google_translate_supported_languages()
        • test_google_translate_error()
      • Mt API Test
        • mt_setup()
        • test_automatic_translation()
        • test_bulk_mt()
        • test_bulk_mt_exceeds_limit()
        • test_bulk_mt_no_source_language()
        • test_bulk_mt_up_to_date()
        • test_bulk_mt_up_to_date_and_ready_for_mt()
        • test_deepl_bulk_mt_no_target_language()
      • Mt Provider Assignment Test
        • check_mt_provider()
        • test_both_providers_available()
        • test_change_to_not_supporting_provider()
        • test_change_to_supporting_provider()
        • test_no_available_provider()
        • test_only_deepl_available()
        • test_only_google_translate_available()
      • Utils
        • get_content_translations()
        • get_english_name()
        • get_word_count()
    • PDF
      • Dummy Django App
        • Static Urls
      • Test PDF Export
        • test_pdf_export()
        • test_pdf_export_invalid()
    • Sitemap
      • Sitemap Config
        • SITEMAPS
      • Test Sitemap
        • test_sitemap()
    • SUMM.AI API
      • SUMM.AI Test
        • attempts
        • test_auto_translate_easy_german()
        • test_check_rate_limit_exceeded()
        • test_missing_translation()
        • test_patient_task_queue_hit_rate_limit()
        • test_patient_task_queue_max_retries()
        • test_patient_task_queue_normal_deque()
        • test_summ_ai_error_handling()
        • test_translate_text_field_ddos_defense()
        • test_translate_text_field_hit_rate_limit()
        • test_translate_text_field_internal_server_error()
        • test_translate_text_field_successful_translation()
        • test_translate_text_forbidden()
        • test_translate_text_with_empty_text_field()
        • test_unexpected_html()
        • test_validate_response_invalid()
        • test_validate_response_valid()
        • test_worker()
      • Utils
        • MockedRegion
        • MockedRequest
        • enable_summ_api()
        • get_changed_pages()
        • make_mock_summ_ai_server()
        • make_mock_summ_ai_server_rate_limited()
        • make_rogue_summ_ai_server()
    • XLIFF
      • Dummy Django App
        • Static Urls
      • Utils
        • get_and_assert_200()
        • get_open_kwargs()
        • upload_files()
        • validate_xliff_import_response()
      • XLIFF Config
        • XLIFF_IMPORTS
      • XLIFF Test
        • test_xliff_export()
        • test_xliff_import()
    • Conftest
      • ALL_ROLES
      • ANONYMOUS
      • HIGH_PRIV_STAFF_ROLES
      • PRIV_STAFF_ROLES
      • REGION_ROLES
      • ROLES
      • ROOT
      • STAFF_ROLES
      • WRITE_ROLES
      • load_test_data()
      • load_test_data_transactional()
      • login_role_user()
      • login_role_user_async()
      • mock_firebase_credentials()
      • mock_server()
      • pytest_plugins
    • Mock
      • MockServer
        • MockServer.__init__()
        • MockServer.configure()
        • MockServer.port
    • Utils
      • assert_message_in_log()
      • assert_no_error_messages()
      • disable_hix_post_save_signal()
      • get_error_messages()
      • get_messages()

Basic Concepts

  • Virtual Environment
    • Install dependencies
    • Add dependencies
      • Development dependencies
      • Production dependencies
    • Update dependencies
    • Remove virtual environment
  • Internationalization (i18n)
    • Hardcoded Strings
      • Templates
    • Translation File
    • Compilation
    • Developer Tools
  • Frontend Bundling (Webpack)
    • Compatible Browsers
    • Fonts
  • Testing (Pytest)
    • Coverage
    • Test API with WebApp
  • Documentation (Sphinx)
    • Developer Tools
      • Docstrings
    • Cross-referencing
    • Substitutions
    • GitHub Pages
    • External Links
    • Extensions
    • Configuration
      • author
      • autodoc_typehints
      • copyright
      • django_settings
      • django_version
      • extensions
      • extlinks
      • github_pages_url
      • github_repository
      • github_url
      • github_username
      • html_baseurl
      • html_favicon
      • html_last_updated_fmt
      • html_logo
      • html_show_sourcelink
      • html_show_sphinx
      • html_theme
      • html_theme_options
      • intersphinx_mapping
      • intersphinx_timeout
      • linkcode_resolve()
      • modindex_common_prefix
      • nitpick_ignore
      • nitpicky
      • project
      • release
      • rst_epilog
      • setup()
      • templates_path
  • Continuous Integration (CircleCI)
    • Configuration
    • Workflow develop
      • pip-install
      • webpack
      • pylint
      • black
      • check-migrations
      • setup-test-reporter
      • tests
      • upload-test-coverage
      • check-translations
      • compile-translations
      • bump-dev-version
      • build-package
      • publish-package
      • build-documentation
      • deploy-documentation
      • shellcheck/check
    • Workflow main
      • pip-install
      • bump-version
    • Workflow deploy
      • pip-install
      • webpack
      • compile-translations
      • build-package
      • publish-package
      • create-release
      • notify-mattermost
    • Debugging with SSH
    • ⚠ Unauthorized (CircleCI)
  • Debugging
    • Django Debug Toolbar
    • Debugging in various editors and IDEs
      • VSCodium
      • PyCharm (Professional)
        • Enable Django Support
        • Create a Run Configuration
        • Start Debugging
      • Neovim
        • DAP & DAP-UI
        • Configure debugpy
        • Configure the integration with Django
        • Set up key binds (optional)
        • Usage example: PageFormView
      • Nixvim
  • Design Guidelines
    • Buttons

Deployment

  • Packaging
    • Create python package
    • Publish package
  • Production Server
    • System requirements
    • Integreat CMS Package
    • Static Files
    • Webserver
    • Database
    • Redis Cache
    • Email configuration
  • Management Commands
    • Invocation
    • Default Commands
    • Third-party Commands
      • django-linkcheck
        • findlinks
        • checklinks
      • django-debug-toolbar
        • debugsqlshell
    • Custom Commands
      • integreat-cms
        • duplicate_pages
        • find_large_files
        • find_missing_versions
        • hix_bulk
        • import_pois_from_csv
        • replace_links
        • send_push_notifications
        • fix_internal_links
        • summ_ai_bulk
        • reset_mt_budget
      • Create new commands
        • LogCommand
        • DebugCommand
  • Release notes
    • unreleased
    • 2024.12.1
    • 2024.12.0
    • 2024.11.1
    • 2024.11.0
    • 2024.8.2
    • 2024.8.1
    • 2024.8.0
    • 2024.7.3
    • 2024.7.2
    • 2024.7.1
    • 2024.7.0
    • 2024.6.1
    • 2024.6.0
    • 2024.5.0
    • 2024.3.2
    • 2024.3.1
    • 2024.3.0
    • 2024.2.1
    • 2024.2.0
    • 2024.1.0
    • unreleased
    • 2023.12.0
    • 2023.11.0
    • 2023.10.2
    • 2023.10.1
    • 2023.10.0
    • 2023.9.1
    • 2023.9.0
    • 2023.8.0
    • 2023.7.2
    • 2023.7.1
    • 2023.7.0
    • 2023.5.5
    • 2023.5.4
    • 2023.5.3
    • 2023.5.2
    • 2023.5.1
    • 2023.5.0
    • 2023.4.3
    • 2023.4.2
    • 2023.4.1
    • 2023.4.0
    • 2023.3.1
    • 2023.3.0
    • 2023.2.2
    • 2023.2.1
    • 2023.2.0
    • 2023.1.2
    • 2023.1.1
    • 2023.1.0
    • 2022.12.3
    • 2022.12.2
    • 2022.12.1
    • 2022.12.0
    • 2022.11.4
    • 2022.11.3
    • 2022.11.2
    • 2022.11.1
    • 2022.11.0
    • 2022.10.2
    • 2022.10.1
    • 2022.10.0
    • 2022.9.5
    • 2022.9.4
    • 2022.9.3
    • 2022.9.2
    • 2022.9.1
    • 2022.9.0
    • 2022.8.3
    • 2022.8.2
    • 2022.8.1
    • 2022.8.0
    • 2022.7.0
    • 2022.6.3
    • 2022.6.2
    • 2022.6.1
    • 2022.6.0
    • 2022.5.4
    • 2022.5.3
    • 2022.5.2
    • 2022.5.1
    • 2022.5.0
    • 2022.4.2
    • 2022.4.1
    • 2022.4.0
    • 2022.3.6
    • 2022.3.5
    • 2022.3.4
    • 2022.3.3
    • 2022.3.2
    • 2022.3.1
    • 2022.3.0
    • 2022.2.4
    • 2022.2.3
    • 2022.2.2
    • 2022.2.1
    • 2022.2.0-beta
    • 2021.12.0-beta
    • 2021.11.0-beta

Contributing

  • Issue Reporting Guidelines
    • Issue Templates
    • Bug Report
      • Describe the Bug
      • Steps to Reproduce
      • Expected Behavior
      • Actual Behavior
      • Additional Information
    • Feature Request
      • Motivation
      • Proposed Solution
      • Alternatives
      • Additional Context
  • Pull Request Review Guidelines
    • Goals and purpose
    • Checklist
      • 1. General overview
      • 2. Functional tests
      • 3. Code review
      • 4. Feedback
  • Code Style Guidelines
    • Black
    • DjLint
    • Prettier
    • Linting
    • Docstrings
    • my[py]
    • Shellcheck
  • GitHub Workflow
    • Git
    • GitHub Flow
    • Rebasing
      • 1. Update feature branch
      • 2. Clean up git history
    • Pre-commit Hooks
      • Activation
      • Deactivation
  • Code of Conduct
    • Our Pledge
    • Our Standards
    • Enforcement Responsibilities
    • Scope
    • Enforcement
    • Enforcement Guidelines
      • 1. Correction
      • 2. Warning
      • 3. Temporary Ban
      • 4. Permanent Ban
      • Attribution

Indices

  • Glossary
Full Index Module Index Search Page
integreat-cms
  • Search

© Copyright 2024 Tür an Tür – Digitalfabrik gGmbH. | Website | Web-App | GitHub