Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

FarCry Documentation Plugin (farcrydoc)

Info
titleFarCry Component Documentation

The farcrydoc plugin is used to generate the static component documentation for the FarCry Framework. For details of libs, formtools, custom tags and more you can link direct to the latest export here:

http://docs.farcrycore.org/

Overview

Note

FarCry Doc Plugin requires a minimum of FarCry v4.x to function.

Excerpt

FarCry Documentation plugin provides extensive documentation on framework, plugin and project based components. An awesome utility for FarCry developers that dynamically introspects your installation to extract oodles of information.

Gallery

Download

You can grab the latest code base from the FarCry subversion repository:

  • v1.0.1 (suitable for FarCry v5.x+) Download or

    Code Block
    svn checkout checkout https://farcry.jira.com/svn/DOC/tags/milestone-1-0-1
  • trunk (under develoment, suitable for FarCry 6.x)

    Code Block
    svn checkout https://farcry.jira.com/svn/DOC/trunk

...

Code Block
titleExample ./www/farcryConstructor.cfm

<!--- FARCRY SPECIFIC --->
<cfset THIS.locales = "en_AU,en_US" />
<cfset THIS.dsn = "fullasagoog" /> 
<cfset THIS.dbType = "mssql" /> 
<cfset THIS.dbOwner = "dbo." /> 
<cfset THIS.plugins = "farcryblog,farcrycfimage,farcryverity,farcrydoc" /> 

...

Code Block
title./www/Application.cfm

<farcry:farcryInit
  name="daemon"
  dbType="mssql"
  plugins="farcrycms,farcryverity,googleMaps,farcrydoc" />

...