Mercurial > libervia-backend

comparison doc/libervia-cli/blog.rst @ 4174:6929dabf3a7e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (cli/blog): documentation of the new `--no-id-suffix` option.
author Goffi <goffi@goffi.org>
date Tue, 05 Dec 2023 13:13:03 +0100
parents 524856bd7b19
children 0f1a4ffcd419
comparison
equal deleted inserted replaced
4173:7df6ba11bdae 4174:6929dabf3a7e
5 ================================ 5 ================================
6 6
7 Blog commands are high level tools to handle an XMPP blog. 7 Blog commands are high level tools to handle an XMPP blog.
8 They are using the generic pubsub arguments 8 They are using the generic pubsub arguments
9 9
10
11 .. _libervia_cli_blog_common_pub:
12
13 Common Publishing Options
14 =========================
15
16 The `set` and `edit` commands support a range of options for customizing blog post creation and editing. Some notable options include:
17
18 ``--no-id-suffix``
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.
21
22 .. warning::
23
24 Use this option judiciously to avoid unintended overwriting of blog posts.
25
10 set 26 set
11 === 27 ===
12 28
13 publish a blog item. 29 publish a blog item.
14 30
15 :ref:`pubsub_common` commands are used to specify the destination item. 31 :ref:`pubsub_common` commands are used to specify the destination item.
16 32
17 ``stdin`` is used to get the body of the blog post. 33 ``stdin`` is used to get the body of the blog post.
34
35 Also see :ref:`libervia_cli_blog_common_pub`.
18 36
19 |e2e_arg| 37 |e2e_arg|
20 38
21 |pte_arg| 39 |pte_arg|
22 40
107 .. note:: 125 .. note::
108 126
109 If --preview doesn't work, use ``li blog preview`` (see below) to get error messages. 127 If --preview doesn't work, use ``li blog preview`` (see below) to get error messages.
110 On GNU/Linux, Be sure that inotify Python module is installed correctly. 128 On GNU/Linux, Be sure that inotify Python module is installed correctly.
111 129
130 Also see :ref:`libervia_cli_blog_common_pub`.
131
112 |e2e_arg| 132 |e2e_arg|
113 133
114 |pte_arg| 134 |pte_arg|
115 135
116 |sign_arg| 136 |sign_arg|