Skip to content

Commit e561e72

Browse files
committed
docs(admin): fix dav: heading auto-link in occ_database
Escape the colon in all dav: section headings (dav\:command-name) to prevent docutils from treating them as external URI references, and extend underlines to match the new raw character length. AI-Assisted-By: claude-sonnet-4-6 Signed-off-by: Anna Larch <anna@nextcloud.com>
1 parent 0462bb0 commit e561e72

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

admin_manual/occ_database.rst

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ absences, and related data::
3939
Manage addressbooks
4040
^^^^^^^^^^^^^^^^^^^
4141

42-
dav:list-addressbooks
43-
"""""""""""""""""""""
42+
dav\:list-addressbooks
43+
""""""""""""""""""""""
4444

4545
List all addressbooks for a user::
4646

@@ -51,8 +51,8 @@ List all addressbooks for a user::
5151
| contacts | Contacts | principals/users/layla | Layla Smith | ✓ |
5252
+-------------+----------+-----------------------------+-------------------+----------+
5353

54-
dav:create-addressbook
55-
""""""""""""""""""""""
54+
dav\:create-addressbook
55+
"""""""""""""""""""""""
5656

5757
Create an addressbook for a user::
5858

@@ -62,8 +62,8 @@ Create an addressbook for a user::
6262
Manage calendars
6363
^^^^^^^^^^^^^^^^
6464

65-
dav:list-calendars
66-
""""""""""""""""""
65+
dav\:list-calendars
66+
"""""""""""""""""""
6767

6868
List all calendars for a user::
6969

@@ -74,7 +74,7 @@ List all calendars for a user::
7474
| personal | Personal | principals/users/layla | Layla Smith | ✓ |
7575
+----------+-------------+-----------------------------+-------------------+----------+
7676

77-
dav:list-calendar-shares
77+
dav\:list-calendar-shares
7878
"""""""""""""""""""""""""
7979

8080
List all calendar shares for a user::
@@ -84,15 +84,15 @@ List all calendar shares for a user::
8484

8585
Use ``--calendar-id`` to filter results to a specific calendar.
8686

87-
dav:create-calendar
88-
"""""""""""""""""""
87+
dav\:create-calendar
88+
""""""""""""""""""""
8989

9090
Create a calendar for a user::
9191

9292
sudo -E -u www-data php occ dav:create-calendar layla holidays
9393

94-
dav:delete-calendar
95-
"""""""""""""""""""
94+
dav\:delete-calendar
95+
""""""""""""""""""""
9696

9797
Delete a named calendar for a user::
9898

@@ -105,8 +105,8 @@ to the trashbin::
105105
sudo -E -u www-data php occ dav:delete-calendar --force layla holidays
106106
sudo -E -u www-data php occ dav:delete-calendar --birthday layla
107107

108-
dav:move-calendar
109-
"""""""""""""""""
108+
dav\:move-calendar
109+
""""""""""""""""""
110110

111111
.. note::
112112

@@ -126,7 +126,7 @@ new name is tried automatically (``personal-1``, ``personal-2``, up to
126126
ten attempts). The command fails if no free name is found within those
127127
attempts.
128128

129-
dav:clear-calendar-unshares
129+
dav\:clear-calendar-unshares
130130
""""""""""""""""""""""""""""
131131

132132
Clear stale calendar unshare records for a user. Useful when a user's
@@ -139,15 +139,15 @@ calendar sharing state has become inconsistent::
139139
Manage calendar subscriptions
140140
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
141141

142-
dav:list-subscriptions
143-
""""""""""""""""""""""
142+
dav\:list-subscriptions
143+
"""""""""""""""""""""""
144144

145145
List all calendar subscriptions for a user::
146146

147147
sudo -E -u www-data php occ dav:list-subscriptions layla
148148
User layla has no subscriptions
149149

150-
dav:create-subscription
150+
dav\:create-subscription
151151
""""""""""""""""""""""""
152152

153153
Create a subscription calendar for a user::
@@ -162,7 +162,7 @@ Optionally pass a HEX color code for the calendar::
162162

163163
If not set, the theming default color is used.
164164

165-
dav:delete-subscription
165+
dav\:delete-subscription
166166
""""""""""""""""""""""""
167167

168168
Delete a calendar subscription for a user::
@@ -173,8 +173,8 @@ Delete a calendar subscription for a user::
173173
Manage absences (out-of-office)
174174
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
175175

176-
dav:absence:set
177-
"""""""""""""""
176+
dav\:absence:set
177+
""""""""""""""""
178178

179179
Set the out-of-office absence for a user. ``first-day`` and ``last-day``
180180
are inclusive and formatted as ``YYYY-MM-DD``.
@@ -200,8 +200,8 @@ To set an absence with a replacement user::
200200
"I am on leave. Please contact fred for urgent matters." \
201201
fred
202202

203-
dav:absence:get
204-
"""""""""""""""
203+
dav\:absence:get
204+
""""""""""""""""
205205

206206
Show the current absence settings for a user::
207207

@@ -217,7 +217,7 @@ Show the current absence settings for a user::
217217
Sync
218218
^^^^
219219

220-
dav:sync-system-addressbook
220+
dav\:sync-system-addressbook
221221
""""""""""""""""""""""""""""
222222

223223
.. _dav-sync-system-address-book:
@@ -227,7 +227,7 @@ Synchronize all users to the :ref:`system address book<system-address-book>`::
227227
sudo -E -u www-data php occ dav:sync-system-addressbook
228228
Syncing users ...
229229

230-
dav:sync-birthday-calendar
230+
dav\:sync-birthday-calendar
231231
"""""""""""""""""""""""""""
232232

233233
Add birthdays from shared addressbooks to a user's calendar::
@@ -239,7 +239,7 @@ Add birthdays from shared addressbooks to a user's calendar::
239239
Maintenance
240240
^^^^^^^^^^^
241241

242-
dav:fix-missing-caldav-changes
242+
dav\:fix-missing-caldav-changes
243243
"""""""""""""""""""""""""""""""
244244

245245
Restore missing calendar sync change records. If the ``calendarchanges``
@@ -250,22 +250,22 @@ instances)::
250250
sudo -E -u www-data php occ dav:fix-missing-caldav-changes layla
251251
sudo -E -u www-data php occ dav:fix-missing-caldav-changes
252252

253-
dav:remove-invalid-shares
253+
dav\:remove-invalid-shares
254254
""""""""""""""""""""""""""
255255

256256
Remove invalid DAV shares created by a bug in a previous version::
257257

258258
sudo -E -u www-data php occ dav:remove-invalid-shares
259259

260-
dav:retention:clean-up
260+
dav\:retention:clean-up
261261
"""""""""""""""""""""""
262262

263263
Delete elements from the CalDAV trash that are past their retention
264264
period::
265265

266266
sudo -E -u www-data php occ dav:retention:clean-up
267267

268-
dav:send-event-reminders
268+
dav\:send-event-reminders
269269
"""""""""""""""""""""""""
270270

271271
Send pending calendar event reminder notifications. By default,
@@ -281,7 +281,7 @@ reminders are sent on time::
281281

282282
See :doc:`../groupware/calendar` for the recommended cron schedule.
283283

284-
dav:clear-contacts-photo-cache
284+
dav\:clear-contacts-photo-cache
285285
"""""""""""""""""""""""""""""""
286286

287287
Clear all cached contact photos. Useful after a migration or if contact
@@ -429,7 +429,7 @@ against the expected schema::
429429
- checksum:
430430
- name: checksum
431431
- type: string
432-
...
432+
433433

434434
Limit output to a single table::
435435

0 commit comments

Comments
 (0)