I'm currently converting the Firebird Language Reference, and I was
wondering if there is a preference in the rendering of parameter lists
as used for function arguments and for syntax elements (in the current
language reference, a table is used).
I would like to have input on what style to apply
I have prepared three example:
1. full width table
2. autowidth table (which seems to have width issues in PDF)
3. definition list
Example 3 has my preference.
See
HTML:
https://www.lawinegevaar.nl/fbdocs/html/en/asciidoc-migration/example.html
PDF:
https://www.lawinegevaar.nl/fbdocs/pdf/en/asciidoc-migration/example.pdf
Equivalent in current language reference
HTML:
https://firebirdsql.org/file/documentation/reference_manuals/fblangref25-en/html/fblangref25-functions-scalarfuncs.html#fblangref25-functions-scalarfuncs-position
PDF:
https://firebirdsql.org/file/documentation/reference_manuals/fblangref25-en/Firebird_Language_Reference_25EN.pdf#%5B%7B%22num%22%3A2268%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22XYZ%22%7D%2C54%2C371.209%2Cnull%5D
For comparison, similar usage in the PostgreSQL documentation:
https://www.postgresql.org/docs/12/sql-insert.html#id-1.9.3.152.6
Mark
--
Mark Rotteveel
_______________________________________________
Firebird-docs mailing list
Firebird-docs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/firebird-docs
