Menu
▾
▴
firebird-docs — chat stuff about documentation
You can subscribe to this list here.
| 2001 |
Jan
|
Feb
(1) |
Mar
|
Apr
(36) |
May
(56) |
Jun
(1) |
Jul
(5) |
Aug
(3) |
Sep
(1) |
Oct
|
Nov
|
Dec
(1) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2002 |
Jan
|
Feb
|
Mar
(15) |
Apr
(5) |
May
(7) |
Jun
(5) |
Jul
(3) |
Aug
(6) |
Sep
(3) |
Oct
(8) |
Nov
(23) |
Dec
(21) |
| 2003 |
Jan
(25) |
Feb
(37) |
Mar
(59) |
Apr
(11) |
May
(8) |
Jun
(24) |
Jul
(18) |
Aug
(29) |
Sep
(30) |
Oct
(11) |
Nov
(20) |
Dec
(5) |
| 2004 |
Jan
(43) |
Feb
(24) |
Mar
(61) |
Apr
(14) |
May
(23) |
Jun
(50) |
Jul
(13) |
Aug
(56) |
Sep
(55) |
Oct
(64) |
Nov
(94) |
Dec
(27) |
| 2005 |
Jan
(40) |
Feb
(10) |
Mar
(55) |
Apr
(20) |
May
(16) |
Jun
(6) |
Jul
(58) |
Aug
(38) |
Sep
(5) |
Oct
(6) |
Nov
(71) |
Dec
(99) |
| 2006 |
Jan
(6) |
Feb
(15) |
Mar
(22) |
Apr
(9) |
May
(31) |
Jun
(35) |
Jul
(47) |
Aug
(18) |
Sep
(21) |
Oct
(24) |
Nov
(63) |
Dec
(79) |
| 2007 |
Jan
(22) |
Feb
(40) |
Mar
(47) |
Apr
(69) |
May
(22) |
Jun
(20) |
Jul
(25) |
Aug
(13) |
Sep
(7) |
Oct
(44) |
Nov
(76) |
Dec
(1) |
| 2008 |
Jan
(26) |
Feb
(30) |
Mar
(120) |
Apr
(14) |
May
(22) |
Jun
(40) |
Jul
(48) |
Aug
(7) |
Sep
(34) |
Oct
(31) |
Nov
|
Dec
(30) |
| 2009 |
Jan
(9) |
Feb
(6) |
Mar
(9) |
Apr
(2) |
May
(9) |
Jun
|
Jul
(31) |
Aug
(32) |
Sep
(15) |
Oct
(23) |
Nov
|
Dec
(9) |
| 2010 |
Jan
(19) |
Feb
(9) |
Mar
|
Apr
|
May
(9) |
Jun
(6) |
Jul
(8) |
Aug
(21) |
Sep
(10) |
Oct
(1) |
Nov
(3) |
Dec
(33) |
| 2011 |
Jan
|
Feb
(1) |
Mar
(4) |
Apr
(10) |
May
|
Jun
(9) |
Jul
(23) |
Aug
(2) |
Sep
(35) |
Oct
(36) |
Nov
|
Dec
(4) |
| 2012 |
Jan
(3) |
Feb
(8) |
Mar
(3) |
Apr
|
May
|
Jun
(5) |
Jul
|
Aug
|
Sep
|
Oct
(12) |
Nov
(12) |
Dec
|
| 2013 |
Jan
(18) |
Feb
(5) |
Mar
(1) |
Apr
|
May
|
Jun
(5) |
Jul
|
Aug
(21) |
Sep
|
Oct
(5) |
Nov
(1) |
Dec
(11) |
| 2014 |
Jan
|
Feb
|
Mar
(4) |
Apr
(2) |
May
|
Jun
|
Jul
(2) |
Aug
(5) |
Sep
(6) |
Oct
|
Nov
(29) |
Dec
|
| 2015 |
Jan
|
Feb
|
Mar
(14) |
Apr
|
May
|
Jun
|
Jul
(7) |
Aug
(7) |
Sep
(5) |
Oct
|
Nov
(6) |
Dec
(3) |
| 2016 |
Jan
(14) |
Feb
(9) |
Mar
(33) |
Apr
(12) |
May
(18) |
Jun
(3) |
Jul
|
Aug
(15) |
Sep
|
Oct
|
Nov
|
Dec
(22) |
| 2017 |
Jan
|
Feb
|
Mar
|
Apr
|
May
(10) |
Jun
|
Jul
|
Aug
|
Sep
|
Oct
(44) |
Nov
(32) |
Dec
(8) |
| 2018 |
Jan
(2) |
Feb
(25) |
Mar
(16) |
Apr
(11) |
May
(1) |
Jun
(19) |
Jul
(3) |
Aug
|
Sep
|
Oct
(25) |
Nov
|
Dec
|
| 2019 |
Jan
|
Feb
(2) |
Mar
|
Apr
(1) |
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
(2) |
Dec
(3) |
| 2020 |
Jan
(29) |
Feb
(28) |
Mar
(13) |
Apr
(13) |
May
(107) |
Jun
(75) |
Jul
(57) |
Aug
(36) |
Sep
(3) |
Oct
(4) |
Nov
(4) |
Dec
(1) |
| 2021 |
Jan
(2) |
Feb
(13) |
Mar
(5) |
Apr
(6) |
May
(44) |
Jun
(9) |
Jul
(9) |
Aug
(3) |
Sep
(11) |
Oct
(5) |
Nov
(14) |
Dec
(19) |
| 2022 |
Jan
(1) |
Feb
|
Mar
|
Apr
(4) |
May
(1) |
Jun
(1) |
Jul
(13) |
Aug
(6) |
Sep
(2) |
Oct
(7) |
Nov
(2) |
Dec
|
| 2023 |
Jan
(2) |
Feb
|
Mar
(13) |
Apr
(2) |
May
(31) |
Jun
(12) |
Jul
(5) |
Aug
(5) |
Sep
(27) |
Oct
(7) |
Nov
(25) |
Dec
(7) |
| 2024 |
Jan
(11) |
Feb
(27) |
Mar
(3) |
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
|
|
From: Mark R. <no...@gi...> - 2020-06-18 17:40:35
|
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: 7471df7ee9a7158d54e7853722298457603b3ac8 https://github.com/FirebirdSQL/firebird-documentation/commit/7471df7ee9a7158d54e7853722298457603b3ac8 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-18 (Thu, 18 Jun 2020) Changed paths: A src/docs/asciidoc/en/firebirddocs/fbutil/fbmgr/firebird-fbmgr.adoc M src/docs/asciidoc/fb-docs-redirects.txt R src/docs/firebirddocs/fbutil_fbmgr.xml M src/docs/firebirddocs/firebirddocs.xml Log Message: ----------- Migrate fbutil_fbmgr.xml to AsciiDoc |
|
From: Mark R. <no...@gi...> - 2020-06-17 19:40:28
|
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: 6de4475b79c29ec46efa3725b22a59985ccd4195 https://github.com/FirebirdSQL/firebird-documentation/commit/6de4475b79c29ec46efa3725b22a59985ccd4195 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-17 (Wed, 17 Jun 2020) Changed paths: A src/docs/asciidoc/de/attributes-de.adoc M src/docs/asciidoc/de/firebirddocs/fbcache/firebird-cache-de.adoc M src/docs/asciidoc/de/refdocs/fblangref25/firebird-25-sprachreferenz.adoc Log Message: ----------- Provide translation for labels |
|
From: Mark R. <ma...@la...> - 2020-06-15 19:07:15
|
On 15-06-2020 20:24, Alexey Kovyazin (ak) wrote: ... > Another question - do you plan to convert also Developers Guide? Yes, that is the plan. Mark -- Mark Rotteveel |
|
From: Paul V. <pa...@vi...> - 2020-06-15 18:53:37
|
Mark Rotteveel wrote: > I was planning on converting the fbutil-* documentation next, however I > was wondering how to approach this. Historically, we have released those > as individual documentation, while at the same time they were also > intended to be a single volume (the "Firebird Command Line Utilities" book). > > Should I convert them individually (and 'throw away' the fbutil-intro, > fbutil-outro and fbutil-appendix that are only referred from the > "Firebird Command Line Utilities" book), or should I try to preserve > this by allowing them to be built as individual books and as a combined > volume? I think it's far more practical to have them as separate docs. I also don't see the extra value in a combined volume if separate docs exist - but would have nothing against it either. Cheers, Paul Vinkenoog |
|
From: Alexey K. (ak) <ak...@ib...> - 2020-06-15 18:24:45
|
Hello Mark, I think it is necesary to keep the current structure, and unite them only virtually, since "command line tools" is a weak basis for grouping such different tools. Theoretically, they should be parts of Firebird Admin Guide, but now they are just pieces. Another question - do you plan to convert also Developers Guide? Regards, Alexey Kovyazin пн, 15 июн. 2020 г., 21:13 Mark Rotteveel <ma...@la...>: > I was planning on converting the fbutil-* documentation next, however I > was wondering how to approach this. Historically, we have released those > as individual documentation, while at the same time they were also > intended to be a single volume (the "Firebird Command Line Utilities" > book). > > Should I convert them individually (and 'throw away' the fbutil-intro, > fbutil-outro and fbutil-appendix that are only referred from the > "Firebird Command Line Utilities" book), or should I try to preserve > this by allowing them to be built as individual books and as a combined > volume? > > I should note that the text in the intro and outro is outdated because > it wasn't updated for several utilitities that are actually documented > (like gfix, gstat and isql). > > Mark > -- > Mark Rotteveel > > > _______________________________________________ > Firebird-docs mailing list > Fir...@li... > https://lists.sourceforge.net/lists/listinfo/firebird-docs > |
|
From: Mark R. <ma...@la...> - 2020-06-15 18:13:27
|
I was planning on converting the fbutil-* documentation next, however I was wondering how to approach this. Historically, we have released those as individual documentation, while at the same time they were also intended to be a single volume (the "Firebird Command Line Utilities" book). Should I convert them individually (and 'throw away' the fbutil-intro, fbutil-outro and fbutil-appendix that are only referred from the "Firebird Command Line Utilities" book), or should I try to preserve this by allowing them to be built as individual books and as a combined volume? I should note that the text in the intro and outro is outdated because it wasn't updated for several utilitities that are actually documented (like gfix, gstat and isql). Mark -- Mark Rotteveel |
|
From: Mark R. <no...@gi...> - 2020-06-15 17:50:53
|
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: 98aceb3cf7b8aad24c5c85b530e6d496c16843db https://github.com/FirebirdSQL/firebird-documentation/commit/98aceb3cf7b8aad24c5c85b530e6d496c16843db Author: Mark Rotteveel <ma...@la...> Date: 2020-06-15 (Mon, 15 Jun 2020) Changed paths: M src/docs/asciidoc/fb-docs-redirects.txt Log Message: ----------- Redirects for German Firebird 2.5 Language Reference |
|
From: Köditz, M. <Mar...@it...> - 2020-06-13 15:54:21
|
Hi Mark, thank you. I will investigate the changes. The new structure helps enormously. Regards Martin |
|
From: Mark R. <ma...@la...> - 2020-06-13 14:54:33
|
I have migrated to German Firebird 2.5 Language Reference (Firebird 2.5 Sprachreferenz) to AsciiDoc. Links: https://www.firebirdsql.org/file/documentation/html/de/refdocs/fblangref25/firebird-25-sprachreferenz.html https://www.firebirdsql.org/file/documentation/pdf/de/refdocs/fblangref25/firebird-25-sprachreferenz.pdf I will link them from the home page later this week. Be aware, I noticed some parts of this language reference sometimes still have English; this was already the case in the original. Some of the fixes I introduced in the English version, I copied without translation, and in some cases I used Google translate. Mark -- Mark Rotteveel |
|
From: Mark R. <no...@gi...> - 2020-06-13 14:38:21
|
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: d6b75e49ed5bbc4fcc3a60c2ef729a9cda29bd51 https://github.com/FirebirdSQL/firebird-documentation/commit/d6b75e49ed5bbc4fcc3a60c2ef729a9cda29bd51 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-13 (Sat, 13 Jun 2020) Changed paths: A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-appx01-supplement-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-appx02-errorcodes-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-appx03-reskeywords-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-appx04-systables-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-appx05-montables-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-appx06-charsets-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-appx07-license-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-commons-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-context-vars-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-datatypes-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-ddl-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-dml-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-dochist-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-functions-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-intro-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-psql-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-security-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-structure-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/_fblangref25-transacs-de.adoc A src/docs/asciidoc/de/refdocs/fblangref25/firebird-25-sprachreferenz.adoc R src/docs/refdocs-de/langref/fblangref25/fblangref25-appx01-supplement-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-appx02-errorcodes-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-appx03-reskeywords-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-appx04-systables-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-appx05-montables-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-appx06-charsets-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-appx07-license-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-commons-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-datatypes-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-ddl-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-dml-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-dochist-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-functions-vars-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-intro-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-psql-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-security-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-structure-de.xml R src/docs/refdocs-de/langref/fblangref25/fblangref25-transacs-de.xml M src/docs/refdocs-de/refdocs-de.xml Log Message: ----------- Migrate German Firebird 2.5 Language Reference to AsciiDoc Commit: ac65ee2c065fec5700726664188ffae3c6356d68 https://github.com/FirebirdSQL/firebird-documentation/commit/ac65ee2c065fec5700726664188ffae3c6356d68 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-13 (Sat, 13 Jun 2020) Changed paths: M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-appx02-errorcodes.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-appx04-systables.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-appx05-montables.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-appx07-license.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-commons.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-context-vars.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-datatypes.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-ddl.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-dml.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-dochist.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-functions.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-intro.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-psql.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-security.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-structure.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-transacs.adoc M src/docs/asciidoc/en/refdocs/fblangref25/firebird-25-language-reference.adoc Log Message: ----------- Various minor changes in copy and styling while checking migrating the German version to AsciiDoc Compare: https://github.com/FirebirdSQL/firebird-documentation/compare/55843db3f92a...ac65ee2c065f |
|
From: Mark R. <ma...@la...> - 2020-06-06 15:24:55
|
On 06-06-2020 11:14, Alexey Kovyazin wrote: > Hello, > > Looks good! Thank you for your efforts, Mark! > > What is the next - Firebird Developers Guide? > Or Quick Start Guide? Or something else? Right now I'm transforming the German Firebird 2.5 Language Reference, while I still have a rough idea of the transformations I applied to the English version. Mark -- Mark Rotteveel |
|
From: Alexey K. <ak...@ib...> - 2020-06-06 09:14:40
|
Hello, Looks good! Thank you for your efforts, Mark! What is the next - Firebird Developers Guide? Or Quick Start Guide? Or something else? Regards, Alexey On 06.06.2020 11:37, Mark Rotteveel wrote: > I have updated the documentation section on the site to point to the > new version. > > Mark |
|
From: Mark R. <ma...@la...> - 2020-06-06 08:38:09
|
I have updated the documentation section on the site to point to the new version. Mark -- Mark Rotteveel |
|
From: Mark R. <no...@gi...> - 2020-06-06 08:34:04
|
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: 55843db3f92a188c879d5795e76f9a2bcbe08625 https://github.com/FirebirdSQL/firebird-documentation/commit/55843db3f92a188c879d5795e76f9a2bcbe08625 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-06 (Sat, 06 Jun 2020) Changed paths: M src/docs/asciidoc/fb-docs-redirects.txt Log Message: ----------- Add redirects for fblangref25 English |
|
From: Mark R. <no...@gi...> - 2020-06-06 08:13:27
|
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: 8ac2e22f49ed906349ed79b0bf36eda21fb4fd36 https://github.com/FirebirdSQL/firebird-documentation/commit/8ac2e22f49ed906349ed79b0bf36eda21fb4fd36 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-06 (Sat, 06 Jun 2020) Changed paths: M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-dochist.adoc M src/docs/asciidoc/en/refdocs/fblangref25/firebird-25-language-reference.adoc Log Message: ----------- Update document history |
|
From: Mark R. <no...@gi...> - 2020-06-06 08:05:40
|
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: e51bba2fc77702b356f8ad703fa191fa230bc6c7 https://github.com/FirebirdSQL/firebird-documentation/commit/e51bba2fc77702b356f8ad703fa191fa230bc6c7 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-06 (Sat, 06 Jun 2020) Changed paths: M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-dml.adoc Log Message: ----------- Remove incorrect caution re expressions in order by Commit: 0a5b336619ce72ddeb00b4454ba40b9ef0f6f9e8 https://github.com/FirebirdSQL/firebird-documentation/commit/0a5b336619ce72ddeb00b4454ba40b9ef0f6f9e8 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-06 (Sat, 06 Jun 2020) Changed paths: M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-context-vars.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-functions.adoc Log Message: ----------- Apply consistent order in function and variables documentation Compare: https://github.com/FirebirdSQL/firebird-documentation/compare/9f59d2d96491...0a5b336619ce |
|
From: Mark R. <no...@gi...> - 2020-06-05 19:14:17
|
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: 9f59d2d964917e2c2c5d6dcfcd7eb03fe6606ad1 https://github.com/FirebirdSQL/firebird-documentation/commit/9f59d2d964917e2c2c5d6dcfcd7eb03fe6606ad1 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-05 (Fri, 05 Jun 2020) Changed paths: M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-context-vars.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-functions.adoc Log Message: ----------- Capitalize section titles for consistency |
|
From: Mark R. <no...@gi...> - 2020-06-05 19:10:37
|
Branch: refs/heads/master Home: https://github.com/FirebirdSQL/firebird-documentation Commit: 3a892a281a8c498b0997ad9b9df2293f94bb4cde https://github.com/FirebirdSQL/firebird-documentation/commit/3a892a281a8c498b0997ad9b9df2293f94bb4cde Author: Mark Rotteveel <ma...@la...> Date: 2020-06-05 (Fri, 05 Jun 2020) Changed paths: A src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-context-vars.adoc M src/docs/asciidoc/en/refdocs/fblangref25/firebird-25-language-reference.adoc Log Message: ----------- Split context vars and functions, step 1: copy Commit: 0b00bb437395cb50382655d28c30053c0e8b35f4 https://github.com/FirebirdSQL/firebird-documentation/commit/0b00bb437395cb50382655d28c30053c0e8b35f4 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-05 (Fri, 05 Jun 2020) Changed paths: R src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-functions-vars.adoc A src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-functions.adoc M src/docs/asciidoc/en/refdocs/fblangref25/firebird-25-language-reference.adoc Log Message: ----------- Split context vars and functions, step 2: rename functions-vars -> functions Commit: cb5fa9c88439dca90a589baa4c6d26d63d83dbd1 https://github.com/FirebirdSQL/firebird-documentation/commit/cb5fa9c88439dca90a589baa4c6d26d63d83dbd1 Author: Mark Rotteveel <ma...@la...> Date: 2020-06-05 (Fri, 05 Jun 2020) Changed paths: M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-commons.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-context-vars.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-datatypes.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-dml.adoc M src/docs/asciidoc/en/refdocs/fblangref25/_fblangref25-functions.adoc M src/docs/asciidoc/en/refdocs/fblangref25/firebird-25-language-reference.adoc Log Message: ----------- Split context vars and functions, step 3 remove content reorder functions first, rename sections for more consistency Compare: https://github.com/FirebirdSQL/firebird-documentation/compare/636bdd908d64...cb5fa9c88439 |
|
From: Paul V. <pa...@vi...> - 2020-06-04 16:23:44
|
Mark Rotteveel wrote: >> I also don't like the thematic subdivisioning of the current Scalar >> Functions chapter. It has certain advantages, but they are small >> in my opinion. > I generally like the subdivision by target datatype: it allows me to > drill down quickly to what I need, while also supporting looking for a > function for say - string manipulation - without knowing its name (or > even its existence) and not getting distracted by functions for other > datatypes. Especially with the growth of functions in Firebird 3 and > Firebird 4, such a sub-division seems a good thing to retain to me. I must admit that the growth of functions is a good argument for keeping the thematic subdivision. > The current list of functions in each section should already be ordered > alphabetically, but I'll double check. Yes, it looks like they are. Cheers, Paul |
|
From: Simonov D. <sim...@li...> - 2020-06-04 14:18:46
|
Mark Rotteveel <ma...@la...> wrote Wed, 03 Jun 2020 21:37:12 +0300: > On 01-06-2020 17:52, Mark Rotteveel wrote: >> I have migrated the Firebird 2.5 Language Reference, and it is >> available for preview on: >> HTML: >> https://firebirdsql.org/file/documentation/html/en/refdocs/fblangref25/firebird-25-language-reference.html >> PDF: > https://firebirdsql.org/file/documentation/pdf/en/refdocs/fblangref25/firebird-25-language-reference.pdf > > I have found an issue (which already existed in the TOC page of the old > PDF) which I think is annoying for usability. In the 'Built-in functions > and Variables' chapter, the actual functions don't appear in the TOC, > because they are on the fourth level. This makes them harder to find. > > There are several ways to address this: > > 1. Increase the TOC depth to 4. Overall, I thinks this inflates the TOC > too much. > > 2. Add a section TOC to the sections of 'Scalar Functions'. Defining > these TOCs would be manual work, but the advantage is that the list is > 'inline' in the main body of text. I prefer this option > 3. Remove the section 'Scalar Functions', so the sections inside it go a > level up. This would be the simplest, but reduces the organization of > the chapter. Firebird 4.0 has a lot more function subgroups. There at least security functions are added (encryption, etc.) > > 4. Split chapter 'Built-in functions and Variables' into three chapters, > 'Context Variables', 'Scalar Functions' and 'Aggregate Functions'. This > will fix the immediate problem, but feels a bit strange to do, and > reduces the cohesion (especially between Scalar Functions and Aggregate > Functions). Don’t forget that there are still window functions in Firebird 3.0. > > I'm a bit split between option 2 and 3, but what do you think? > > Mark -- Simonov Denis |
|
From: Mark R. <ma...@la...> - 2020-06-04 11:24:31
|
On 2020-06-04 11:37, Paul Vinkenoog wrote: > Mark Rotteveel wrote: >> There are several ways to address this: >> >> 1. Increase the TOC depth to 4. Overall, I thinks this inflates the >> TOC >> too much. > > Agreed. However, I would be in favour of extending the number of > 'Bookmarks' > (i.e. the links in the nav pane) levels to four. We had this in our > previous > build system and it works fine, provided the PDF doesn't open with all > levels > expanded by default. (We had this set at one level, i.e. chapter level > in a > book, and top section level in an article.) > > Would that be possible in the current system as well? I will need to double check, by default the depth is tied to the depth of the TOC, but I found mention of a property (outlinelevels) that might control this separately (both depth and what is expanded). However, that would be specific to the PDF. For the HTML I would need to increase the TOC depth overall. >> 2. Add a section TOC to the sections of 'Scalar Functions'. Defining >> these TOCs would be manual work, but the advantage is that the list is >> 'inline' in the main body of text. > > I personally don't like inline ToCs in the text. They don't really help > navigation if you're ten pages down. I'd rather have all levels > available in > the bookmarks then. Ok, that makes sense. I was more thinking about a solution for going to - for example - the "Functions for Working with Strings" section, and then seeing the entire list and go from there. >> 3. Remove the section 'Scalar Functions', so the sections inside it go >> a >> level up. This would be the simplest, but reduces the organization of >> the chapter. >> >> 4. Split chapter 'Built-in functions and Variables' into three >> chapters, >> 'Context Variables', 'Scalar Functions' and 'Aggregate Functions'. >> This >> will fix the immediate problem, but feels a bit strange to do, and >> reduces the cohesion (especially between Scalar Functions and >> Aggregate >> Functions). > > 5. Split chapter 'Built-in functions and Variables' into two chapters: > 'Context variables' and 'Internal Functions' (the latter without > further > subdivisions for scalar vs. aggregate functions). > > I'd be in favour of this regardless of the ToC issue. > > I also don't like the thematic subdivisioning of the current Scalar > Functions > chapter. It has certain advantages, but they are small in my opinion. I generally like the subdivision by target datatype: it allows me to drill down quickly to what I need, while also supporting looking for a function for say - string manipulation - without knowing its name (or even its existence) and not getting distracted by functions for other datatypes. Especially with the growth of functions in Firebird 3 and Firebird 4, such a sub-division seems a good thing to retain to me. > I think it's far more practical to have the functions ordered > alphabetically. > In most cases, the name tells you immediately what kind of function it > is. > Furthermore, this is a reference guide, not a language course or > tutorial. > Most people will look here for information on a function whose name > they > already know or can reasonably guess. (Again, this wil work best if you > can click the list open in the nav pane.) > > Option 4 is also fine IMO, but please with alphabetic ordering. Right now I'm leaning to option 4 (subdivision per primary datatype of a function, with the chapter division you proposed under option 5. The current list of functions in each section should already be ordered alphabetically, but I'll double check. Mark |
|
From: Paul V. <pa...@vi...> - 2020-06-04 09:37:30
|
Mark Rotteveel wrote: > > PDF: > https://firebirdsql.org/file/documentation/pdf/en/refdocs/fblangref25/firebird-25-language-reference.pdf > > I have found an issue (which already existed in the TOC page of the old > PDF) which I think is annoying for usability. In the 'Built-in functions > and Variables' chapter, the actual functions don't appear in the TOC, > because they are on the fourth level. This makes them harder to find. > > There are several ways to address this: > > 1. Increase the TOC depth to 4. Overall, I thinks this inflates the TOC > too much. Agreed. However, I would be in favour of extending the number of 'Bookmarks' (i.e. the links in the nav pane) levels to four. We had this in our previous build system and it works fine, provided the PDF doesn't open with all levels expanded by default. (We had this set at one level, i.e. chapter level in a book, and top section level in an article.) Would that be possible in the current system as well? > 2. Add a section TOC to the sections of 'Scalar Functions'. Defining > these TOCs would be manual work, but the advantage is that the list is > 'inline' in the main body of text. I personally don't like inline ToCs in the text. They don't really help navigation if you're ten pages down. I'd rather have all levels available in the bookmarks then. > 3. Remove the section 'Scalar Functions', so the sections inside it go a > level up. This would be the simplest, but reduces the organization of > the chapter. > > 4. Split chapter 'Built-in functions and Variables' into three chapters, > 'Context Variables', 'Scalar Functions' and 'Aggregate Functions'. This > will fix the immediate problem, but feels a bit strange to do, and > reduces the cohesion (especially between Scalar Functions and Aggregate > Functions). 5. Split chapter 'Built-in functions and Variables' into two chapters: 'Context variables' and 'Internal Functions' (the latter without further subdivisions for scalar vs. aggregate functions). I'd be in favour of this regardless of the ToC issue. I also don't like the thematic subdivisioning of the current Scalar Functions chapter. It has certain advantages, but they are small in my opinion. I think it's far more practical to have the functions ordered alphabetically. In most cases, the name tells you immediately what kind of function it is. Furthermore, this is a reference guide, not a language course or tutorial. Most people will look here for information on a function whose name they already know or can reasonably guess. (Again, this wil work best if you can click the list open in the nav pane.) Option 4 is also fine IMO, but please with alphabetic ordering. Paul Vinkenoog |
|
From: Norman D. <No...@du...> - 2020-06-03 22:15:38
|
I favour option 1 then option 2 Mark. Cheers, Norm. -- Sent from my Android device with K-9 Mail. Please excuse my brevity. |
|
From: Mark R. <ma...@la...> - 2020-06-03 18:37:39
|
On 01-06-2020 17:52, Mark Rotteveel wrote: > I have migrated the Firebird 2.5 Language Reference, and it is available > for preview on: > > HTML: > https://firebirdsql.org/file/documentation/html/en/refdocs/fblangref25/firebird-25-language-reference.html > > PDF: https://firebirdsql.org/file/documentation/pdf/en/refdocs/fblangref25/firebird-25-language-reference.pdf I have found an issue (which already existed in the TOC page of the old PDF) which I think is annoying for usability. In the 'Built-in functions and Variables' chapter, the actual functions don't appear in the TOC, because they are on the fourth level. This makes them harder to find. There are several ways to address this: 1. Increase the TOC depth to 4. Overall, I thinks this inflates the TOC too much. 2. Add a section TOC to the sections of 'Scalar Functions'. Defining these TOCs would be manual work, but the advantage is that the list is 'inline' in the main body of text. 3. Remove the section 'Scalar Functions', so the sections inside it go a level up. This would be the simplest, but reduces the organization of the chapter. 4. Split chapter 'Built-in functions and Variables' into three chapters, 'Context Variables', 'Scalar Functions' and 'Aggregate Functions'. This will fix the immediate problem, but feels a bit strange to do, and reduces the cohesion (especially between Scalar Functions and Aggregate Functions). I'm a bit split between option 2 and 3, but what do you think? Mark -- Mark Rotteveel |
|
From: Alexey K. <ak...@ib...> - 2020-06-01 16:23:34
|
Hello Mark, PDF link is the same as HTML. Regards, Alexey On 01.06.2020 18:52, Mark Rotteveel wrote: > I have migrated the Firebird 2.5 Language Reference, and it is > available for preview on: > > HTML: > https://firebirdsql.org/file/documentation/html/en/refdocs/fblangref25/firebird-25-language-reference.html > PDF: > https://firebirdsql.org/file/documentation/html/en/refdocs/fblangref25/firebird-25-language-reference.html > > > I haven't linked it yet from the documentation page, and I still need > to do some changes like removing that incorrect caution we discussed > earlier. > > This isn't a direct migration: after the migration I touched a lot of > things (like syntax blocks) for consistency, and here and there I > clarified or corrected some texts. > > I had to revert my changes to the padding of the tables in PDF, > because it caused rather tight columns in Appendix B. > > Mark |
58 messages has been excluded from this view by a project administrator.
