There must be at most one <core:page> tag per JSP file because the path to the page is determined by the servlet requestPath (or most recent <ao:include>).
When this page is directly accessed, the page is rendered with the
page content coming from the body of this tag. The page is captured in BODY mode,
the view is resolved, and the page and view are forwarded to the theme to generate the output.
At least YYYY-MM-DD is required,
and when time not specified will default to midnight in the current system time zone.
A long value of -1 or 0 is converted to null.
When dateCreated and datePublished are the same date, prefer datePublished because it seems to have more use overall than created.
]]>
At least YYYY-MM-DD is required,
and when time not specified will default to midnight in the current system time zone.
A long value of -1 or 0 is converted to null.
When dateCreated and datePublished are the same date, prefer datePublished because it seems to have more use overall than created.
]]>
At least YYYY-MM-DD is required,
and when time not specified will default to midnight in the current system time zone.
A long value of -1 or 0 is converted to null.
At least YYYY-MM-DD is required,
and when time not specified will default to midnight in the current system time zone.
A long value of -1 or 0 is converted to null.
This has no equivalent in https://schema.org/, however we feel it is important to actively review content to ensure its accuracy, even when it has not been modified.
]]>SGML, forces the content-type to be text/html.
When XML, forces the content-type to be application/xhtml+xml.
When auto (the default), the following steps are performed to resolve the serialization:
com.aoapps.encoding.Serialization.default
that allows an application to control the selection of HTML versus XHTML.
auto,
determine the serialization based on the client's Accept header.
This should normally be left with the default value of auto. This is used
when the content is known to contain invalid markup that can not be parsed as XML.
default, HTML5, STRICT, TRANSITIONAL,
FRAMESET, or NONE.
Defaults to HTML5. NONE will suppress the output of a doctype.
When default, the following steps are performed to resolve the doctype:
com.aoapps.encoding.Doctype.default
that allows an application to control the default doctype.
default,
defaults to HTML5.
true, enables automatic newline (and tab indentation when enabled).
When false, disables automatic newline and tab indentation.
When auto (the default), the following steps are performed to resolve the autonli setting:
com.aoapps.html.servlet.DocumentEE.autonli
that allows an application to control the default autonli setting.
auto,
defaults to false.
true, enables tab indentation.
When false, disables tab indentation.
When auto (the default), the following steps are performed to resolve the indent setting:
com.aoapps.html.servlet.DocumentEE.indent
that allows an application to control the default indent setting.
auto,
defaults to false.
A short title is used when the context of a page is well established, such as when showing a path to the current location in the site.
The short title defaults to the page title.
]]>
When not allowed, a page will have <meta name="robots" content="noindex, nofollow" />
added and be excluded from sitemaps.
Links to the page will also have rel="nofollow" added.
Possible values are:
auto - Inherit setting from parent(s) within the book or book settings if have no parents within the booktrue - Robots allowedfalse - Robots not allowed
Defaults to auto.
Possible values are:
auto - Automatically selectedtrue - Always showfalse - Always hide
Defaults to auto.
true, it is acceptable for the parents to not list this page
as a child. In other words, this page may claim a parent that does
not also claim this as a child.
Parent-child relationships are never verified to parents from missing books.
Defaults to false meaning strict parent-child relationship verification.
Use of this can result in this page being orphaned, where this page and its child pages are not included in site traversals, such as for tree views or searches.
]]>true, it is acceptable for the children to not list this page
as a parent. In other words, this page may claim a child that does
not also claim this as a parent.
Child-parent relationships are never verified to children from missing books.
Defaults to false meaning strict child-parent relationship verification.
Use of this can result in incomplete determination of the children page's location(s) within the overall site.
]]>At least one field must be set to a non-null value.
Any field not set (or set to null) will be inherited from the parent(s) in the same book.
Any field set to "" will have no value and not inherit from parents.
If there are no parent pages in this same book, uses the fields from the book's copyright.
When inheriting a field from multiple parent pages, the field must have exactly the same value in all parents. Any mismatch in value will result in an exception.
]]>"" means none and null will inherit.
]]>"" means none and null will inherit.
]]>"" means none and null will inherit.
]]>When no authors provided, will use the author(s) of any parent page that is within the same book. If there are no parent pages in this same book, uses the book's authors.
When inheriting authorship from multiple parent pages, the authors must be in exact agreement. This means exactly the same order and all values matching precisely. Any mismatch in authors will result in an exception.
]]><meta name="author" content="…" />.
Required when neither href nor page are provided.
Also required when page provided and the page is in a different book.
]]><link rel="author" href="…" />
Required when neither name nor page are provided.
May not be used when page provided.
]]><link rel="author" href="…" />.
Required when neither name nor href are provided.
May not be used when href provided.
]]>To build the relationship between pages and parents, the page should include <core:parent> tags for each parent page within the body of the <core:page> tag.
Due to optimizations during page-only capturing, the parent pages must be added directly in the page body, not from within other nested elements.
This may not be set on the content.root of any of the books, as the
parent(s) of a book varies based on where the book is placed. The
parent(s) of a book are configured in the /WEB-INF/books.xml file.
All books require at least one parent except the rootBook which does not allow
any parent. These rules ensure a single root Directed Acyclic Graph (DAG).
If no parents are added, an automatic parent is computed as follows:
content.root of a book, include all parents configured in /WEB-INF/books.xml./, /index.jspx or /index.jsp,
look for JSP page at ../index.jspx or ../index.jsp then asssume ../,
error if outside book.
./index.jspx or ./index.jsp then assume ./.
Unless allowParentMismatch is enabled on the <core:page>,
the parent must also consider this page as a child.
To build the relationship between pages and subpages, the page should include <core:child> tags for each child page within the body of the <core:page> tag.
Due to optimizations during page-only capturing, the child pages must be added directly in the page body, not from within other nested elements.
Unless allowChildMismatch is enabled on the <core:page>,
the child must also consider this page as a parent.
Any attribute that has no namespace and begins with param. is added to the href as a URL parameter.
The parameter name is the part of the attribute name following param..
When a parameter value is null it is not added.
If the value is an
Iterable,
Iterator,
Enumeration,
or array, then each non-null element is coerced to
String as a separate
parameter in iteration order. Otherwise, the value itself is
coerced to String
for the parameter value.
Nested <core:param> or <core:params> tags will add parameters after any provided as attributes.
If there is no body, writes the target page title or element label.
]]><core:link class="" … />
]]>
This is used to reference SemanticCMS elements within a page.
Conflicts with the anchor attribute.
To reference a specific non-SemanticCMS-element target, use the anchor
attribute instead.
The anchor is automatically prefixed in multi-page views. The anchor is also URL-encoded.
]]>false, the default, may not link to generated ids.
This is to avoid broken links as it is preferred to set explicit ids on target elements.
Set to true to allow linking to generated element ids.
]]>
This is used to reference non-SemanticCMS-element targets within a page.
Conflicts with the element attribute.
To reference a specific SemanticCMS element, use the element
attribute instead.
The anchor is automatically prefixed in multi-page views. The anchor is also URL-encoded.
]]>Although view is site defined, some common values might include:
null, "", or content (the default and always supported) - Links to the page contentwhat-links-heretreeallfilesfalse, the default, will generate a <a> tag around the entire body.
Otherwise, will generate a <span> instead, with a small link added to
the end of the body.
Use of a small link can be helpful for usability, such as when the body is a piece of information intended for quick copy/paste by the user.
]]>true, generates an absolute URL for the href for the link.
Defaults to false.
]]>true, will generate a Canonical URL.
Canonical URLs should be used where per-user response URL rewriting
(such as information added when cookies are disabled) should be avoided.
Defaults to false.
]]>When provided, the values may not contain a Map or URIParameters. When provided, the exclude attribute may not be provided.
]]>Each pattern in the comma-separated list may be in the following format:
| exact_name | matches the name exactly |
| * | matches all (clears all parameters) |
| *suffix | matches the name with "endsWith" |
| prefix* | matches the name with "beginsWith" |
Defaults to none excluded.
]]>When name is provided, supports Iterable, Iterator, Enumeration, or array values.
When name is not provided, requires Map or URIParameters, where the parameter name is the map key coerced to String and the value (or set of values) is the map value. Each of the entry values may be Iterable, Iterator, Enumeration, array, or single value.
When obtaining values from a Map or URIParameters, parameters may be excluded with the "exclude" attribute.
Parameters are never added with null values.
If not provided, sets the property on the closest parent Node parent tag (either a Page or an Element).
The target must not be frozen, which, in the context of JSP, means only the parent element tags within the current page, and the current page itself, can reliably have properties set. Trying to set properties outside this scope is not advised and will likely be unreliable at best. An exception will be thrown when trying to set a property on a frozen node.
In the future, we may add "attributes" to nodes, which would provide for different scopes (application, session, request, page?) and could be changed dynamically.
]]>true.
When set to false (the default), and the property already exists,
an exception is thrown.
A property on a target may not be changed once set. This includes when it has
been set to null.
false.
]]>false.
]]>false.
]]>semanticcms-core-tree-this-page.
Only the first match is marked with id semanticcms-core-tree-this-page.
]]>semanticcms-core-links-to-page.
]]>0, the default, means unlimited depth.
]]>PAGE and META captures.
]]>false, the default, will call components in forward order.
When true, will call the components in the reverse order.
]]>
The capture is always done with a request method of GET, even when the enclosing request is a different method.
Parameter "book": The name of the book containing the page.
Parameter "page": The book-relative path to the page to capture,
must begin with a slash /.
Parameter "level": Controls the level of detail to capture. May be one of:
page - Fastest: captures page meta data only (including parent and child pages).meta - Captures page and content meta data, but no body content.body - Captures page and content meta data as well as all body content.
Level may need to be set to page when two pages capture each other (either directly
or indirectly). This may occur when these two pages capture each other for meta data,
such as automatic page title added to links.
Parameter "page": The page-relative path to the page to capture;
book-relative when begins with a slash /.
Parameter "level": Controls the level of detail to capture. May be one of:
page - Fastest: captures page meta data only (including parent and child pages).meta - Captures page and content meta data, but no body content.body - Captures page and content meta data as well as all body content.
Level may need to be set to page when two pages capture each other (either directly
or indirectly). This may occur when these two pages capture each other for meta data,
such as automatic page title added to links.
Will be one of:
null - No capture in progresspage - Fastest: capturing page meta data only.meta - Capturing page and content meta data, but no body content.body - Capturing page and content meta data as well as all body content.The page DAG starts as a single page with any number of children. Each of the child pages may, in turn, have children. The result of this transformation is a list of pages in depth-first traversal order.
A page may actually be linked into multiple places in the DAG, so strictly speaking this is a single root Directed Acyclic Graph (DAG).
Only the first occurance of each page will be in the resulting list.
Parameter "level": Controls the level of detail to capture. May be one of:
page - Fastest: captures page meta data only (including parent and child pages).meta - Captures page and content meta data, but no body content.body - Captures page and content meta data as well as all body content.
Encodes characters in the recommended UTF-8 encoding.
Deprecated: Please use ${ao:encodeURIComponent(value)} instead.
If the page is part of a page index, such as in a combined view,
will be page${pageNum}-${id}.
Otherwise, the id is unchanged.
If the page is part of a page index, such as in a combined view,
will be page${pageNum}-${id}.
Otherwise, the id is unchanged.
null when argument is null.
]]>null when argument is null.
]]>Map<String,String>.
Maintains the original parameter order.
Only uses the first of each value per parameter name, multiple values not supported.
Decodes characters in the recommended UTF-8 encoding.
null if none set.
Inherits fields from the parent page(s) within the same book, or uses fields from the book copyright if none set on the page or its parent(s).
]]>Inherits authors from the parent page(s) within the same book, or uses the book authors if none set on the page or its parent(s).
]]>Inherits setting from the parent page(s) within the same book, or uses the book allowRobots if none set on the page or its parent(s).
]]>These elements may be direct descendents or descendents further down the tree, but only the top-most descendents are returned.
If the node is a page, its elements are checked, but the elements of its child pages are not.
]]>null
if none registered.
]]>