Skip to content

Commit debf5fb

Browse files
Cassie205Cassie205
authored
Merge pull request #577 from iterate-ch/issue/532-addendum
Corrected missed formatting mistakes
2 parents ed27b31 + 8443ef6 commit debf5fb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+447
-401
lines changed

Diff for: ‎Formatting_Cheat-Sheet.md

-123
This file was deleted.

Diff for: ‎README.md

+111
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,114 @@ Output can be found in `_build/html`.
2525
## Contributions
2626

2727
Contributions to this documentation are welcome. Please open a pull request.
28+
29+
---
30+
31+
## General Formatting Guidelines
32+
33+
Add an empty line...
34+
- ...after a heading
35+
- ...before and after an admonition or codeblock
36+
- ...after the admonition class for custom admonitions
37+
- ...after a tab opening and before a tab closing as shown in the [Tabs Section](#tabs)
38+
- ...before and after tables
39+
- ...before and after image inserts with custom properties
40+
41+
Indent codeblocks and admonitions within numbered lists, as the numbers aren't rendered correctly otherwise.
42+
43+
### Footnotes
44+
45+
- This is a manually-numbered footnote reference.[^3]
46+
- This is an auto-numbered footnote reference.[^myref]
47+
48+
[^myref]: This is an auto-numbered footnote definition.
49+
[^3]: This is a manually-numbered footnote definition.
50+
51+
A longer footnote definition.[^mylongdef]
52+
53+
[^mylongdef]: This is the _**footnote definition**_.
54+
55+
That continues for all indented lines
56+
57+
- even other block elements
58+
59+
Plus any preceding unindented lines,
60+
that are not separated by a blank line
61+
62+
### Tabs
63+
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.
64+
65+
```
66+
::::{tabs}
67+
:::{group-tab} macOS
68+
69+
text
70+
71+
:::
72+
:::{group-tab} Windows
73+
74+
text
75+
76+
:::
77+
::::
78+
```
79+
80+
Regular tabs are limited to the section and doesn't affect any other tabs on the page.
81+
82+
```
83+
::::{tabs}
84+
:::{tab} Text 1
85+
86+
text
87+
88+
:::
89+
:::{tab} Text 2
90+
91+
text
92+
93+
:::
94+
```
95+
96+
### Quotes and Code
97+
98+
````
99+
```
100+
This is a codeblock
101+
```
102+
````
103+
104+
`this is in line code`
105+
106+
```
107+
> this is a single line Quote
108+
```
109+
110+
### Links und Downloadlinks
111+
Add those inline into the text where needed.
112+
113+
```
114+
[Formatting Cheat Sheet](Formatting_Cheat-Sheet)
115+
```
116+
117+
```
118+
{download}`Title<Download_Link>`
119+
```
120+
121+
### Admonitions
122+
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
123+
124+
```
125+
:::{<type>}
126+
text
127+
:::
128+
```
129+
130+
Admonitions can also be used with custom titles by using the format below.
131+
132+
```
133+
:::{admonition} Custom Title
134+
:class: tip
135+
136+
text
137+
:::
138+
```

Diff for: ‎cli/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -430,21 +430,21 @@ The support directory is `~/.duck/` on Linux. You can install third party [profi
430430

431431
You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell.
432432

433-
`env "property.name=value" duck`
433+
`env "<property>=<value>" duck`
434434

435435
:::
436436
:::{group-tab} Windows
437437

438438
You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell.
439439

440-
`set "property.name=value" & duck`
440+
`set "<property>=<value>" & duck`
441441

442442
:::
443443
:::{group-tab} Linux
444444

445445
You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell.
446446

447-
`env "property.name=value" duck`
447+
`env "<property>=<value>" duck`
448448

449449
:::
450450
::::

Diff for: ‎cyberduck/bookmarks.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -247,16 +247,16 @@ Choose a default bookmark to open after opening the application. Choose *Prefere
247247

248248
### Do not Read favicon.ico from HTTP URL
249249

250-
A [hidden configuration option](preferences.md#hidden-configuration-options). Displayed in the bookmark edit window.
250+
A [hidden configuration option](../tutorials/hidden_properties.md). Displayed in the bookmark edit window.
251251

252252
```
253-
defaults write ch.sudo.cyberduck bookmark.favicon.download false
253+
bookmark.favicon.download=false
254254
```
255255

256256
### Open Bookmark View after Disconnecting
257257

258-
A [hidden configuration option](preferences.md#hidden-configuration-options).
258+
A [hidden configuration option](../tutorials/hidden_properties.md).
259259

260260
```
261-
defaults write ch.sudo.cyberduck browser.disconnect.bookmarks.show true
261+
browser.disconnect.bookmarks.show=true
262262
```

Diff for: ‎cyberduck/browser.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Select the file in the browser and press the *Return key*. Type the new name and
132132

133133
### Deleting Files and Folders
134134

135-
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).
135+
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).
136136

137137
```
138138
browser.delete.trash=false
@@ -151,17 +151,18 @@ Select the file in the browser and choose *File → Info (macOS `⌘I` Windows `
151151

152152
### Quick Look
153153

154-
:::{admonition} macOS only
154+
::::{admonition} macOS only
155155
:class: tip
156156

157157
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.
158-
:::
159158

160159
:::{image} _images/quicklook.png
161160
:alt: Quicklook
162161
:width: 500px
163162
:::
164163

164+
::::
165+
165166
### Open or Copy HTTP URL
166167

167168
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
260261

261262
### Adjust the Browser Font Size
262263

263-
A [hidden configuration option](preferences.md#hidden-configuration-options).
264+
A [hidden configuration option](../tutorials/hidden_properties.md).
264265

265266
```
266-
defaults write ch.sudo.cyberduck browser.font.size 18
267+
browser.font.size=18
267268
```
268269

269270
### Duplicate Filename Format
270271

271-
A [hidden configuration option](preferences.md#hidden-configuration-options). Define a different format using
272+
A [hidden configuration option](../tutorials/hidden_properties.md). Define a different format using
272273

273274
```
274-
defaults write ch.sudo.cyberduck browser.duplicate.format "{0} ({1}){2}"
275+
browser.duplicate.format="{0} ({1}){2}"
275276
```
276277

277278
where the plaseholders will be replaced with
@@ -282,15 +283,15 @@ where the plaseholders will be replaced with
282283

283284
### Warning Before Renaming or Moving Files
284285

285-
A [hidden configuration option](preferences.md#hidden-configuration-options). A confirmation is shown before renaming or moving files.
286+
A [hidden configuration option](../tutorials/hidden_properties.md). A confirmation is shown before renaming or moving files.
286287

287288
```
288-
defaults write ch.sudo.cyberduck browser.move.confirm true
289+
browser.move.confirm=true
289290
```
290291

291292
### Re-Enable File Listing Limit Prompt
292293

293-
A [hidden configuration option](preferences.md#hidden-configuration-options) can re-enable the file listing limit prompt after dismissing it with enabled *Always* checkbox.
294+
A [hidden configuration option](../tutorials/hidden_properties.md) can re-enable the file listing limit prompt after dismissing it with enabled *Always* checkbox.
294295

295296
::::{tabs}
296297
:::{group-tab} macOS

Diff for: ‎cyberduck/connection.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -201,26 +201,26 @@ Choose *Cyberduck → Preferences → Connection → Use system proxy settings*.
201201

202202
#### Prefer IPv6 Addresses of DNS Lookups
203203

204-
A [hidden configuration option](preferences.md#hidden-configuration-options).
204+
A [hidden configuration option](../tutorials/hidden_properties.md).
205205

206206
```
207-
defaults write ch.sudo.cyberduck connection.dns.ipv6 true
207+
connection.dns.ipv6=true
208208
```
209209

210210
#### Disable Bonjour Support
211211

212-
A [hidden configuration option](preferences.md#hidden-configuration-options).
212+
A [hidden configuration option](../tutorials/hidden_properties.md).
213213

214214
```
215-
defaults write ch.sudo.cyberduck rendezvous.enable false
215+
rendezvous.enable=false
216216
```
217217

218218
#### Disable Bonjour Notifications in Notification Center and System Tray
219219

220-
A [hidden configuration option](preferences.md#hidden-configuration-options). By default, the limit is set to allow not more than `30` notifications per minute.
220+
A [hidden configuration option](../tutorials/hidden_properties.md). By default, the limit is set to allow not more than `30` notifications per minute.
221221

222222
```
223-
defaults write ch.sudo.cyberduck rendezvous.notification.limit 0
223+
rendezvous.notification.limit=0
224224
```
225225

226226
## Default Protocol Handler

0 commit comments

Comments
 (0)