Re: [Firebird-docs] Conversion of fbcache-de
On 27-05-2020 10:57, Köditz, Martin wrote: I converted my first doc to asciiDoc: fbcache-de. I think everything is fine. I already uploaded the PDF and the HTML output. Please feel free to give me some feedback. https://firebirdsql.org/file/documentation/html/de/firebirddocs/fbcache/firebird-fbcache-de.html https://firebirdsql.org/file/documentation/pdf/de/firebirddocs/fbcache/firebird-fbcache-de.pdf I hadn't noticed it before, but the names of these files don't match the standard output of the build. The intent is for it to be possible to upload the build output without having to manually rename files. So to produce the right output, the German AsciiDoc file should match the intended output filename (for the names above, `firebird-fbcache-de.adoc`). We may want to consider tweaking the filenames further (eg to `firebird-cache` for English and `firebird-cache-de` for German), this avoids the repetition of `firebird` and its abbreviation `fb`. See also the suggested naming conventions at https://firebirdsql.org/file/documentation/html/en/firebirddocs/docwritehowto/firebird-docwriting-guide.html#docwritehowto-asciidoc-file-naming-convention Mark -- Mark Rotteveel ___ Firebird-docs mailing list Firebird-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/firebird-docs
[Firebird-docs] Style of rendering parameters
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
