Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Excerpt

The FarCry Core framework takes cues from the URL to determine what content instance or content type and what view should be rendered in the browser. These variables are closely integrated with the Friendly URL engine to provide good looking URLs that can drive the frameworks output. Understanding how the URL is interpreted by the framework is an important part of FarCry development.

Info
titleDocumentation for the 5.2+ Core Release

The behaviour of the URL interpreter varies slightly between subsequent releases of FarCry – gradually improving functionality. This documentation reflects the 5.2+ release.

...

Predefined FUs are those URLs that are created for a new object and stored in the database.

Typical examples are:

  • /about-us/location

...

  • /news/no-news-is-good-news

...

This system can be used by users to control how people link to specific content objects in FarCry.

Constructed URLs were added recently. They allow a developer to override the page or body webskin in the URL, and add extra URL parameters.

Examples of these may be:

  • /news/archive/year/2008

...

  • /blogger/E6EB2B10-D311-11DE-9F5C001FD08AA651/rss

...

It is also possible to combine these, e.g. /news/no-news-is-good-news/comment-rss.

...

  • This order is strict. Once a variable is matched, it and previous possibilities are not considered again.
  • This includes name/value - once a "directory" defaults to the name/value option, only name/value will be checked again.
  • Type and/or objectid MUST be provided, either with a predefined FU prefix, or by including them in the constructed portion.

If you are explicit about the view to be called FarCry will follow your instructions – the more you leave out the more FarCry tries to "work out' what's needed.

Aliases

To avoid using the actual names of types and webskins in the URL we have added support for an fuAlias property. This property can be added to the content type as an attribute and to a webskin with a comment variable. This value can be used in the URL instead of the file name.

...

Note that ajaxmode=1 short circuits the view stack. This means a developer can access ANY fragment webskin with view=xyz&ajaxmode=1.

...

These allow a developer to use a FU without doing a database lookup themselves. As of this FarCry version they also handle constructed URLs automatically. Type, view and bodyView arguments are automatically converted to aliases where possible, urlParameters and stParameters are added as /name/value pairs.

...