silverstripe-framework/docs/en/02_Developer_Guides/01_Templates/02_Common_Variables.md

---
title: Common Variables
summary: Some of the common variables and methods your templates can use, including Menu, SiteConfig, and more.
---

# Common Variables

The page below describes a few of common variables and methods you'll see in a Silverstripe CMS template. This is not an
exhaustive list. From your template you can call any method, database field, or relation on the object which is
currently in scope as well as its subclasses or extensions.

Knowing what methods you can call can be tricky, but the first step is to understand the scope you're in. Scope is
explained in more detail on the [syntax](syntax#scope) page. Many of the methods listed below can be called from any
scope, and you can specify additional static methods to be available globally in templates by implementing the
[TemplateGlobalProvider](api:SilverStripe\View\TemplateGlobalProvider) interface.

[notice]
Want a quick way of knowing what scope you're in? Try putting `$ClassName` in your template. You should see a string
such as `Page` of the object that's in scope. The methods you can call on that object then are any functions, database
properties or relations on the `Page` class, `PageController` class as well as anything from their subclasses **or**
extensions.
[/notice]

Outputting these variables is only the start, if you want to format or manipulate them before adding them to the template
have a read of the [Formatting, Modifying and Casting Variables](casting) documentation.

[alert]
Some of the following only apply when you have the `CMS` module installed. If you're using the `Framework` alone, this
functionality may not be included.
[/alert]


## Base Tag

```ss
<head>
    <% base_tag %>

    ..
</head>
```

The `<% base_tag %>` placeholder is replaced with the HTML base element. Relative links within a document (such as `<img
src="someimage.jpg" alt="">`) will become relative to the URI specified in the base tag. This ensures the browser knows where
to locate your site’s images and css files.

It renders in the template as `<base href="http://www.yoursite.com" /><!--[if lte IE 6]></base><![endif]-->`

[alert]
A `<% base_tag %>;` is nearly always required or assumed by Silverstripe CMS to exist.
[/alert]

## CurrentMember

Returns the currently logged in [Member](api:SilverStripe\Security\Member) instance, if there is one logged in.

```ss
<% if $CurrentMember %>
  Welcome back, $CurrentMember.FirstName
<% end_if %>
```

## Title and Menu Title

```ss
$Title
$MenuTitle
```

Most objects within Silverstripe CMS will respond to `$Title` (i.e they should have a `Title` database field or at least a
`getTitle()` method).

The CMS module in particular provides two fields to label a page: `Title` and `MenuTitle`. `Title` is the title
displayed on the web page, while `MenuTitle` can be a shorter version suitable for size-constrained menus.

[notice]
If `MenuTitle` is left blank by the CMS author, it'll just default to the value in `Title`.
[/notice]

## Page Content

```ss
$Content
```

It returns the database content of the `Content` property. With the CMS Module, this is the value of the WYSIWYG editor
but it is also the standard for any object that has a body of content to output.

[info]
Please note that this database content can be "versioned", meaning that draft content edited in the CMS can be different
from published content shown to your website visitors. In templates, you don't need to worry about this distinction.

The `$Content` variable contains the published content by default,and only preview draft content if explicitly
requested (e.g. by the "preview" feature in the CMS) (see the [versioning documentation](/../model/versioning) for
more details).
[/info]

### SiteConfig: Global settings

[notice]
`SiteConfig` is a module that is bundled with the CMS. If you wish to include `SiteConfig` in your framework only
web pages, you'll need to install it via composer.
[/notice]

```ss
$SiteConfig.Title
```

The [SiteConfig](../configuration/siteconfig) object allows content authors to modify global data in the CMS, rather
than PHP code. By default, this includes a Website title and a Tagline.

`SiteConfig` can be extended to hold other data, for example a logo image which can be uploaded through the CMS or
global content such as your footer content.


## Meta Tags

The `$MetaTags` placeholder in a template returns a segment of HTML appropriate for putting into the `<head>` tag. It
will set up title, keywords and description meta-tags, based on the CMS content and is editable in the 'Meta-data' tab
on a per-page basis.

[notice]
If you don’t want to include the title tag use `$MetaTags(false)`.
[/notice]

By default `$MetaTags` renders:

```ss
<title>Title of the Page</title>
<meta name="generator" content="SilverStripe - https://www.silverstripe.org">
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
```

`$MetaTags(false)` will render

```ss
<meta name="generator" content="SilverStripe - https://www.silverstripe.org">
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
```

If using `$MetaTags(false)` we can provide a more custom `title`.

```ss
$MetaTags(false)
<title>$Title - Bob's Fantasy Football</title>
```

### Modifying Meta Tags

You can override the `MetaComponents()` method on your `SiteTree` sub-classes or make use of the `MetaComponents` extension point to manipulate the underlying data that is rendered by `$MetaTags`. Example (for `Page` class):

```php
public function MetaComponents()
{
    $tags = parent::MetaComponents();
    // Override the content of the Title tag (needs to be html)
    if ($this->MetaTitle) {
        $tags['title']['content'] = $this->obj('MetaTitle')->forTemplate();
    }
    // Provide a default Meta Description
    if (!$tags['description']['attributes']['content']) {
        // provide raw text as attributes will be escaped later
        $tags['description']['attributes']['content'] = $this->dbObject('Content')->LimitCharactersToClosestWord(300);
    }
    return $tags;
}
```

## Links

```ss
<a href="$Link">..</a>
```

All objects that could be accessible in Silverstripe CMS should define a `Link` method and an `AbsoluteLink` method. Link
returns the relative URL for the object and `AbsoluteLink` outputs your full website address along with the relative
link.

```ss
$Link
<!-- returns /about-us/offices/ -->

$AbsoluteLink
<!-- returns http://yoursite.com/about-us/offices/ -->
```

### Linking Modes

```ss
$isSection
$isCurrent
```

When looping over a list of `SiteTree` instances through a `<% loop $Menu %>` or `<% loop $Children %>`, `$isSection` and `$isCurrent`
will return true or false based on page being looped over relative to the currently viewed page.

For instance, to only show the menu item linked if it's the current one:

```ss
<% if $isCurrent %>
    $Title
<% else %>
    <a href="$Link">$Title</a>
<% end_if %>
```

An example for checking for `current` or `section` is as follows:

```ss
<a class="<% if $isCurrent %>current<% else_if $isSection %>section<% end_if %>" href="$Link">$MenuTitle</a>
```

**Additional Utility Method**

 * `$InSection(page-url)`: This if block will pass if we're currently on the page-url page or one of its children.

```ss
<% if $InSection(about-us) %>
    <p>You are viewing the about us section</p>
<% end_if %>
```

### URLSegment

This returns the part of the URL of the page you're currently on. For example on the `/about-us/offices/` web page the
`URLSegment` will be `offices`. `URLSegment` cannot be used to generate a link since it does not output the full path.
It can be used within templates to generate anchors or other CSS classes.

```ss
<div id="section-$URLSegment">

</div>

<!-- returns <div id="section-offices"> -->
```

##  ClassName

Returns the class of the current object in [scope](syntax#scope) such as `Page` or `HomePage`. The `$ClassName` can be
handy for a number of uses. A common use case is to add to your `<body>` tag to influence CSS styles and JavaScript
behavior based on the page type used:

```ss
<body class="$ClassName">

<!-- returns <body class="HomePage">, <body class="BlogPage"> -->
```

## Children Loops

```ss
<% loop $Children %>

<% end_loop %>
```

Will loop over all Children records of the current object context. Children are pages that sit under the current page in
the `CMS` or a custom list of data. This originates in the `Versioned` extension's `getChildren` method.

[alert]
For doing your website navigation most likely you'll want to use `$Menu` since its independent of the page
context.
[/alert]

### ChildrenOf

```ss
<% loop $ChildrenOf(<my-page-url>) %>

<% end_loop %>
```

Will create a list of the children of the given page, as identified by its `URLSegment` value. This can come in handy
because it's not dependent on the context of the current page. For example, it would allow you to list all staff member
pages underneath a "staff" holder on any page, regardless if its on the top level or elsewhere.


### AllChildren

Content authors have the ability to hide pages from menus by un-selecting the `ShowInMenus` checkbox within the CMS.
This option will be honored by `<% loop $Children %>` and `<% loop $Menu %>` however if you want to ignore the user
preference, `AllChildren` does not filter by `ShowInMenus`.

```ss
<% loop $AllChildren %>
    ...
<% end_loop %>
```

### Menu Loops

```ss
<% loop $Menu(1) %>
    ...
<% end_loop %>
```

`$Menu(1)` returns the top-level menu of the website. You can also create a sub-menu using `$Menu(2)`, and so forth.

[notice]
Pages with the `ShowInMenus` property set to `false` will be filtered out.
[/notice]

## Access to a specific Page

```ss
<% with $Page(my-page) %>
    $Title
<% end_with %>
```

Page will return a single page from site, looking it up by URL.

## Access to Parent and Level Pages

### Level

```ss
<% with $Level(1) %>
    $Title
<% end_with %>
```

Will return a page in the current path, at the level specified by the numbers. It is based on the current page context,
looking back through its parent pages. `Level(1)` being the top most level.

For example, imagine you're on the "bob marley" page, which is three levels in: "about us > staff > bob marley".

*  `$Level(1).Title` would return "about us"
*  `$Level(2).Title` would return "staff"
*  `$Level(3).Title` would return "bob marley"

### Parent

```ss
<!-- given we're on 'Bob Marley' in "about us > staff > bob marley" -->

$Parent.Title
<!-- returns 'staff' -->

$Parent.Parent.Title
<!-- returns 'about us' -->
```

## Navigating Scope

See [scope](syntax#scope).

## Breadcrumbs

Breadcrumbs are the path of pages which need to be taken to reach the current page, and can be a great navigation aid
for website users.

While you can achieve breadcrumbs through the `$Level(<level>)` control manually, there's a nicer shortcut: The
`$Breadcrumbs` variable.

```ss
$Breadcrumbs
```

By default, it uses the template defined in `templates/BreadcrumbsTemplate.ss`
of the `silverstripe/cms` module.

```ss
<% if $Pages %>
    <% loop $Pages %>
        <% if $Last %>$Title.XML<% else %><a href="$Link">$MenuTitle.XML</a> &raquo;<% end_if %>
    <% end_loop %>
<% end_if %>
```

[info]
To customise the markup that `$Breadcrumbs` generates, copy `templates/BreadcrumbsTemplate.ss`
 from the `silverstripe/cms` module to your theme (e.g.: `themes/you-theme/templates/BreadcrumbsTemplate.ss`).
 Modify the newly copied template and flush your Silverstripe CMS cache.
[/info]

## Forms

```ss
$Form
```

A page will normally contain some content and potentially a form of some kind. For example, the log-in page has a
Silverstripe CMS log-in form. If you are on such a page, the `$Form` variable will contain the HTML content of the form.
Placing it just below `$Content` is a good default.


## Related Lessons
* [Adding dynamic content](https://www.silverstripe.org/learn/lessons/v4/adding-dynamic-content-1)

## Related Documentation

 * [Casting and Formatting Variables](casting)
 * [Template Inheritance](template_inheritance)

## API Documentation

 * [ContentController](api:SilverStripe\CMS\Controllers\ContentController): The main controller responsible for handling pages.
 * [Controller](api:SilverStripe\Control\Controller): Generic controller (not specific to pages.)
 * [DataObject](api:SilverStripe\ORM\DataObject): Underlying model class for page objects.
 * [ViewableData](api:SilverStripe\View\ViewableData): Underlying object class for pretty much anything displayable.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								---
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								title: Common Variables
-												developer guides, templates review

											
										
										
											2014-10-30 05:16:38 +01:00
+								summary: Some of the common variables and methods your templates can use, including Menu, SiteConfig, and more.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								---
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								# Common Variables
-												DOC Update SilverStripe to Silverstripe CMS

- Remaining Developer Guides and Upgrading
- SilverStripe in a namespace or api has not been change
- To keep PRs easier no formatting was changed

Update merge conflics with two files

Update Silverstripe Ltd, Silverstripe Cloud and Silverstripe CMS

Silverstripe CMS Ltd > Silverstripe Ltd
Silverstripe CMS Platform > Silverstripe Cloud
Silverstripe CMS Framework > Silverstripe CMS

Resolve merge conflict

Remove Framework from Silverstripe CMS Framework

- 3 files

Change SilverStripe CMS to Silverstripe CMS

											
										
										
											2021-06-30 11:48:52 +02:00
+								The page below describes a few of common variables and methods you'll see in a Silverstripe CMS template. This is not an
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								exhaustive list. From your template you can call any method, database field, or relation on the object which is
-												Update 02_Common_Variables.md
											
										
										
											2021-05-16 22:22:53 +02:00
+								currently in scope as well as its subclasses or extensions.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								Knowing what methods you can call can be tricky, but the first step is to understand the scope you're in. Scope is
 								explained in more detail on the [syntax](syntax#scope) page. Many of the methods listed below can be called from any
 								scope, and you can specify additional static methods to be available globally in templates by implementing the
-												FIX Add namespaces in markdown docs (#7088)

* FIX Add namespaces in markdown docs

* FIX Convert doc [link] to [link-text](link-uri)
											
										
										
											2017-07-03 03:22:12 +02:00
+								[TemplateGlobalProvider](api:SilverStripe\View\TemplateGlobalProvider) interface.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[notice]
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								Want a quick way of knowing what scope you're in? Try putting `$ClassName` in your template. You should see a string
 								such as `Page` of the object that's in scope. The methods you can call on that object then are any functions, database
 								properties or relations on the `Page` class, `PageController` class as well as anything from their subclasses **or**
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								extensions.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/notice]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								Outputting these variables is only the start, if you want to format or manipulate them before adding them to the template
-												MNT Fix various typos with codespell (#10177)


											
										
										
											2021-12-13 09:05:33 +01:00
+								have a read of the [Formatting, Modifying and Casting Variables](casting) documentation.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[alert]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								Some of the following only apply when you have the `CMS` module installed. If you're using the `Framework` alone, this
 								functionality may not be included.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/alert]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## Base Tag
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<head>
 								    <% base_tag %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								    ..
 								</head>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								The `<% base_tag %>` placeholder is replaced with the HTML base element. Relative links within a document (such as `<img
-												DOC: fix missing closing backtick for code display, add required alt attribute

Otherwise the code is output as html, and displays as a missing image. The alt attribute is required for image tags, whereas self closing is no longer required for html5.
											
										
										
											2021-02-11 00:18:36 +01:00
+								src="someimage.jpg" alt="">`) will become relative to the URI specified in the base tag. This ensures the browser knows where
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								to locate your site’s images and css files.
 								It renders in the template as `<base href="http://www.yoursite.com" /><!--[if lte IE 6]></base><![endif]-->`
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[alert]
-												DOC Update SilverStripe to Silverstripe CMS

- Remaining Developer Guides and Upgrading
- SilverStripe in a namespace or api has not been change
- To keep PRs easier no formatting was changed

Update merge conflics with two files

Update Silverstripe Ltd, Silverstripe Cloud and Silverstripe CMS

Silverstripe CMS Ltd > Silverstripe Ltd
Silverstripe CMS Platform > Silverstripe Cloud
Silverstripe CMS Framework > Silverstripe CMS

Resolve merge conflict

Remove Framework from Silverstripe CMS Framework

- 3 files

Change SilverStripe CMS to Silverstripe CMS

											
										
										
											2021-06-30 11:48:52 +02:00
+								A `<% base_tag %>;` is nearly always required or assumed by Silverstripe CMS to exist.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/alert]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## CurrentMember
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								Returns the currently logged in [Member](api:SilverStripe\Security\Member) instance, if there is one logged in.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								```ss
 								<% if $CurrentMember %>
-												FIX Capitalisation fixes in welcome back message (#9439)


											
										
										
											2020-03-23 03:54:30 +01:00
+								  Welcome back, $CurrentMember.FirstName
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% end_if %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## Title and Menu Title
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$Title
 								$MenuTitle
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOC Update SilverStripe to Silverstripe CMS

- Remaining Developer Guides and Upgrading
- SilverStripe in a namespace or api has not been change
- To keep PRs easier no formatting was changed

Update merge conflics with two files

Update Silverstripe Ltd, Silverstripe Cloud and Silverstripe CMS

Silverstripe CMS Ltd > Silverstripe Ltd
Silverstripe CMS Platform > Silverstripe Cloud
Silverstripe CMS Framework > Silverstripe CMS

Resolve merge conflict

Remove Framework from Silverstripe CMS Framework

- 3 files

Change SilverStripe CMS to Silverstripe CMS

											
										
										
											2021-06-30 11:48:52 +02:00
+								Most objects within Silverstripe CMS will respond to `$Title` (i.e they should have a `Title` database field or at least a
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								`getTitle()` method).
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								The CMS module in particular provides two fields to label a page: `Title` and `MenuTitle`. `Title` is the title
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								displayed on the web page, while `MenuTitle` can be a shorter version suitable for size-constrained menus.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[notice]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								If `MenuTitle` is left blank by the CMS author, it'll just default to the value in `Title`.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/notice]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## Page Content
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$Content
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								It returns the database content of the `Content` property. With the CMS Module, this is the value of the WYSIWYG editor
 								but it is also the standard for any object that has a body of content to output.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[info]
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								Please note that this database content can be "versioned", meaning that draft content edited in the CMS can be different
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								from published content shown to your website visitors. In templates, you don't need to worry about this distinction.
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								The `$Content` variable contains the published content by default,and only preview draft content if explicitly
 								requested (e.g. by the "preview" feature in the CMS) (see the [versioning documentation](/../model/versioning) for
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								more details).
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/info]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								### SiteConfig: Global settings
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[notice]
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								`SiteConfig` is a module that is bundled with the CMS. If you wish to include `SiteConfig` in your framework only
-												Update 02_Common_Variables.md
											
										
										
											2021-05-16 22:22:53 +02:00
+								web pages, you'll need to install it via composer.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/notice]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$SiteConfig.Title
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								The [SiteConfig](../configuration/siteconfig) object allows content authors to modify global data in the CMS, rather
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								than PHP code. By default, this includes a Website title and a Tagline.
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								`SiteConfig` can be extended to hold other data, for example a logo image which can be uploaded through the CMS or
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								global content such as your footer content.
 								## Meta Tags
 								The `$MetaTags` placeholder in a template returns a segment of HTML appropriate for putting into the `<head>` tag. It
 								will set up title, keywords and description meta-tags, based on the CMS content and is editable in the 'Meta-data' tab
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								on a per-page basis.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[notice]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								If you don’t want to include the title tag use `$MetaTags(false)`.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/notice]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								By default `$MetaTags` renders:
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<title>Title of the Page</title>
-												DOC Update SilverStripe to Silverstripe CMS

- Remaining Developer Guides and Upgrading
- SilverStripe in a namespace or api has not been change
- To keep PRs easier no formatting was changed

Update merge conflics with two files

Update Silverstripe Ltd, Silverstripe Cloud and Silverstripe CMS

Silverstripe CMS Ltd > Silverstripe Ltd
Silverstripe CMS Platform > Silverstripe Cloud
Silverstripe CMS Framework > Silverstripe CMS

Resolve merge conflict

Remove Framework from Silverstripe CMS Framework

- 3 files

Change SilverStripe CMS to Silverstripe CMS

											
										
										
											2021-06-30 11:48:52 +02:00
+								<meta name="generator" content="SilverStripe - https://www.silverstripe.org">
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								`$MetaTags(false)` will render
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								```ss
-												DOC Update SilverStripe to Silverstripe CMS

- Remaining Developer Guides and Upgrading
- SilverStripe in a namespace or api has not been change
- To keep PRs easier no formatting was changed

Update merge conflics with two files

Update Silverstripe Ltd, Silverstripe Cloud and Silverstripe CMS

Silverstripe CMS Ltd > Silverstripe Ltd
Silverstripe CMS Platform > Silverstripe Cloud
Silverstripe CMS Framework > Silverstripe CMS

Resolve merge conflict

Remove Framework from Silverstripe CMS Framework

- 3 files

Change SilverStripe CMS to Silverstripe CMS

											
										
										
											2021-06-30 11:48:52 +02:00
+								<meta name="generator" content="SilverStripe - https://www.silverstripe.org">
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								If using `$MetaTags(false)` we can provide a more custom `title`.
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$MetaTags(false)
 								<title>$Title - Bob's Fantasy Football</title>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOCS Added 'Modifying Meta Tags' entry

											
										
										
											2019-02-01 18:33:20 +01:00
+								### Modifying Meta Tags
 								You can override the `MetaComponents()` method on your `SiteTree` sub-classes or make use of the `MetaComponents` extension point to manipulate the underlying data that is rendered by `$MetaTags`. Example (for `Page` class):
 								```php
 								public function MetaComponents()
 								{
 								    $tags = parent::MetaComponents();
 								    // Override the content of the Title tag (needs to be html)
 								    if ($this->MetaTitle) {
 								        $tags['title']['content'] = $this->obj('MetaTitle')->forTemplate();
 								    }
 								    // Provide a default Meta Description
 								    if (!$tags['description']['attributes']['content']) {
 								        // provide raw text as attributes will be escaped later
 								        $tags['description']['attributes']['content'] = $this->dbObject('Content')->LimitCharactersToClosestWord(300);
 								    }
 								    return $tags;
 								}
 								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								## Links
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<a href="$Link">..</a>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOC Update SilverStripe to Silverstripe CMS

- Remaining Developer Guides and Upgrading
- SilverStripe in a namespace or api has not been change
- To keep PRs easier no formatting was changed

Update merge conflics with two files

Update Silverstripe Ltd, Silverstripe Cloud and Silverstripe CMS

Silverstripe CMS Ltd > Silverstripe Ltd
Silverstripe CMS Platform > Silverstripe Cloud
Silverstripe CMS Framework > Silverstripe CMS

Resolve merge conflict

Remove Framework from Silverstripe CMS Framework

- 3 files

Change SilverStripe CMS to Silverstripe CMS

											
										
										
											2021-06-30 11:48:52 +02:00
+								All objects that could be accessible in Silverstripe CMS should define a `Link` method and an `AbsoluteLink` method. Link
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								returns the relative URL for the object and `AbsoluteLink` outputs your full website address along with the relative
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								link.
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$Link
 								<!-- returns /about-us/offices/ -->
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$AbsoluteLink
 								<!-- returns http://yoursite.com/about-us/offices/ -->
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								### Linking Modes
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$isSection
 								$isCurrent
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOCS update LinkingModes description

											
										
										
											2015-11-23 21:10:47 +01:00
+								When looping over a list of `SiteTree` instances through a `<% loop $Menu %>` or `<% loop $Children %>`, `$isSection` and `$isCurrent`
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								will return true or false based on page being looped over relative to the currently viewed page.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								For instance, to only show the menu item linked if it's the current one:
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% if $isCurrent %>
 								    $Title
 								<% else %>
 								    <a href="$Link">$Title</a>
 								<% end_if %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												DOCS update LinkingModes description

											
										
										
											2015-11-23 21:10:47 +01:00
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								An example for checking for `current` or `section` is as follows:
-												DOCS update LinkingModes description

											
										
										
											2015-11-23 21:10:47 +01:00
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<a class="<% if $isCurrent %>current<% else_if $isSection %>section<% end_if %>" href="$Link">$MenuTitle</a>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOCS update LinkingModes description

											
										
										
											2015-11-23 21:10:47 +01:00
+								**Additional Utility Method**
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												developer guides, templates review

											
										
										
											2014-10-30 05:16:38 +01:00
+								 * `$InSection(page-url)`: This if block will pass if we're currently on the page-url page or one of its children.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% if $InSection(about-us) %>
 								    <p>You are viewing the about us section</p>
 								<% end_if %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								### URLSegment
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								This returns the part of the URL of the page you're currently on. For example on the `/about-us/offices/` web page the
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								`URLSegment` will be `offices`. `URLSegment` cannot be used to generate a link since it does not output the full path.
 								It can be used within templates to generate anchors or other CSS classes.
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<div id="section-$URLSegment">
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								</div>
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<!-- returns <div id="section-offices"> -->
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								##  ClassName
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								Returns the class of the current object in [scope](syntax#scope) such as `Page` or `HomePage`. The `$ClassName` can be
 								handy for a number of uses. A common use case is to add to your `<body>` tag to influence CSS styles and JavaScript
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								behavior based on the page type used:
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<body class="$ClassName">
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<!-- returns <body class="HomePage">, <body class="BlogPage"> -->
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## Children Loops
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% loop $Children %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% end_loop %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								Will loop over all Children records of the current object context. Children are pages that sit under the current page in
 								the `CMS` or a custom list of data. This originates in the `Versioned` extension's `getChildren` method.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[alert]
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								For doing your website navigation most likely you'll want to use `$Menu` since its independent of the page
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								context.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/alert]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								### ChildrenOf
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% loop $ChildrenOf(<my-page-url>) %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% end_loop %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								Will create a list of the children of the given page, as identified by its `URLSegment` value. This can come in handy
 								because it's not dependent on the context of the current page. For example, it would allow you to list all staff member
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								pages underneath a "staff" holder on any page, regardless if its on the top level or elsewhere.
 								### AllChildren
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								Content authors have the ability to hide pages from menus by un-selecting the `ShowInMenus` checkbox within the CMS.
-												developer guides, templates review

											
										
										
											2014-10-30 05:16:38 +01:00
+								This option will be honored by `<% loop $Children %>` and `<% loop $Menu %>` however if you want to ignore the user
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								preference, `AllChildren` does not filter by `ShowInMenus`.
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% loop $AllChildren %>
 								    ...
 								<% end_loop %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								### Menu Loops
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% loop $Menu(1) %>
 								    ...
 								<% end_loop %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								`$Menu(1)` returns the top-level menu of the website. You can also create a sub-menu using `$Menu(2)`, and so forth.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[notice]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								Pages with the `ShowInMenus` property set to `false` will be filtered out.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/notice]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## Access to a specific Page
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% with $Page(my-page) %>
 								    $Title
 								<% end_with %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								Page will return a single page from site, looking it up by URL.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## Access to Parent and Level Pages
 								### Level
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% with $Level(1) %>
 								    $Title
 								<% end_with %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								Will return a page in the current path, at the level specified by the numbers. It is based on the current page context,
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								looking back through its parent pages. `Level(1)` being the top most level.
 								For example, imagine you're on the "bob marley" page, which is three levels in: "about us > staff > bob marley".
 								*  `$Level(1).Title` would return "about us"
 								*  `$Level(2).Title` would return "staff"
 								*  `$Level(3).Title` would return "bob marley"
 								### Parent
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<!-- given we're on 'Bob Marley' in "about us > staff > bob marley" -->
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$Parent.Title
 								<!-- returns 'staff' -->
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$Parent.Parent.Title
 								<!-- returns 'about us' -->
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## Navigating Scope
-												DOCS Remove duped content (#6214)

D.R.Y.
											
										
										
											2016-11-01 05:56:32 +01:00
+								See [scope](syntax#scope).
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## Breadcrumbs
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								Breadcrumbs are the path of pages which need to be taken to reach the current page, and can be a great navigation aid
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								for website users.
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								While you can achieve breadcrumbs through the `$Level(<level>)` control manually, there's a nicer shortcut: The
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								`$Breadcrumbs` variable.
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$Breadcrumbs
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												Fixed docs paths (fixes #7075)

											
										
										
											2017-10-06 17:00:32 +02:00
+								By default, it uses the template defined in `templates/BreadcrumbsTemplate.ss`
 								of the `silverstripe/cms` module.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								<% if $Pages %>
 								    <% loop $Pages %>
 								        <% if $Last %>$Title.XML<% else %><a href="$Link">$MenuTitle.XML</a> &raquo;<% end_if %>
 								    <% end_loop %>
 								<% end_if %>
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[info]
-												DOC Update breadcrumb template in theme rather than app.

											
										
										
											2019-10-08 00:08:21 +02:00
+								To customise the markup that `$Breadcrumbs` generates, copy `templates/BreadcrumbsTemplate.ss`
 								 from the `silverstripe/cms` module to your theme (e.g.: `themes/you-theme/templates/BreadcrumbsTemplate.ss`).
 								 Modify the newly copied template and flush your Silverstripe CMS cache.
-												NEW: Update docs to be compliant with Gatsby site (#9314)

* First cut

* Temporarily disable composer.json for netlify build

* POC

* New recursive directory query, various refinements

* Fix flexbox

* new styled components plugin

* Apply frontmatter delimiters

* Mobile styles, animation

* Search

* Redesign, clean up

* Nuke the cache, try again

* fix file casing

* Remove production env file

* ID headers

* Move app to new repo

* Add frontmatter universally

* Hide children changelogs

* Add how to title

* New callout tags

* Revert inline code block change

* Replace note callouts

* Fix icons

* Repalce images

* Fix icon

* Fix image links

* Use proper SQL icon

											
										
										
											2019-11-18 05:58:33 +01:00
+								[/info]
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
 								## Forms
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```ss
-												Code block whitespace / formatting cleanup

											
										
										
											2017-10-27 04:38:27 +02:00
+								$Form
-												Replace all legacy ::: syntax with GFMD tags

											
										
										
											2017-08-03 02:51:32 +02:00
+								```
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												Update 02_Common_Variables.md
											
										
										
											2021-05-16 22:22:53 +02:00
+								A page will normally contain some content and potentially a form of some kind. For example, the log-in page has a
-												DOC Update SilverStripe to Silverstripe CMS

- Remaining Developer Guides and Upgrading
- SilverStripe in a namespace or api has not been change
- To keep PRs easier no formatting was changed

Update merge conflics with two files

Update Silverstripe Ltd, Silverstripe Cloud and Silverstripe CMS

Silverstripe CMS Ltd > Silverstripe Ltd
Silverstripe CMS Platform > Silverstripe Cloud
Silverstripe CMS Framework > Silverstripe CMS

Resolve merge conflict

Remove Framework from Silverstripe CMS Framework

- 3 files

Change SilverStripe CMS to Silverstripe CMS

											
										
										
											2021-06-30 11:48:52 +02:00
+								Silverstripe CMS log-in form. If you are on such a page, the `$Form` variable will contain the HTML content of the form.
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								Placing it just below `$Content` is a good default.
-												Add crosslinks to lessons

											
										
										
											2017-11-27 04:39:17 +01:00
+								## Related Lessons
 								* [Adding dynamic content](https://www.silverstripe.org/learn/lessons/v4/adding-dynamic-content-1)
 								## Related Documentation
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
-												MNT Fix various typos with codespell (#10177)


											
										
										
											2021-12-13 09:05:33 +01:00
+								 * [Casting and Formatting Variables](casting)
-												Tidy up templates guide

											
										
										
											2014-10-13 09:49:30 +02:00
+								 * [Template Inheritance](template_inheritance)
 								## API Documentation
-												FIX Add namespaces in markdown docs (#7088)

* FIX Add namespaces in markdown docs

* FIX Convert doc [link] to [link-text](link-uri)
											
										
										
											2017-07-03 03:22:12 +02:00
+								 * [ContentController](api:SilverStripe\CMS\Controllers\ContentController): The main controller responsible for handling pages.
 								 * [Controller](api:SilverStripe\Control\Controller): Generic controller (not specific to pages.)
 								 * [DataObject](api:SilverStripe\ORM\DataObject): Underlying model class for page objects.
 								 * [ViewableData](api:SilverStripe\View\ViewableData): Underlying object class for pretty much anything displayable.