Merge pull request #577 from iterate-ch/issue/532-addendum

Corrected missed formatting mistakes

README.md

@@ -25,3 +25,114 @@ Output can be found in `_build/html`.
 ## Contributions
 
 Contributions to this documentation are welcome. Please open a pull request.
+
+---
+
+## General Formatting Guidelines
+
+Add an empty line...
+- ...after a heading
+- ...before and after an admonition or codeblock
+- ...after the admonition class for custom admonitions
+- ...after a tab opening and before a tab closing as shown in the [Tabs Section](#tabs)
+- ...before and after tables
+- ...before and after image inserts with custom properties
+
+Indent codeblocks and admonitions within numbered lists, as the numbers aren't rendered correctly otherwise.
+
+### Footnotes
+
+- This is a manually-numbered footnote reference.[^3]
+- This is an auto-numbered footnote reference.[^myref]
+
+[^myref]: This is an auto-numbered footnote definition.
+[^3]: This is a manually-numbered footnote definition.
+
+A longer footnote definition.[^mylongdef]
+
+[^mylongdef]: This is the _**footnote definition**_.
+
+    That continues for all indented lines
+
+    - even other block elements
+
+    Plus any preceding unindented lines,
+that are not separated by a blank line
+
+### Tabs
+Group tabs allow to select a tab for the whole page. As an example: If a page contains three group tabs with macOS and Windows as options and you select macOS for one section then all the sections on the page will switch to macOS.
+
+```
+::::{tabs}
+:::{group-tab} macOS
+
+text
+
+:::
+:::{group-tab} Windows
+
+text
+
+:::
+::::
+```
+
+Regular tabs are limited to the section and doesn't affect any other tabs on the page.
+
+```
+::::{tabs}
+:::{tab} Text 1
+
+text
+
+:::
+:::{tab} Text 2
+
+text
+
+:::
+```
+
+### Quotes and Code
+
+````
+```
+This is a codeblock
+```
+````
+
+`this is in line code`
+
+```
+> this is a single line Quote
+```
+
+### Links und Downloadlinks
+Add those inline into the text where needed.
+
+```
+[Formatting Cheat Sheet](Formatting_Cheat-Sheet)
+```
+
+```
+{download}`Title<Download_Link>`
+```
+
+### Admonitions
+Admonitions are boxes with a colored background that highlight information. Available admonition types are: note, warning, tip, caution, attention, danger, error, hint, important, and seealso
+
+```
+:::{<type>}
+text
+:::
+```
+
+Admonitions can also be used with custom titles by using the format below.
+
+```
+:::{admonition} Custom Title
+:class: tip
+
+text
+:::
+```

cli/index.md

@@ -430,21 +430,21 @@ The support directory is `~/.duck/` on Linux. You can install third party [profi
 
 You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell.
 
-`env "property.name=value" duck`
+`env "<property>=<value>" duck`
 
 :::
 :::{group-tab} Windows
 
 You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell.
 
-`set "property.name=value" & duck`
+`set "<property>=<value>" & duck`
 
 :::
 :::{group-tab} Linux
 
 You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell.
 
-`env "property.name=value" duck`
+`env "<property>=<value>" duck`
 
 :::
 ::::

cyberduck/bookmarks.md

@@ -247,16 +247,16 @@ Choose a default bookmark to open after opening the application. Choose *Prefere
 
 ### Do not Read favicon.ico from HTTP URL
 
-A [hidden configuration option](preferences.md#hidden-configuration-options). Displayed in the bookmark edit window.
+A [hidden configuration option](../tutorials/hidden_properties.md). Displayed in the bookmark edit window.
 
 ```
-defaults write ch.sudo.cyberduck bookmark.favicon.download false
+bookmark.favicon.download=false
 ```
 
 ### Open Bookmark View after Disconnecting
 
-A [hidden configuration option](preferences.md#hidden-configuration-options).
+A [hidden configuration option](../tutorials/hidden_properties.md).
 
 ```
-defaults write ch.sudo.cyberduck browser.disconnect.bookmarks.show true
+browser.disconnect.bookmarks.show=true
 ```

cyberduck/browser.md

@@ -132,7 +132,7 @@ Select the file in the browser and press the *Return key*. Type the new name and
 
 ### Deleting Files and Folders
 
-Some protocols support the trashing of files instead of permanently deleting them.  This feature is enabled by default. It can be disabled using a [hidden configuration option](preferences.md#hidden-configuration-options).
+Some protocols support the trashing of files instead of permanently deleting them.  This feature is enabled by default. It can be disabled using a [hidden configuration option](../tutorials/hidden_properties.md).
 
 ```
 browser.delete.trash=false
@@ -151,17 +151,18 @@ Select the file in the browser and choose *File → Info (macOS `⌘I` Windows `
 
 ### Quick Look
 
-:::{admonition} macOS only
+::::{admonition} macOS only
 :class: tip
 
 You can toggle Quick Look in a Cyberduck browser for any file using *Space Bar*. A preview is rendered depending on a Quick Look Plugin available on your system for the given file type. Many file types like different image formats can be previewed with the bundled plugins in OS X and HTML is even rendered in the Quick Look preview panel.
-:::
 
 :::{image} _images/quicklook.png
 :alt: Quicklook
 :width: 500px
 :::
 
+::::
+
 ### Open or Copy HTTP URL
 
 See bookmark [Web URL configuration](bookmarks.md#http-url) for HTTP URLs. You can select multiple files to open/copy all URLs.
@@ -260,18 +261,18 @@ Use only one *Info* window which updates with the selection change in the browse
 
 ### Adjust the Browser Font Size
 
-A [hidden configuration option](preferences.md#hidden-configuration-options).
+A [hidden configuration option](../tutorials/hidden_properties.md).
 
 ```
-defaults write ch.sudo.cyberduck browser.font.size 18
+browser.font.size=18
 ```
 
 ### Duplicate Filename Format
 
-A [hidden configuration option](preferences.md#hidden-configuration-options). Define a different format using 
+A [hidden configuration option](../tutorials/hidden_properties.md). Define a different format using 
 
 ```
-defaults write ch.sudo.cyberduck browser.duplicate.format "{0} ({1}){2}"
+browser.duplicate.format="{0} ({1}){2}"
 ```
 
 where the plaseholders will be replaced with
@@ -282,15 +283,15 @@ where the plaseholders will be replaced with
 
 ### Warning Before Renaming or Moving Files
 
-A [hidden configuration option](preferences.md#hidden-configuration-options). A confirmation is shown before renaming or moving files.
+A [hidden configuration option](../tutorials/hidden_properties.md). A confirmation is shown before renaming or moving files.
 
 ```
-defaults write ch.sudo.cyberduck browser.move.confirm true
+browser.move.confirm=true
 ```
 
 ### Re-Enable File Listing Limit Prompt
 
-A [hidden configuration option](preferences.md#hidden-configuration-options) can re-enable the file listing limit prompt after dismissing it with enabled *Always* checkbox.
+A [hidden configuration option](../tutorials/hidden_properties.md) can re-enable the file listing limit prompt after dismissing it with enabled *Always* checkbox.
 
 ::::{tabs}
 :::{group-tab} macOS

cyberduck/connection.md

@@ -201,26 +201,26 @@ Choose *Cyberduck → Preferences → Connection → Use system proxy settings*.
 
 #### Prefer IPv6 Addresses of DNS Lookups
 
-A [hidden configuration option](preferences.md#hidden-configuration-options).
+A [hidden configuration option](../tutorials/hidden_properties.md).
 
 ```
-defaults write ch.sudo.cyberduck connection.dns.ipv6 true
+connection.dns.ipv6=true
 ```
 
 #### Disable Bonjour Support
 
-A [hidden configuration option](preferences.md#hidden-configuration-options).
+A [hidden configuration option](../tutorials/hidden_properties.md).
 
 ```
-defaults write ch.sudo.cyberduck rendezvous.enable false
+rendezvous.enable=false
 ```
 
 #### Disable Bonjour Notifications in Notification Center and System Tray
 
-A [hidden configuration option](preferences.md#hidden-configuration-options). By default, the limit is set to allow not more than `30` notifications per minute.
+A [hidden configuration option](../tutorials/hidden_properties.md). By default, the limit is set to allow not more than `30` notifications per minute.
 
 ```
-defaults write ch.sudo.cyberduck rendezvous.notification.limit 0
+rendezvous.notification.limit=0
 ```
 
 ## Default Protocol Handler