summaryrefslogtreecommitdiff
path: root/connectivity/registry
diff options
context:
space:
mode:
authorJulien Nabet <serval2412@yahoo.fr>2018-10-02 21:26:55 +0200
committerJulien Nabet <serval2412@yahoo.fr>2018-10-03 05:14:51 +0200
commit690dffce4fa5db01fcda60df467e75272d5a4863 (patch)
treebc8f25760eeabbb0a55ebd77cc06d2cfadee9493 /connectivity/registry
parent48cfa0b00b22f11ade53aec79b2fdddad253e1bd (diff)
Add README for xcu drivers in connectivity/registry
I used comments from https://bugs.documentfoundation.org/show_bug.cgi?id=119743 + https://gerrit.libreoffice.org/#/c/61144/ Thank you to Lionel and Stephan Change-Id: I956b0c2009e3fa1169ba57a059dde0016375def5 Reviewed-on: https://gerrit.libreoffice.org/61272 Reviewed-by: Lionel Elie Mamane <lionel@mamane.lu> Tested-by: Julien Nabet <serval2412@yahoo.fr>
Diffstat (limited to 'connectivity/registry')
-rw-r--r--connectivity/registry/README24
1 files changed, 24 insertions, 0 deletions
diff --git a/connectivity/registry/README b/connectivity/registry/README
new file mode 100644
index 000000000000..833006be3e3e
--- /dev/null
+++ b/connectivity/registry/README
@@ -0,0 +1,24 @@
+xcu files are made from several sections, the main ones are: Properties and Features
+
+Property: actual setting with its underlying type and its default value
+
+Feature: a boolean that says "let the user change that setting in the Advanced Settings UI"
+
+This is checked by using officecfg/registry/schema/org/openoffice/Office/DataAccess/Drivers.xcs
+and configmgr mechanism
+There are two kinds of properties named "Value":
+- first one is in "Property" groups and has a static oor:type="any" (can take on boolean, int and other types of values)
+- second one is in "Feature" groups and has a static oor:type="boolean" so can take on only boolean values.
+
+Each node in Feature section must have an equivalent in Property section
+Most of the time the node name of both sections should be equal,
+however there are 4 known exceptions (more?):
+- "UseBracketedOuterJoinSyntax" feature => "EnableOuterJoinEscape" property
+- "UseDOSLineEnds" feature => "PreferDosLikeLineEnds" property
+- "UseSQL92NamingConstraints" feature => "EnableSQL92Check" property
+- "UseKeywordAsBeforeAlias" feature => "GenerateASBeforeCorrelationName"
+
+See dbaccess/source/ui/dlg/DbAdminImpl.cxx, ODbDataSourceAdministrationHelper constructor, eg:
+m_aIndirectPropTranslator.emplace( <ID>, <property> )
+and dbaccess/source/ui/misc/dsmeta.cxx, lcl_getFeatureMappings() function, eg:
+{ <ID>, <feature> } \ No newline at end of file