wagtail/docs/topics/snippets/index.md

(snippets)=

# Snippets

Snippets are pieces of content which do not necessitate a full webpage to render. They could be used for making secondary content, such as headers, footers, and sidebars, editable in the Wagtail admin. Snippets are Django models which do not inherit the {class}`~wagtail.models.Page` class and are thus not organised into the Wagtail tree. However, they can still be made editable by assigning panels and identifying the model as a snippet with the `register_snippet` class decorator or function.

By default, snippets lack many of the features of pages, such as being orderable in the Wagtail admin or having a defined URL. Decide carefully if the content type you would want to build into a snippet might be more suited to a page.

```{toctree}
---
maxdepth: 2
---
registering
rendering
features
customizing
```
convert the docs/topics/** from RST to Markdown Relates to #8383 * Convert the image tag topic to Markdown * Convert the permissions usage to Markdown * Convert the topic of snippets to Markdown * Convert the streamfield topic to markdown * Convert the writing templates doc to Markdown 2022-06-21 00:50:53 +00:00			`(snippets)=`

			`# Snippets`

Clarify docs of Snippets features to better reflect current state 2023-03-31 13:59:21 +00:00			Snippets are pieces of content which do not necessitate a full webpage to render. They could be used for making secondary content, such as headers, footers, and sidebars, editable in the Wagtail admin. Snippets are Django models which do not inherit the {class}`~wagtail.models.Page` class and are thus not organised into the Wagtail tree. However, they can still be made editable by assigning panels and identifying the model as a snippet with the `register_snippet` class decorator or function.
convert the docs/topics/** from RST to Markdown Relates to #8383 * Convert the image tag topic to Markdown * Convert the permissions usage to Markdown * Convert the topic of snippets to Markdown * Convert the streamfield topic to markdown * Convert the writing templates doc to Markdown 2022-06-21 00:50:53 +00:00
Clarify docs of Snippets features to better reflect current state 2023-03-31 13:59:21 +00:00			`By default, snippets lack many of the features of pages, such as being orderable in the Wagtail admin or having a defined URL. Decide carefully if the content type you would want to build into a snippet might be more suited to a page.`
convert the docs/topics/** from RST to Markdown Relates to #8383 * Convert the image tag topic to Markdown * Convert the permissions usage to Markdown * Convert the topic of snippets to Markdown * Convert the streamfield topic to markdown * Convert the writing templates doc to Markdown 2022-06-21 00:50:53 +00:00
Split snippets documentation into separate pages 2023-04-28 07:18:51 +00:00			```{toctree}
			`---`
			`maxdepth: 2`
			`---`
			`registering`
			`rendering`
			`features`
Docs - Page names & reference section - Update British spelling to American - Changed all British spellings to American spellings, in the Customizing admin templates section of the docs - Transferred all British spellings in the usage guide and advanced topics section to American spellings - Update a series of other pages to use the spelling cutomize in the file name Implemented all feedbacks on the usage guide and advanced topics section 2024-01-27 08:45:05 +00:00			`customizing`
Document SnippetViewSet and how to customise it 2022-09-14 14:33:32 +00:00			```