Re: syntax diagramming tool

Subject: Re: syntax diagramming tool
From: Laura Lemay <lemay -at- lauralemay -dot- com>
To: Robert Lauriston <robert -at- lauriston -dot- com>
Date: Mon, 13 Oct 2014 15:41:04 -0700


The "ascii form" you mention is called EBNF ("extended backus-naur format") and there is a specification for defining languages in it. The diagrams are called railroad diagrams and are usually generated from the EBNF itself.

Note that EBNF is a technical specification, and the commands/syntax you are documenting may not actually conform to EBNF depending on how sloppy your developer is.

Laura


On Oct 13, 2014, at 1:04 PM, Robert Lauriston <robert -at- lauriston -dot- com> wrote:

> Any recommendations? Preferably single-source to HTML and PDF.
>
> Oracle's are kind of slick as in the HTML version they have text alternatives:
>
> http://docs.oracle.com/cd/B19306_01/server.102/b14200/statements_10002.htm#i2065706
>
> Teradata is maybe PDF only? See page 220.
>
> http://tunweb.teradata.ws/tunstudent/TeradataUserManuals/Teradata_SQL_Quick_Reference.pdf
>
> Microsoft Transact-SQL uses ASCII, which is what I'm currently using.
>
> http://msdn.microsoft.com/en-us/library/ms189499.aspx
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as lemay -at- lauralemay -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and info.
>
> Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
syntax diagramming tool: From: Robert Lauriston

Previous by Author: Re: Acronyms in Marketing Material
Next by Author: Re: syntax diagramming tool
Previous by Thread: syntax diagramming tool
Next by Thread: Re: syntax diagramming tool


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads