Skip to content

models.md

Latest commit

 

History

History
28 lines (19 loc) · 1.24 KB

models.md

File metadata and controls

28 lines (19 loc) · 1.24 KB
Raw

Models

Ragtail provides Oxyde models in ragtail.models:

  • Locale: active languages/locales, including the default locale
  • Page: tree-structured page with parent, path, depth, locale and translation_key
  • Menu: named menu per locale, for example main or footer
  • MenuItem: nested menu entries pointing either to a Page or an external URL
  • User: staff users for CMS admin login
  • Image / Rendition: media library with focal points and renditions — see Images

After model changes, generate and apply migrations — see Installation.

Creating pages

Use the helper service so path, depth and translation_key are filled consistently:

from ragtail.pages import create_page, create_translation

home = await create_page(title="Home", slug="", locale=en, live=True)
about = await create_page(title="About", slug="about", parent=home, locale=en, live=True)
ueber_uns = await create_translation(about, title="Ueber uns", slug="ueber-uns", locale=de)

StreamField

For block-based page content (Markdown, HTML, images, custom templates), declare a StreamField on a page subclass. Values are stored in page_data as JSON. See StreamField.