Difference between revisions of "Dgp-edit"

From dbscript Online Help
Jump to: navigation, search
(Page Title placeholders)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Template:dbsweb}}
 
{{Template:dbsweb}}
  
Display and edit [[Documentation Generator Part]] properties
+
Display and edit [[Documentation Generator]] Part properties
  
'''Sequence
+
{| style="margin: 1em auto 1em auto; border: solid 1px black; width:100%; background: white; text-align: left"
 +
|-  valign="top"
 +
|'''Sequence
 +
|Sequence of the Part
 +
|-  valign="top"
 +
|'''XSL
 +
|Selected XSL Style Sheet
 +
|-  valign="top"
 +
|'''Type
 +
|See below
 +
|-  valign="top"
 +
|'''Object Type
 +
|Restrict this Part to objects of an Object Type
 +
|-  valign="top"
 +
|'''Object Selection
 +
|Restrict this Part to objects within an [[Object Selection]]
 +
|-  valign="top"
 +
|'''Page Title
 +
|Title of generated pages. See placeholders below.
 +
|-  valign="top"
 +
|'''Alternate Page Section
 +
|Use a section name different from the Documentation Generator [[Dg-edit|setting]]
 +
|}
  
'''XSL
+
=== Type ===
  
'''Type
+
{| border="1" cellpadding="5" cellspacing="0" style="border-collapse:collapse" width="80%"
 +
|-  valign="top"
 +
| Project Version
 +
| XML contains the whole database schema. This type is used for overview or Table of Contents pages.
  
'''Object Type
+
For SingleHTML documentation generators, this is the only option.
  
'''Object Selection
+
|-  valign="top"
 +
| Object
 +
| XML contains the definition of single objects.
 +
|-  valign="top"
 +
| Value Script
 +
| XML contains table values of a single table.
 +
|}
  
'''Page Title
+
=== Page Title placeholders ===
  
 
{| border="1" cellpadding="5" cellspacing="0" style="border-collapse:collapse" width="80%"
 
{| border="1" cellpadding="5" cellspacing="0" style="border-collapse:collapse" width="80%"
Line 52: Line 83:
 
|}
 
|}
  
'''Alternate Page Section
+
==== ScrewTurn Version 3 Notes ====
 +
 
 +
The ObjectType Wiki Suffix has spaces instead of underscores.
 +
 
 +
The object page title is "schema space object space (type)" instead of "schema dot object underscore (type)"

Latest revision as of 18:44, 9 January 2010

Online Documentation for dbscript by devio

Display and edit Documentation Generator Part properties

Sequence Sequence of the Part
XSL Selected XSL Style Sheet
Type See below
Object Type Restrict this Part to objects of an Object Type
Object Selection Restrict this Part to objects within an Object Selection
Page Title Title of generated pages. See placeholders below.
Alternate Page Section Use a section name different from the Documentation Generator setting

Type[edit]

Project Version XML contains the whole database schema. This type is used for overview or Table of Contents pages.

For SingleHTML documentation generators, this is the only option.

Object XML contains the definition of single objects.
Value Script XML contains table values of a single table.

Page Title placeholders[edit]

Type Default Substitutions
Project Version {0} {0} .. Project Version ID

{1} .. Project ID (V 0.99 and higher)

Object {1}.{0}{2}

for Schema-less Objects:

{0}{2}

{0} .. Object Name

{1} .. Schema Name

{2} .. ObjectType Wiki Suffix

{3} .. Project Version ID (V 0.99 and higher)

{4} .. Project ID (V 0.99 and higher)

Value Script {1}.{0}{2} {0} .. Table Name

{1} .. Schema Name

{2} .. "_(table)"

{3} .. Project Version ID (V 0.99 and higher)

{4} .. Project ID (V 0.99 and higher)

ScrewTurn Version 3 Notes[edit]

The ObjectType Wiki Suffix has spaces instead of underscores.

The object page title is "schema space object space (type)" instead of "schema dot object underscore (type)"