[DERBY-6345] Correct Getting Started syntax topic and include it in Reference Manual

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Duplicate
• Affects Version/s: 10.10.1.1
• Component/s: Documentation
• Assignee: Camilla Haase
• Reporter: Camilla Haase
• Created: 16/Sep/13 14:21
• Updated: 03/Oct/13 19:47
• Resolved: 03/Oct/13 19:47

Description

The "SQL syntax" topic of the Getting Started guide has a misleading description of the meaning of curly braces: "Groups items so that they can be marked with one of the symbols [ ], |, or *."

In the manuals, the actual usage is to group required items so that they can be marked with "|" (to indicate a choice of one of several items). The description should be fixed.

Also, the syntax conventions are not solely for SQL. In the Getting Started manual, the conventions are also used for commands such as sysinfo. So perhaps the title should be changed there to something more general.

In addition, since syntax is used primarily in the Reference Manual, the "SQL syntax" topic should also be placed in that manual, probably in the "About this guide" section at the beginning. Here the title is appropriate, since the syntax conventions seem to be used only in SQL syntax.

Issue Links

• is related to: DERBY-6121 Regularize how we refer to object names in the Reference Manual