From c1f50aa63d77da2029ead4f1f438c97c5ca052af Mon Sep 17 00:00:00 2001 From: Moritz 'e1mo' Fromm Date: Fri, 30 Oct 2020 15:04:47 +0100 Subject: [PATCH] Update README.md in regard to string encapsulation We are now using the correct string encapsulation syntax in the README.md and added a small note above the example code. See #3, #1 --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b16ce43..eadf156 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,9 @@ Example Playbook -Node: When you want to define multi-dimensional configuration parameters in `dokuwiki_additonal_configuration` you can concatenate the levels using `>` in the name as a seperator. So `auth>mysql>server` would become `$conf['auth']['mysql']['server']`. +Note: When you want to define multi-dimensional configuration parameters in `dokuwiki_additonal_configuration` you can concatenate the levels using `>` in the name as a separator. So `auth>mysql>server` would become `$conf['auth']['mysql']['server']`. + +Further more, all strings inside the `dokuwiki_additonal_configuration` list must be wrapped in two quotation marks like so: `"'my string'"`. The double quotation marks tell ansible that the value is a string and so the single quotation marks will be a normal part of the string and placed as a string in the `local.php`. See [#3](https://github.com/chaos-jetzt/ansible-role-dokuwiki/pull/3#issuecomment-719563190) for another explanation why it's done that way. ```yaml --- @@ -57,13 +59,13 @@ Node: When you want to define multi-dimensional configuration parameters in `dok source: "https://www.dokuwiki.org/lib/tpl/dokuwiki/images/logo.png" dokuwiki_additonal_configuration: - name: 'auth>mysql>server' - value: localhost + value: "'localhost'" - name: 'auth>mysql>user' - value: dbuser + value: "'dbuser'" - name: 'auth>mysql>password' - value: localhost + value: "'localhost'" - name: 'auth>mysql>database' - value: localhost + value: "'localhost'" ``` License