Mercurial > libervia-backend

comparison doc/libervia-cli/blog.rst @ 4178:cf0ea77f9537

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
plugin XEP-0277, doc: conflict is now checked and avoided if `user_friendly_id_suffix` is `False`, doc updated
author Goffi <goffi@goffi.org>
date Tue, 05 Dec 2023 13:39:03 +0100
parents 0f1a4ffcd419
children
comparison
equal deleted inserted replaced
4177:0f1a4ffcd419 4178:cf0ea77f9537
15 15
16 The `set` and `edit` commands support a range of options for customizing blog post creation and editing. Some notable options include: 16 The `set` and `edit` commands support a range of options for customizing blog post creation and editing. Some notable options include:
17 17
18 ``--no-id-suffix`` 18 ``--no-id-suffix``
19 19
20 This option removes the randomly generated suffix from the auto-generated, user-friendly ID. The suffix is initially added to ensure unique IDs, especially useful when two posts have similar titles. Use this option with caution, as it may lead to ID conflicts and potential overwriting of existing posts. 20 This option removes the randomly generated suffix from the auto-generated,
21 21 user-friendly ID. The suffix is initially added to ensure unique IDs, especially useful
22 .. warning:: 22 when two posts have similar titles.
23 23
24 Use this option judiciously to avoid unintended overwriting of blog posts. 24 .. note::
25
26 When the ``--no-id-suffix`` option is selected, an extra validation is performed to
27 check for ID uniqueness. If an existing item already uses the same ID, a suffix is
28 added to the new ID regardless of the option, ensuring no existing content is
29 overwritten. This additional check incurs a slight performance impact due to the
30 extra request needed.
25 31
26 ``--alt-link URL [MEDIA_TYPE]`` 32 ``--alt-link URL [MEDIA_TYPE]``
27 33
28 Add an alternative link to a blog post, such as a corresponding HTTP page. The *URL* 34 Add an alternative link to a blog post, such as a corresponding HTTP page. The *URL*
29 parameter is mandatory, while *MEDIA_TYPE* is optional. Incorporate ``{service}``, 35 parameter is mandatory, while *MEDIA_TYPE* is optional. Incorporate ``{service}``,