Reference

Owned by Geoff Bowers
Last updated: Dec 23, 2008Version comment

The FarCry framework has a vast array of functionality under the hood. The Reference section is a series of cheat sheets detailing the various configuration options, attributes and conventions of various aspects of the framework.

References
  • Deployment Configurations — With the release of Fortress there will be several recommended deployment options. Given the flexibility of the environment many other configurations are possible, however, they will not be specifically tested for. These deployment options will be fully supported in the Fortress installer.
  • Event hooks — Several kinds of features and functionality need to hook into certain events. Examples of an existing hook is the types.afterSave function which allows a developer to run their own code in the event of a save, without mucking about with setData.
  • Floater Menu Replacement — It's time for the floater menu to go. (NB: the floater menu appears in the top left corner of a FarCry website when an administrator is loggged in). It doesn't scroll with page anymore (removed due to performance issues on some browsers and designs), blocks the right click context menu, has options we don't need, is missing others that would be really useful. Also it's ugly.
  • Formtools
  • Friendly URL Controller — 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.
  • Friendly URLs — Friendly URLs in the past had a number of limitations not the least of which was the requirement of the "/go/" prefix and the inability to easily add url attributes in addition to the friendly url string.
  • Internationalisation (i18n) — The webtop and COAPI (meaning all forms that use formtools) have been updated so that every label and description is translated.
  • Pagination
  • Security Model — FarCry has its own in-built, roles based security model that is leveraged by the framework, and custom applications.
  • Webskin Templates — FarCry allows you to nominate whatever naming structure you like for templates. However, there is a special convention for FarCry template naming that can help you avoid unnecessary coding and configuration. Just follow the default naming standards for templates and you'll find a lot of things just fall into place.
  • Webtop Configuration — FarCry has an administrative web interface called the "webtop". The webtop can be configured to suit your specific implementation. It's possible to change the permissions, menu structure, tabs, inline documentation and more.
  • webTop Overview — The webtop overview is a collection of webskins that render out the default admin view for any content item. The FarCry framework provides a default overview for all content types. However, the view can be overridden in both plugins and the project as needed.
  • Workflow Framework