docs/content/pages.md - Issue 29977630: Noissue - Add [paths] documentation and remove trailing spaces

Side by Side Diff: docs/content/pages.md

Issue 29977630: Noissue - Add [paths] documentation and remove trailing spaces (Closed) Base URL: https://hg.adblockplus.org/cms/

Patch Set: Reword [paths] documentation Created Jan. 14, 2019, 3:10 p.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

View unified diff | Download patch

« no previous file with comments | « docs/api/functions.md ('k') | docs/content/settings.md » ('j') | docs/content/settings.md » ('J')

OLD	NEW
1 # Pages #	1 # Pages #

2	2

3 The pages are defined in the `pages` directory. The file extension defines the	3 The pages are defined in the `pages` directory. The file extension defines the

4 format in which a page is specified and won't be visible on the web server.	4 format in which a page is specified and won't be visible on the web server.

5 The page name is prepended by the locale code in the URL, e.g. `pages/foo.md`	5 The page name is prepended by the locale code in the URL, e.g. `pages/foo.md`

6 can be available under the URLs `/en/foo` and `/de/foo` (the English and German	6 can be available under the URLs `/en/foo` and `/de/foo` (the English and German

7 versions respectively). Regardless of the format, a page can define a number of	7 versions respectively). Regardless of the format, a page can define a number of

8 settings using the following format:	8 settings using the following format:

9	9

10 setting = value	10 setting = value

11	11

12 Note that the settings have to placed at the beginning of the file, before the	12 Note that the settings have to placed at the beginning of the file, before the

13 actual content. The following settings can be changed:	13 actual content. The following settings can be changed:

14	14

15 * `template`: This defines the template to be used for this page (without the	15 * `template`: This defines the template to be used for this page (without the

16 file extension). By default the `default` template is used for all pages.	16 file extension). By default the `default` template is used for all pages.

17 * `title`: The locale string to be used as page title. By default the `title`	17 * `title`: The locale string to be used as page title. By default the `title`

18 string is used.	18 string is used.

19 * `noheading`: Setting this to any value will make sure no heading is displayed.	19 * `noheading`: Setting this to any value will make sure no heading is displayed.

20 By default a `<h1>` tag with the page title is added above the content.	20 By default a `<h1>` tag with the page title is added above the content.

21 * `notoc`: Setting this to any value will prevent a table of contents from being	21 * `notoc`: Setting this to any value will prevent a table of contents from being

22 generated. By default a table of contents is always generated if the page	22 generated. By default a table of contents is always generated if the page

23 contains any headers with an `id` attribute.	23 contains any headers with an `id` attribute.

24	24

25 For information on using includes on pages, read the guide on	25 For information on using includes on pages, read the guide on

26 [Include files](includes.md)	26 [Include files](includes.md)

27	27

28 ## Markdown format (md) ##	28 ## Markdown format (md) ##

29	29

30 This format should normally be used, it allows the pages to be defined using the	30 This format should normally be used, it allows the pages to be defined using the

31 [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax. Raw HTML	31 [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax. Raw HTML

32 tags are allowed and can be used where Markdown syntax isn't sufficient. The	32 tags are allowed and can be used where Markdown syntax isn't sufficient. The

33 [Python-Markdown Extra](https://pythonhosted.org/Markdown/extensions/extra.html)	33 [Python-Markdown Extra](https://pythonhosted.org/Markdown/extensions/extra.html)

34 extension is active and allows specifying custom attributes for the generated	34 extension is active and allows specifying custom attributes for the generated

35 HTML tags, HTML block elements that contain Markdown and more.	35 HTML tags, HTML block elements that contain Markdown and more.

(...skipping 35 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
71	71

72 ## Jinja2 format (tmpl) ##	72 ## Jinja2 format (tmpl) ##

73	73

74 Complicated pages can be defined using the	74 Complicated pages can be defined using the

75 [Jinja2 template format](http://jinja.pocoo.org/docs/templates/). Automatic	75 [Jinja2 template format](http://jinja.pocoo.org/docs/templates/). Automatic

76 escaping is active so by default values inserted into the page cannot contain	76 escaping is active so by default values inserted into the page cannot contain

77 any HTML code. Any content between `<head>` and `</head>` tags will be inserted	77 any HTML code. Any content between `<head>` and `</head>` tags will be inserted

78 into the head of the generated web page, everything else defined the content of	78 into the head of the generated web page, everything else defined the content of

79 the page.	79 the page.

80	80

81 Read the API documentation on [variables](../api/variables.md),	81 Read the API documentation on [variables](../api/variables.md),

82 [global functions](../api/functions.md), and [custom filters](../api/filters.md)	82 [global functions](../api/functions.md), and [custom filters](../api/filters.md)

83 that can be used on pages.	83 that can be used on pages.

84	84

85 Prev: [Various include files (`includes`)](includes.md) \| Up: [Home](../../READM E.md) \| Next: [Static content (`static`)](static.md)	85 Prev: [Various include files (`includes`)](includes.md) \| Up: [Home](../../READM E.md) \| Next: [Static content (`static`)](static.md)

OLD	NEW