Flat-URL

The Flat-URL header influences the URL for a node.

This header can be set to two possible values:

• true
• false

The default value is false.

By default, the node file path has a direct relationship to its URL in the generated web site. For example, the nodes/headers/title node on this documentation site ends up with a URL of /headers/title/.

However, when Flat-URL is set to true on a node, the URL of the generated page is modified. Instead of having a direct correspondence to the node file hierarchy, the node is moved directly up to the top of the URL hierarchy. For example, this page was generated from the nodes/headers/flat-url/index node, but since Flat-URL is set to true on this node, the resulting URL is /flat-url/. Notice how the /headers/ portion of the URL has disappeared? (The index portion isn't part of the URL because it is an index page.)

The usual node header inheritance rules apply, so once Flat-URL is set to true on a node, all child nodes will inherit that setting as well, unless the header is deleted.

Examples

Node	URL	Flat-URL
nodes/headers/flat-url/index	/flat-url/	true
nodes/headers/flat-url/true	/true/	true
nodes/headers/flat-url/false	/flat-url/false/	false
nodes/headers/title	/headers/title/	false
nodes/headers/index	/headers/	false
nodes/index	/	false

Tags: headers