Difference between revisions of "App Doc"

From Lianjapedia
Jump to: navigation, search
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
''Under Construction - Coming Soon in Lianja v5.0''
+
''Coming Soon in Lianja v5.0''
 
+
==Overview==
 
[[{{ns:file}}:l5_appdoc1.png|800px|border|left|link={{filepath:l5_appdoc1.png}}|Generate App Doc - lianjademo]]
 
[[{{ns:file}}:l5_appdoc1.png|800px|border|left|link={{filepath:l5_appdoc1.png}}|Generate App Doc - lianjademo]]
 
<br clear=all>
 
<br clear=all>
 +
 +
The '''Generate App Doc...''' menu item from the [[App Builder MenuBar]] automatically generates documentation for the current App.  The documentation can be viewed and also printed from the '''Print''' button.
 +
 +
==Content==
 +
The '''Table of contents''' displays the App hierarchy, starting with the [[App Settings]]:
 +
 +
{| class="wikitable" width="100%"
 +
!width="20%"|Settings
 +
!width="80%"|Description
 +
|-
 +
|valign="top"|Summary||Key settings for the App
 +
|-
 +
|valign="top"|Locale||Locale configuration settings
 +
|-
 +
|valign="top"|App Center||App Center tile and runtime settings
 +
|-
 +
|valign="top"|General Configuration||General App configuration settings
 +
|-
 +
|valign="top"|Code Libraries||The custom code libraries for the App.  This includes links to open the selected library in the [[Script Editor]].
 +
|-
 +
|valign="top"|Delegates||Event delegate settings
 +
|-
 +
|valign="top"|Permissions and Roles||[[Users and Roles|Permission and role settings]]
 +
|-
 +
|valign="top"|UI Presentation Rules||[[UI Presentation Rules]] settings for the App's target client platforms
 +
|-
 +
|}
 +
 +
It then displays the Page count and for each Page, its Section count, its Sections and the Sections' Formitems along with the populated attributes and values for each of these UI elements.
 +
 +
The links in the '''Table of contents''' and the '''Contents''', '''Back''' and '''Forward''' buttons can be used to quickly navigate the documentation.
 +
 +
==Customizable Content==
 +
The [[General_Settings#App_Doc|App Doc]] App Setting and [[General_Settings#App_Doc|App Doc]] attribute for [[Page Attributes|Pages]], [[:Category:Attributes#Sections|Sections]], [[:Category:Attributes#Gadgets|Gadgets]], [[Field Attributes|Form Section Fields]] and [[Advanced Canvas Control Attributes|Canvas Section Advanced Controls]] allow the developer to include customized HTML content in the generated App Doc. 
 +
 +
Clicking the [...] button automatically creates an empty HTML file, populates the App Doc attribute with the name of the file and opens the file in the built-in HTML editor.
 +
 +
[[{{ns:file}}:l5_appdoc2.png|800px|border|left|link={{filepath:l5_appdoc2.png}}|Customized App Doc]]
 +
<br clear=all>
 +
 +
The content of the HTML file is displayed in the '''About''' panel at the top of the information about the App or UI element as in the [[#Overview|'''About this App''' example above]].
  
 
==See Also==
 
==See Also==

Revision as of 06:43, 13 August 2019

Coming Soon in Lianja v5.0

Overview

Generate App Doc - lianjademo


The Generate App Doc... menu item from the App Builder MenuBar automatically generates documentation for the current App. The documentation can be viewed and also printed from the Print button.

Content

The Table of contents displays the App hierarchy, starting with the App Settings:

Settings Description
Summary Key settings for the App
Locale Locale configuration settings
App Center App Center tile and runtime settings
General Configuration General App configuration settings
Code Libraries The custom code libraries for the App. This includes links to open the selected library in the Script Editor.
Delegates Event delegate settings
Permissions and Roles Permission and role settings
UI Presentation Rules UI Presentation Rules settings for the App's target client platforms

It then displays the Page count and for each Page, its Section count, its Sections and the Sections' Formitems along with the populated attributes and values for each of these UI elements.

The links in the Table of contents and the Contents, Back and Forward buttons can be used to quickly navigate the documentation.

Customizable Content

The App Doc App Setting and App Doc attribute for Pages, Sections, Gadgets, Form Section Fields and Canvas Section Advanced Controls allow the developer to include customized HTML content in the generated App Doc.

Clicking the [...] button automatically creates an empty HTML file, populates the App Doc attribute with the name of the file and opens the file in the built-in HTML editor.

Customized App Doc


The content of the HTML file is displayed in the About panel at the top of the information about the App or UI element as in the About this App example above.

See Also

Database Doc