summaryrefslogtreecommitdiffstats
path: root/docs/content/en/readfiles/pages-vs-site-pages.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/readfiles/pages-vs-site-pages.md')
-rw-r--r--docs/content/en/readfiles/pages-vs-site-pages.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/content/en/readfiles/pages-vs-site-pages.md b/docs/content/en/readfiles/pages-vs-site-pages.md
new file mode 100644
index 000000000..df5c7d26e
--- /dev/null
+++ b/docs/content/en/readfiles/pages-vs-site-pages.md
@@ -0,0 +1,34 @@
+* A _regular_ page is a "post" page or a "content" page.
+ * A _leaf bundle_ is a regular page.
+* A _list_ page can list _regular_ pages and other _list_ pages. Some
+ examples are: homepage, section pages, _taxonomy_ (`/tags/`) and
+ _term_ (`/tags/foo/`) pages.
+ * A _branch bundle_ is a _list_ page.
+
+`.Site.Pages`
+: Collection of **all** pages of the site: _regular_ pages,
+ sections, taxonomies, etc. -- Superset of everything!
+
+`.Site.RegularPages`
+: Collection of only _regular_ pages.
+
+The above `.Site. ..` page collections can be accessed from any scope in
+the templates.
+
+Below variables return a collection of pages only from the scope of
+the current _list_ page:
+
+`.Pages`
+: Collection of _regular_ pages and _only first-level_
+ section pages under the current _list_ page.
+
+`.RegularPages`
+: Collection of only _regular_ pages under the
+ current _list_ page. This **excludes** regular pages in nested sections/_list_ pages (those are subdirectories with an `_index.md` file.
+
+`.RegularPagesRecursive`
+: {{< new-in "0.68.0" >}} Collection of **all** _regular_ pages under a _list_ page. This **includes** regular pages in nested sections/_list_ pages.
+
+Note
+: From the scope of _regular_ pages, `.Pages` and
+ `.RegularPages` return an empty slice.