Mercurial > libervia-backend
annotate doc/libervia-cli/blog.rst @ 3951:4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
fix 380
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 15 Oct 2022 20:38:33 +0200 |
| parents | 8b76caa89aa0 |
| children | 9f85369294f3 |
| rev | line source |
|---|---|
| 2946 | 1 .. highlight:: sh |
| 2 | |
| 3 ================================ | |
| 4 blog: (micro)blogging management | |
| 5 ================================ | |
| 6 | |
| 7 Blog commands are high level tools to handle an XMPP blog. | |
| 8 They are using the generic pubsub arguments | |
| 9 | |
| 10 set | |
| 11 === | |
| 12 | |
| 13 publish a blog item. | |
| 14 | |
| 15 :ref:`pubsub_common` commands are used to specify the destination item. | |
| 16 | |
| 17 ``stdin`` is used to get the body of the blog post. | |
| 18 | |
|
3951
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3873
diff
changeset
|
19 |e2e_arg| |
|
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3873
diff
changeset
|
20 |
| 2946 | 21 examples |
| 22 -------- | |
| 23 | |
| 24 Create a blog post with a body, a subject, 2 tags, and with comments allowed:: | |
| 25 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
26 $ echo "This is post body" | li blog set -T "This is a test message" -t test -t li -C |
| 2946 | 27 |
| 28 Create a blog post with rich content using `markdown` syntax, and no subject:: | |
| 29 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
30 $ echo "This is a **rich** body" | li blog set -S markdown |
| 2946 | 31 |
| 32 get | |
| 33 === | |
| 34 | |
|
2954
5e72efd2f95d
doc: minor fixes + use ".pot" extension instead of ".po" for template in README4TRANSLATORS
Goffi <goffi@goffi.org>
parents:
2946
diff
changeset
|
35 get command retrieves one or more blog post(s) from specified location (by default the |
| 2946 | 36 personal blog of the profile). |
| 37 | |
|
3021
8ec35cf13f66
doc: added, overview, configuration and Primitivus documentation + some small modifications
Goffi <goffi@goffi.org>
parents:
2999
diff
changeset
|
38 output can be customised to only retrieve some keys, or to use a specific template. For |
|
8ec35cf13f66
doc: added, overview, configuration and Primitivus documentation + some small modifications
Goffi <goffi@goffi.org>
parents:
2999
diff
changeset
|
39 instance, the following command retrieves only the title and publication date of the |
|
8ec35cf13f66
doc: added, overview, configuration and Primitivus documentation + some small modifications
Goffi <goffi@goffi.org>
parents:
2999
diff
changeset
|
40 personal blog of the profile:: |
|
8ec35cf13f66
doc: added, overview, configuration and Primitivus documentation + some small modifications
Goffi <goffi@goffi.org>
parents:
2999
diff
changeset
|
41 |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
42 $ li blog get -k title -k published |
| 2946 | 43 |
| 44 :ref:`pubsub_common` commands are used to specify the blog location. | |
| 45 | |
| 46 examples | |
| 47 -------- | |
| 48 | |
| 49 Retrieve personal blog of the profile using `fancy` output with a verbosity of 1 (to show | |
| 50 publication date):: | |
| 51 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
52 $ li blog get -O fancy -v |
| 2946 | 53 |
| 54 Retrieve *title* and *publication date* of last 3 blog posts from the blog at | |
| 55 https://www.goffi.org:: | |
| 56 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
57 $ li blog get -m 3 -u https://www.goffi.org -k title -k published |
| 2946 | 58 |
| 59 Retrieve last 2 posts of personal blog, and output them in browser using default | |
| 60 template:: | |
| 61 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
62 $ li blog get -m 2 -O template --oo browser |
| 2946 | 63 |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
64 .. _libervia-cli_blog_edit: |
|
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
3021
diff
changeset
|
65 |
| 2946 | 66 edit |
| 67 ==== | |
| 68 | |
| 69 With edit command you can create a new blog post or modify an existing one using your | |
| 70 local editor (the one set in ``$EDITOR``). You'll edit 2 things: the body of the post, and | |
| 71 the metadata which contain things like title, comments infos, or tags. | |
| 72 | |
| 73 For some common editors (like **vim** or **Emacs**), the editor will be automatially | |
| 74 opened using a split screen with *body* in one side, and metadata on the other. If the | |
| 75 editor is not supported or doesn't support split screen, you'll edit first the *body*, then | |
|
3536
0985c47ffd96
doc: config file is now `libervia.conf` (even if `sat.conf` still works, for now)
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
76 the *metadata*. You can also specify editor and arguments in ``libervia.conf``, see |
| 2946 | 77 `configuration <edit_conf_>`_ below |
| 78 | |
| 79 If you don't change anything or publish an empty blog post, the edition will be cancelled. | |
| 80 | |
|
3177
f4914ce9d47d
jp (blog/edit): added `--no-publish` argument.
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
81 In the metadata (see `below <edit_metadata_>`_ for details), you can use ``"publish": |
|
f4914ce9d47d
jp (blog/edit): added `--no-publish` argument.
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
82 false`` to forbid the publication (or set it with ``--no-publish argument``). In this |
|
f4914ce9d47d
jp (blog/edit): added `--no-publish` argument.
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
83 case, when you'll save your modification and quit your editor, the blog post will not be |
|
f4914ce9d47d
jp (blog/edit): added `--no-publish` argument.
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
84 published but saved locally in a draft. To continue your work later, just start your |
|
f4914ce9d47d
jp (blog/edit): added `--no-publish` argument.
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
85 edition with the ``-D, --current`` option like this:: |
| 2946 | 86 |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
87 $ li blog edit -D |
| 2946 | 88 |
| 89 Note that item location must be re-specified if it has been used to create the draft, so | |
| 90 you'll have to reproduce the arguments to specify service, node or item (or the URL), | |
| 91 other data like tags will be restored from draft file of metadata. | |
| 92 | |
| 93 You can specify the syntax by using ``-S SYNTAX, --syntax SYNTAX``. If not specified, the | |
| 94 syntax set in your parameters will be used. | |
| 95 | |
| 96 When you edit a blog post, it is often useful to activate the ``-P, --preview`` option, | |
| 97 this will launch a web browser and refresh the page each time you save a modification in | |
| 98 your editor. By default, the browser registered as default in your system will be used, | |
| 99 and a new tab will be opened on each modification. This is not ideal, and we recommand to | |
| 100 set you configuration to activate automatic refreshing of the page instead, see `preview | |
| 101 configuration <edit_preview_>`_ below to see how to do. | |
| 102 | |
|
2999
85d8e9a7284b
doc (jp/blog): added note for --preview
Goffi <goffi@goffi.org>
parents:
2996
diff
changeset
|
103 .. note:: |
|
85d8e9a7284b
doc (jp/blog): added note for --preview
Goffi <goffi@goffi.org>
parents:
2996
diff
changeset
|
104 |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
105 If --preview doesn't work, use ``li blog preview`` (see below) to get error messages. |
|
2999
85d8e9a7284b
doc (jp/blog): added note for --preview
Goffi <goffi@goffi.org>
parents:
2996
diff
changeset
|
106 On GNU/Linux, Be sure that inotify Python module is installed correctly. |
|
85d8e9a7284b
doc (jp/blog): added note for --preview
Goffi <goffi@goffi.org>
parents:
2996
diff
changeset
|
107 |
|
3951
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3873
diff
changeset
|
108 |e2e_arg| |
|
4b8776eb6826
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling:
Goffi <goffi@goffi.org>
parents:
3873
diff
changeset
|
109 |
| 2946 | 110 examples |
| 111 -------- | |
| 112 | |
| 113 Edit a new blog post with comments on your personal blog, using default syntax and preview:: | |
| 114 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
115 $ li blog edit -P --comments |
| 2946 | 116 |
| 117 Modifiy a draft previously saved using the ``"publish": false`` metadata:: | |
| 118 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
119 $ li blog edit -D |
| 2946 | 120 |
| 121 Correct a typo in your last published blog post:: | |
| 122 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
123 $ li blog edit --last-item |
| 2946 | 124 |
| 125 Edit the blog item at an HTTPS URL using XHTML syntax:: | |
| 126 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
127 $ li blog edit -u https://www.example.net/some_xmpp_blog_article.html -S xhtml |
| 2946 | 128 |
| 129 Create a new blog post on a XMPP blog node using its HTTPS URL (supposing here that | |
| 130 https://example.net is a XMPP blog node):: | |
| 131 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
132 $ li blog edit -u https://www.example.net |
| 2946 | 133 |
| 134 .. _edit_metadata: | |
| 135 | |
| 136 metadata | |
| 137 -------- | |
| 138 | |
| 139 Metadata is set using a JSON object. The key you can use are: | |
| 140 | |
| 141 publish | |
| 142 boolean indicating if item can be published. Set to ``false`` if you want to work on a | |
| 143 draft and to avoid accidental publication. | |
| 144 | |
| 145 atom_id | |
| 146 atom entry identifier. This should not be modified manually. | |
| 147 | |
| 148 published | |
| 149 time of initial publication (unix time). This should not be modified manually. | |
| 150 | |
| 151 language | |
| 152 language of the content | |
| 153 | |
| 154 comments | |
| 155 array of URIs to the comments node, if any. | |
| 156 | |
| 157 tag | |
| 158 array of tags, if any | |
| 159 | |
| 160 author | |
| 161 human readable name of the entry author | |
| 162 | |
| 163 author_jid | |
| 164 jid of the author. This should notbe modified manually. | |
| 165 | |
| 166 author_jid_verified | |
| 167 true if the pubsub service confirmed that author_jid is the one of the publisher. It is | |
| 168 useless to modify this variable. | |
| 169 | |
| 170 title | |
| 171 the title of the message | |
| 172 | |
| 173 title_rich | |
| 174 the rich title of the message, in current text syntax. It will be automatically | |
| 175 converted to xhtml. | |
| 176 | |
| 177 .. _edit_conf: | |
| 178 | |
| 179 configuration | |
| 180 ------------- | |
| 181 | |
| 182 editor | |
| 183 ^^^^^^ | |
| 184 | |
| 185 Local editor used is by default the one set in ``$EDITOR`` environment variable, but you | |
|
3536
0985c47ffd96
doc: config file is now `libervia.conf` (even if `sat.conf` still works, for now)
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
186 can specify one in ``libervia.conf``. To do so, you have to set the name of an editor |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
187 executable in the ``editor`` option in ``[li]`` section. |
| 2946 | 188 |
| 189 You can specify the args to use by using ``blog_editor_args`` option. Use | |
| 190 ``{content_file}`` to get the path of the main content file (the body of the blog post), | |
| 191 and ``{metadata_file}`` to get the path of the json metadata. | |
| 192 | |
| 193 .. sourcecode:: cfg | |
| 194 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
195 [li] |
| 2946 | 196 editor = kate |
| 197 blog_editor_args = {content_file} {metadata_file} | |
| 198 | |
| 199 .. _edit_preview: | |
| 200 | |
| 201 preview | |
| 202 ^^^^^^^ | |
| 203 | |
| 204 To set the preview, you can use the options ``blog_preview_open_cmd`` and | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
205 ``blog_preview_update_cmd`` in your ``[li]`` section. the former is the command to use to |
| 2946 | 206 open your browser when edition starts, and the later is the command to use when a |
| 207 modification is saved. In both cases you may use ``{url}`` to set the location of local HTML file. | |
| 208 | |
|
2954
5e72efd2f95d
doc: minor fixes + use ".pot" extension instead of ".po" for template in README4TRANSLATORS
Goffi <goffi@goffi.org>
parents:
2946
diff
changeset
|
209 This can be used to activate automatic refreshing of the page. |
| 2946 | 210 |
| 211 For **Konqueror**, you can use its D-Bus API to do refreshing. Ensure that ``qdbus`` is | |
|
3536
0985c47ffd96
doc: config file is now `libervia.conf` (even if `sat.conf` still works, for now)
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
212 installed on your system, and enter the following lines in your ``libervia.conf``: |
| 2946 | 213 |
| 214 .. sourcecode:: cfg | |
| 215 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
216 [li] |
| 2946 | 217 blog_preview_open_cmd = konqueror {url} |
| 218 blog_preview_update_cmd = /bin/sh -c "qdbus $(qdbus org.kde.konqueror\*) /konqueror/MainWindow_1 reload" | |
| 219 | |
| 220 For **Firefox**, you may use ``xdotool`` on X11. Once you have installed this tool, enter the | |
|
3536
0985c47ffd96
doc: config file is now `libervia.conf` (even if `sat.conf` still works, for now)
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
221 following lines in your ``libervia.conf``: |
| 2946 | 222 |
| 223 .. sourcecode:: cfg | |
| 224 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
225 [li] |
| 2946 | 226 blog_preview_open_cmd = firefox -new-tab {url} |
| 227 blog_preview_update_cmd = /bin/sh -c "WID=$(xdotool search --name 'Mozilla Firefox' | head -1); xdotool windowactivate $WID; xdotool key F5" | |
| 228 | |
| 229 This *xdotool* technique can be adapted to other browsers. | |
| 230 | |
| 231 syntax extensions | |
| 232 ^^^^^^^^^^^^^^^^^^ | |
| 233 | |
| 234 A dictionary with a mapping from syntax name to file extension can be used. This can be | |
| 235 useful to activate the right syntax highlighting in your editor. There is a default | |
| 236 mapping which can be overriden. | |
| 237 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
238 The mapping is set in the ``syntax_ext_dict`` option of the ``[li]`` section of your |
|
3536
0985c47ffd96
doc: config file is now `libervia.conf` (even if `sat.conf` still works, for now)
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
239 ``libervia.conf`` file. For instance, if your prefer do your ``.markdown`` for temp files |
| 2946 | 240 instead of the default ``.md``, you can use this: |
| 241 | |
| 242 .. sourcecode:: cfg | |
| 243 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
244 [li] |
| 2946 | 245 syntax_ext_dict = {"markdown": "markdown"} |
| 246 | |
|
2954
5e72efd2f95d
doc: minor fixes + use ".pot" extension instead of ".po" for template in README4TRANSLATORS
Goffi <goffi@goffi.org>
parents:
2946
diff
changeset
|
247 the first ``markdown`` is the name of the syntax (could be an other syntax like ``xhtml``), |
| 2946 | 248 while the second if the file extension. |
| 249 | |
|
3563
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
250 rename |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
251 ====== |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
252 |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
253 Move a item to a new ID. This works the same as :ref:`li-pubsub_rename`, the only |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
254 difference is that node defaults to microblog default namespace. |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
255 |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
256 example |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
257 ------- |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
258 |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
259 After a typo, a use want to rename the blog item with ID ``my_great_tittle_123a`` to |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
260 ``my_great_title_123a``:: |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
261 |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
262 $ li blog rename -i my_great_tittle_123a my_great_title_123a |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
263 |
|
3872
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
264 repeat |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
265 ====== |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
266 |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
267 Re-publish a blog item on profile's blog. |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
268 |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
269 This is similar to may be called in other networks "share" or "boot", the goal is mainly |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
270 to send this post of interest to our subscribers to make it more visible. |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
271 |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
272 It only needs arguments to get item to repeat location. |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
273 |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
274 example |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
275 ------- |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
276 |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
277 Pierre wants to repeat a blog post from Louise to make it more visible:: |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
278 |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
279 $ li blog repeat -s louise@example.org -n urn:xmpp:microblog:0 -i culture-new-caledonia-456f |
|
76fb0739cc9c
doc (cli/blog): `repeat` documentation:
Goffi <goffi@goffi.org>
parents:
3563
diff
changeset
|
280 |
| 2946 | 281 preview |
| 282 ======= | |
| 283 | |
| 284 This command will show the specified file in browser, and refresh it when changes are | |
|
2954
5e72efd2f95d
doc: minor fixes + use ".pot" extension instead of ".po" for template in README4TRANSLATORS
Goffi <goffi@goffi.org>
parents:
2946
diff
changeset
|
285 detected. Configuration is the same as for `edit preview <edit_preview_>`_. This can be |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
286 used if you have already started an edition with ``li blog edit`` but forgot to use the ``-P, --preview`` arguments. |
| 2946 | 287 |
|
3563
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
288 example |
|
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
289 ------- |
| 2946 | 290 |
|
3563
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
291 Preview the draft at ``~/.local/share/libervia/blog/some_name/blog_something.md``:: |
| 2946 | 292 |
|
3563
267e4987b58b
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
Goffi <goffi@goffi.org>
parents:
3536
diff
changeset
|
293 $ li blog preview ~/.local/share/libervia/blog/some_name/blog_something.md |
| 2946 | 294 |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
295 .. _libervia-cli_blog_import: |
|
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
3021
diff
changeset
|
296 |
| 2946 | 297 import |
| 298 ====== | |
| 299 | |
| 300 With this command you can import an external blog in a XMPP blog at the specified pubsub | |
| 301 location. | |
| 302 | |
| 303 The import is done using an *importer* name and a *location* which depends of the importer | |
| 2996 | 304 (it can be a path to a file, an URL to a blog, or something else). Let empty to get list |
| 305 of importers, and specify only importer name to get its description. | |
| 2946 | 306 |
| 307 By default, found images are re-uploaded to XMPP server, if you want to keep original | |
| 308 URLs, use the ``--no-images-upload`` option. | |
| 309 | |
| 310 Alternatively, you can re-upload images except for a specific host with ``--upload-ignore-host UPLOAD_IGNORE_HOST``. The images for the specified host will keep there original URLs while other will be uploaded to XMPP server. | |
| 311 | |
| 312 You shoud specify original blog host using ``--host HOST`` argument, this is used notably | |
| 313 to reconstruct relative URLs of media. | |
| 314 | |
| 315 Importers may have specific options, you can set them using the ``-o NAME VALUE, --option NAME VALUE`` argument. Check the importer description for details. | |
| 316 | |
| 317 examples: | |
| 318 --------- | |
| 319 | |
| 320 List available importers:: | |
| 321 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
322 $ li blog import |
| 2946 | 323 |
| 324 Get description of ``dotclear`` importer:: | |
| 325 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
326 $ li blog import dotclear |
| 2946 | 327 |
| 328 Import a Dotclear blog:: | |
| 329 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
330 $ li blog import dotclear /path/to/dotclear.dump |
| 2946 | 331 |
| 332 Import a Dotclear blog without uploading images:: | |
| 333 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3177
diff
changeset
|
334 $ li blog import --no-images-upload dotclear /path/to/dotclear.dump |
|
3873
8b76caa89aa0
doc (cli/pubsub, cli/blog): `attachments` subcommands documentation:
Goffi <goffi@goffi.org>
parents:
3872
diff
changeset
|
335 |
|
8b76caa89aa0
doc (cli/pubsub, cli/blog): `attachments` subcommands documentation:
Goffi <goffi@goffi.org>
parents:
3872
diff
changeset
|
336 attachments |
|
8b76caa89aa0
doc (cli/pubsub, cli/blog): `attachments` subcommands documentation:
Goffi <goffi@goffi.org>
parents:
3872
diff
changeset
|
337 =========== |
|
8b76caa89aa0
doc (cli/pubsub, cli/blog): `attachments` subcommands documentation:
Goffi <goffi@goffi.org>
parents:
3872
diff
changeset
|
338 |
|
8b76caa89aa0
doc (cli/pubsub, cli/blog): `attachments` subcommands documentation:
Goffi <goffi@goffi.org>
parents:
3872
diff
changeset
|
339 Subcommands to add or remove data attached to pubsub items. Please check |
|
8b76caa89aa0
doc (cli/pubsub, cli/blog): `attachments` subcommands documentation:
Goffi <goffi@goffi.org>
parents:
3872
diff
changeset
|
340 :ref:`libervia-cli_blog_attachments`. |