Commit 7323ee53 authored by David Metzler's avatar David Metzler
Browse files

1st Stab at documentatioin updates.

parent 3b4af74d
......@@ -9,15 +9,16 @@
<frx:options hidden="1" />
<frx:fields>
<frx:field id="title" link="reports/{name}" />
<frx:field id="admin_reports" link="admin/structure/forena">admin/structure/forena</frx:field>
</frx:fields>
<frx:parameters />
<frx:docgen />
</head>
<body>
<div id="forena-1" frx:block="forena_help/design_topics">
<h2>Add Report</h2>
<p>To create a report, select the Add Report from your
Navigation menu. Site administrators can relocate this menu so
<div id="design_topics_block" frx:block="forena_help/design_topics">
<h2>Create Report</h2>
<p>To create a report, visit the {admin_reports}
page and select the . Site administrators can relocate this menu so
contact your site administrator if you have trouble finding it.</p>
<p>
The <b>Report Name</b> is a unique name that is used as the base
......
......@@ -19,9 +19,10 @@
<p>Forena is a report writing tool that is designed to help
developers who are knowledgeable in writing SQL.</p>
<p>Report definitions are stored as files on the file system in
.frx files. These files are basically extended XHTML template files.
.frx files. These files are basically XHTML template files extended with
frx namespaced attributes and elements.
Report authors need only to learn a few special attributes and tags
(e.g. frx:block frx:foreach) to create reports in virtually any
(e.g. frx:block, frx:foreach, frx:if) to create reports in virtually any
layout. Frx report files are typically stored in a location writable
by the web user, so that they can be authored using a WYSIWYG report
editor. Report definitions can typically be modified by a group of
......
......@@ -45,10 +45,11 @@
core developers may use any string that they want in creating
rights. There is unfortunately no easy way in drupal to list module
permissions, but after the permission has been granted to a role,
you may use the {role_report} to determine</p>
you may use the {role_report} to determine a listing of rights that may be used
to identify permissons</p>
<h3>Parameters</h3>
<p>
The <strong>:role</strong> parameter in the example is named token
The <strong>:role</strong> parameter in the above example is named token
that will be replaced in the SQL query with a parameter from the
report. The parameter replacement is done by forena in a way that
protects against SQL injection. Although these tokens are modeled
......@@ -97,14 +98,14 @@
complexity and don't get included unless needed. The following
example illustrates this technique</p>
<pre>
--ACCESS=access content
SELECT * from states
--IF=:state
WHERE code=:state
--ELSE
WHERE code='AL'
--END
ORDER BY NAME
--ACCESS=access content
SELECT * from states
--IF=:state
WHERE code=:state
--ELSE
WHERE code='AL'
--END
ORDER BY NAME
</pre>
<p>In the above example the Where clause is only added when there
is a value specified for :state. If no value for :state is provided
......
......@@ -15,7 +15,7 @@
</frx:fields>
</head>
<body>
<div id="forena-1" frx:block="forena_help/design_topics">
<div id="design_topics_block" frx:block="forena_help/design_topics">
<p>Specify the data you want to include in your report. Data
blocks are typically provided by developers or site
administrators. Each data block corresponds to a specific query to
......@@ -37,7 +37,7 @@
check the checkboxes next to the Data Block that is currently
being displayed and press save.</p>
<ul>
<li id="forena-2" frx:foreach="*">{title}</li>
<li id="design_topics" frx:foreach="*">{title}</li>
</ul>
</div>
</body>
......
......@@ -16,8 +16,8 @@
</frx:fields>
</head>
<body>
<ul id="forena-1" frx:block="forena_help/design_topics">
<li id="forena-2" frx:foreach="*"><span>{title}</span></li>
<ul id="design_topics_block" frx:block="forena_help/design_topics">
<li id="design_topics" frx:foreach="*"><span>{title}</span></li>
</ul>
<h2 id="overview">Overview</h2>
<p>Forena reports are defined using the Forena Report Xml template
......
......@@ -16,10 +16,10 @@
</head>
<body>
<div id="forena-1" frx:block="forena_help/design_topics">
<p>In the fields tab, specify fomatting options for how you want
each field to display when it is used in the report. &nbsp;Fields
in the report are the tokens which are used to substitute data
into the report and are found between the curly braces.</p>
<p>Fields in the report are the tokens which are used to substitute data
into the report and are found between the curly braces. When editing a
report you click on the gear symbol next to the first use of a particular token
to configure field formatting for that token.</p>
<h2>Formatting Field Output</h2>
<p>Fields can be formatted a number of different ways depending
on the format and format-string specified for each field. &nbsp;
......
......@@ -17,13 +17,12 @@
<body>
<div id="forena-1" frx:block="forena_help/design_topics">
<h2>Form</h2>
<p>Forena supports the concepts of report forms, allowING you to
<p>Forena supports the concepts of report skins, allowing you to
leverage a common set of css and javascript libraries to make the
most out of your reports. &nbsp;For example, if you specified a
value of "standard_letter", then forena will include
standard_letter.css and standard_letter.js files in your report,
provided that they exist. &nbsp;&nbsp;</p>
<h2>Document Options</h2>
most out of your reports. &nbsp;Skins must be defined by creating .skinfo
files that define which css files and js files get included when using a
particular skin.</p>
<h2>Document Types</h2>
<p>Forena supports conversion of html documents into several
common document formats. &nbsp;The exact list of options that you
will see here will be determined by the site administrator.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment