diff --git a/CHANGELOG.md b/CHANGELOG.md index f300d106b..507898e0c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ - core: allow buffer id in commands `/buffer` and `/print`, in addition to number and name - relay: enable websocket extension "permessage-deflate" with "api" relay only ([#1549](https://github.com/weechat/weechat/issues/1549)) - api: allow NULL value for key in hashtable +- doc: rename doc "weechat_relay_protocol" to "weechat_relay_weechat" ### Added diff --git a/debian-devel/weechat-devel-doc.doc-base.relay-protocol-en b/debian-devel/weechat-devel-doc.doc-base.relay-protocol-en deleted file mode 100644 index 9eda8bafb..000000000 --- a/debian-devel/weechat-devel-doc.doc-base.relay-protocol-en +++ /dev/null @@ -1,10 +0,0 @@ -Document: weechat-relay-protocol-en -Title: WeeChat Relay protocol (English) -Author: Sébastien Helleu -Abstract: This manual describes WeeChat Relay Protocol, used by - remote GUI to communicate with Relay plugin (English version). -Section: Network/Communication - -Format: HTML -Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_protocol.en.html -Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_protocol.en.html diff --git a/debian-devel/weechat-devel-doc.doc-base.relay-protocol-fr b/debian-devel/weechat-devel-doc.doc-base.relay-protocol-fr deleted file mode 100644 index 8d10f3c21..000000000 --- a/debian-devel/weechat-devel-doc.doc-base.relay-protocol-fr +++ /dev/null @@ -1,10 +0,0 @@ -Document: weechat-relay-protocol-fr -Title: WeeChat Relay protocol (French) -Author: Sébastien Helleu -Abstract: This manual describes WeeChat Relay Protocol, used by - remote GUI to communicate with Relay plugin (French version). -Section: Network/Communication - -Format: HTML -Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_protocol.fr.html -Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_protocol.fr.html diff --git a/debian-devel/weechat-devel-doc.doc-base.relay-protocol-ja b/debian-devel/weechat-devel-doc.doc-base.relay-protocol-ja deleted file mode 100644 index da7db974f..000000000 --- a/debian-devel/weechat-devel-doc.doc-base.relay-protocol-ja +++ /dev/null @@ -1,10 +0,0 @@ -Document: weechat-relay-protocol-ja -Title: WeeChat Relay protocol (Japanese) -Author: Sébastien Helleu -Abstract: This manual describes WeeChat Relay Protocol, used by - remote GUI to communicate with Relay plugin (Japanese version). -Section: Network/Communication - -Format: HTML -Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_protocol.ja.html -Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_protocol.ja.html diff --git a/debian-devel/weechat-devel-doc.doc-base.relay-weechat-en b/debian-devel/weechat-devel-doc.doc-base.relay-weechat-en new file mode 100644 index 000000000..706ab92da --- /dev/null +++ b/debian-devel/weechat-devel-doc.doc-base.relay-weechat-en @@ -0,0 +1,10 @@ +Document: weechat-relay-weechat-en +Title: WeeChat Relay "weechat" protocol (English) +Author: Sébastien Helleu +Abstract: This manual describes WeeChat Relay "weechat" protocol, used by + remote GUI to communicate with Relay plugin (English version). +Section: Network/Communication + +Format: HTML +Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_weechat.en.html +Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_weechat.en.html diff --git a/debian-devel/weechat-devel-doc.doc-base.relay-weechat-fr b/debian-devel/weechat-devel-doc.doc-base.relay-weechat-fr new file mode 100644 index 000000000..5046a1490 --- /dev/null +++ b/debian-devel/weechat-devel-doc.doc-base.relay-weechat-fr @@ -0,0 +1,10 @@ +Document: weechat-relay-weechat-fr +Title: WeeChat Relay "weechat" protocol (French) +Author: Sébastien Helleu +Abstract: This manual describes WeeChat Relay "weechat" protocol, used by + remote GUI to communicate with Relay plugin (French version). +Section: Network/Communication + +Format: HTML +Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_weechat.fr.html +Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_weechat.fr.html diff --git a/debian-devel/weechat-devel-doc.doc-base.relay-weechat-ja b/debian-devel/weechat-devel-doc.doc-base.relay-weechat-ja new file mode 100644 index 000000000..b91e476fe --- /dev/null +++ b/debian-devel/weechat-devel-doc.doc-base.relay-weechat-ja @@ -0,0 +1,10 @@ +Document: weechat-relay-weechat-ja +Title: WeeChat Relay "weechat" protocol (Japanese) +Author: Sébastien Helleu +Abstract: This manual describes WeeChat Relay "weechat" protocol, used by + remote GUI to communicate with Relay plugin (Japanese version). +Section: Network/Communication + +Format: HTML +Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_weechat.ja.html +Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_weechat.ja.html diff --git a/debian-stable/weechat-doc.doc-base.relay-protocol-en b/debian-stable/weechat-doc.doc-base.relay-protocol-en deleted file mode 100644 index a54d06c94..000000000 --- a/debian-stable/weechat-doc.doc-base.relay-protocol-en +++ /dev/null @@ -1,10 +0,0 @@ -Document: weechat-relay-protocol-en -Title: WeeChat Relay protocol (English) -Author: Sébastien Helleu -Abstract: This manual describes WeeChat Relay Protocol, used by - remote GUI to communicate with Relay plugin (English version). -Section: Network/Communication - -Format: HTML -Index: /usr/share/doc/weechat-doc/html/weechat_relay_protocol.en.html -Files: /usr/share/doc/weechat-doc/html/weechat_relay_protocol.en.html diff --git a/debian-stable/weechat-doc.doc-base.relay-protocol-fr b/debian-stable/weechat-doc.doc-base.relay-protocol-fr deleted file mode 100644 index cb8fb4b1b..000000000 --- a/debian-stable/weechat-doc.doc-base.relay-protocol-fr +++ /dev/null @@ -1,10 +0,0 @@ -Document: weechat-relay-protocol-fr -Title: WeeChat Relay protocol (French) -Author: Sébastien Helleu -Abstract: This manual describes WeeChat Relay Protocol, used by - remote GUI to communicate with Relay plugin (French version). -Section: Network/Communication - -Format: HTML -Index: /usr/share/doc/weechat-doc/html/weechat_relay_protocol.fr.html -Files: /usr/share/doc/weechat-doc/html/weechat_relay_protocol.fr.html diff --git a/debian-stable/weechat-doc.doc-base.relay-protocol-ja b/debian-stable/weechat-doc.doc-base.relay-protocol-ja deleted file mode 100644 index ed93abcf4..000000000 --- a/debian-stable/weechat-doc.doc-base.relay-protocol-ja +++ /dev/null @@ -1,10 +0,0 @@ -Document: weechat-relay-protocol-ja -Title: WeeChat Relay protocol (Japanese) -Author: Sébastien Helleu -Abstract: This manual describes WeeChat Relay Protocol, used by - remote GUI to communicate with Relay plugin (Japanese version). -Section: Network/Communication - -Format: HTML -Index: /usr/share/doc/weechat-doc/html/weechat_relay_protocol.ja.html -Files: /usr/share/doc/weechat-doc/html/weechat_relay_protocol.ja.html diff --git a/debian-stable/weechat-doc.doc-base.relay-weechat-en b/debian-stable/weechat-doc.doc-base.relay-weechat-en new file mode 100644 index 000000000..f3526ad46 --- /dev/null +++ b/debian-stable/weechat-doc.doc-base.relay-weechat-en @@ -0,0 +1,10 @@ +Document: weechat-relay-weechat-en +Title: WeeChat Relay "weechat" protocol (English) +Author: Sébastien Helleu +Abstract: This manual describes WeeChat Relay "weechat" protocol, used by + remote GUI to communicate with Relay plugin (English version). +Section: Network/Communication + +Format: HTML +Index: /usr/share/doc/weechat-doc/html/weechat_relay_weechat.en.html +Files: /usr/share/doc/weechat-doc/html/weechat_relay_weechat.en.html diff --git a/debian-stable/weechat-doc.doc-base.relay-weechat-fr b/debian-stable/weechat-doc.doc-base.relay-weechat-fr new file mode 100644 index 000000000..313675598 --- /dev/null +++ b/debian-stable/weechat-doc.doc-base.relay-weechat-fr @@ -0,0 +1,10 @@ +Document: weechat-relay-weechat-fr +Title: WeeChat Relay "weechat" protocol (French) +Author: Sébastien Helleu +Abstract: This manual describes WeeChat Relay "weechat" protocol, used by + remote GUI to communicate with Relay plugin (French version). +Section: Network/Communication + +Format: HTML +Index: /usr/share/doc/weechat-doc/html/weechat_relay_weechat.fr.html +Files: /usr/share/doc/weechat-doc/html/weechat_relay_weechat.fr.html diff --git a/debian-stable/weechat-doc.doc-base.relay-weechat-ja b/debian-stable/weechat-doc.doc-base.relay-weechat-ja new file mode 100644 index 000000000..238a77fd9 --- /dev/null +++ b/debian-stable/weechat-doc.doc-base.relay-weechat-ja @@ -0,0 +1,10 @@ +Document: weechat-relay-weechat-ja +Title: WeeChat Relay "weechat" protocol (Japanese) +Author: Sébastien Helleu +Abstract: This manual describes WeeChat Relay "weechat" protocol, used by + remote GUI to communicate with Relay plugin (Japanese version). +Section: Network/Communication + +Format: HTML +Index: /usr/share/doc/weechat-doc/html/weechat_relay_weechat.ja.html +Files: /usr/share/doc/weechat-doc/html/weechat_relay_weechat.ja.html diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 92980afff..18a460e32 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -28,7 +28,7 @@ if(ENABLE_MAN OR ENABLE_DOC) set(SCRIPTING_LANG de en fr it ja pl sr) set(FAQ_LANG de en es fr it ja pl sr) set(QUICKSTART_LANG cs de en es fr it ja pl ru sr) - set(RELAY_LANG en fr ja sr) + set(RELAY_WEECHAT_LANG en fr ja sr) set(DEV_LANG en fr ja sr) find_package(Asciidoctor) @@ -93,8 +93,8 @@ if(ENABLE_MAN OR ENABLE_DOC) -a docinfo1 ) - # asciidoctor arguments for relay protocol - set(ASCIIDOCTOR_RELAY_ARGS + # asciidoctor arguments for relay "weechat" + set(ASCIIDOCTOR_RELAY_WEECHAT_ARGS -a toc=left -a toclevels=3 -a sectnums @@ -275,19 +275,19 @@ if(ENABLE_MAN OR ENABLE_DOC) add_custom_target(doc-quickstart-${lang} ALL DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.${lang}.html") install(FILES "${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.${lang}.html" DESTINATION "${DATAROOTDIR}/doc/${PROJECT_NAME}") endforeach() - # relay protocol - foreach(lang ${RELAY_LANG}) + # relay "weechat" + foreach(lang ${RELAY_WEECHAT_LANG}) add_custom_command( - OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_protocol.${lang}.html" - COMMAND "${ASCIIDOCTOR_EXECUTABLE}" ARGS ${ASCIIDOCTOR_ARGS} ${ASCIIDOCTOR_RELAY_ARGS} -o "weechat_relay_protocol.${lang}.html" "${CMAKE_CURRENT_SOURCE_DIR}/${lang}/weechat_relay_protocol.${lang}.adoc" + OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_weechat.${lang}.html" + COMMAND "${ASCIIDOCTOR_EXECUTABLE}" ARGS ${ASCIIDOCTOR_ARGS} ${ASCIIDOCTOR_RELAY_WEECHAT_ARGS} -o "weechat_relay_weechat.${lang}.html" "${CMAKE_CURRENT_SOURCE_DIR}/${lang}/weechat_relay_weechat.${lang}.adoc" DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/docinfo.html" - "${CMAKE_CURRENT_SOURCE_DIR}/${lang}/weechat_relay_protocol.${lang}.adoc" + "${CMAKE_CURRENT_SOURCE_DIR}/${lang}/weechat_relay_weechat.${lang}.adoc" WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}" - COMMENT "Building weechat_relay_protocol.${lang}.html" + COMMENT "Building weechat_relay_weechat.${lang}.html" ) - add_custom_target(doc-relay-protocol-${lang} ALL DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_protocol.${lang}.html") - install(FILES "${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_protocol.${lang}.html" DESTINATION "${DATAROOTDIR}/doc/${PROJECT_NAME}") + add_custom_target(doc-relay-weechat-${lang} ALL DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_weechat.${lang}.html") + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_weechat.${lang}.html" DESTINATION "${DATAROOTDIR}/doc/${PROJECT_NAME}") endforeach() # developer's guide foreach(lang ${DEV_LANG}) diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc index cb1829d5d..413e2cfd7 100644 --- a/doc/en/weechat_dev.en.adoc +++ b/doc/en/weechat_dev.en.adoc @@ -532,7 +532,7 @@ Documentation files: |       weechat_faq.XX.adoc | link:weechat_faq.en.html[FAQ ^↗^^]. |       weechat_plugin_api.XX.adoc | link:weechat_plugin_api.en.html[Plugin API reference ^↗^^]. |       weechat_quickstart.XX.adoc | link:weechat_quickstart.en.html[Quickstart guide ^↗^^]. -|       weechat_relay_protocol.XX.adoc | link:weechat_relay_protocol.en.html[Relay protocol ^↗^^] (for remote interfaces). +|       weechat_relay_weechat.XX.adoc | link:weechat_relay_weechat.en.html[Relay "weechat" protocol ^↗^^] (for remote interfaces). |       weechat_scripting.XX.adoc | link:weechat_scripting.en.html[Scripting guide ^↗^^]. |       weechat_user.XX.adoc | link:weechat_user.en.html[User's guide ^↗^^]. |       includes/ | Files included in documentation. @@ -1253,8 +1253,8 @@ Where _component_ is one of following: | Plugin API reference | doc/relay -| doc/xx/weechat_relay_protocol.xx.adoc -| Relay protocol +| doc/xx/weechat_relay_weechat.xx.adoc +| Relay "weechat" protocol | doc/dev | doc/xx/weechat_dev.en.adoc diff --git a/doc/en/weechat_relay_protocol.en.adoc b/doc/en/weechat_relay_weechat.en.adoc similarity index 100% rename from doc/en/weechat_relay_protocol.en.adoc rename to doc/en/weechat_relay_weechat.en.adoc diff --git a/doc/fr/weechat_dev.fr.adoc b/doc/fr/weechat_dev.fr.adoc index 1f8e9c54a..618ac2c9f 100644 --- a/doc/fr/weechat_dev.fr.adoc +++ b/doc/fr/weechat_dev.fr.adoc @@ -534,7 +534,7 @@ Fichiers de documentation : |       weechat_faq.XX.adoc | link:weechat_faq.fr.html[FAQ ^↗^^] (questions fréquemment posées). |       weechat_plugin_api.XX.adoc | link:weechat_plugin_api.fr.html[Référence API extension ^↗^^]. |       weechat_quickstart.XX.adoc | link:weechat_quickstart.fr.html[Guide de démarrage ^↗^^]. -|       weechat_relay_protocol.XX.adoc | link:weechat_relay_protocol.fr.html[Protocole Relay ^↗^^] (pour les interfaces distantes). +|       weechat_relay_weechat.XX.adoc | link:weechat_relay_weechat.fr.html[Protocole relay "weechat" ^↗^^] (pour les interfaces distantes). |       weechat_scripting.XX.adoc | link:weechat_scripting.fr.html[Guide pour scripts ^↗^^]. |       weechat_user.XX.adoc | link:weechat_user.fr.html[Guide utilisateur ^↗^^]. |       includes/ | Fichiers inclus dans la documentation. @@ -1273,8 +1273,8 @@ Où _composant_ est : | Référence extension API | doc/relay -| doc/xx/weechat_relay_protocol.xx.adoc -| Protocole relay +| doc/xx/weechat_relay_weechat.xx.adoc +| Protocole relay "weechat" | doc/dev | doc/xx/weechat_dev.en.adoc diff --git a/doc/fr/weechat_relay_protocol.fr.adoc b/doc/fr/weechat_relay_weechat.fr.adoc similarity index 100% rename from doc/fr/weechat_relay_protocol.fr.adoc rename to doc/fr/weechat_relay_weechat.fr.adoc diff --git a/doc/ja/weechat_dev.ja.adoc b/doc/ja/weechat_dev.ja.adoc index fbb7b8444..44773edba 100644 --- a/doc/ja/weechat_dev.ja.adoc +++ b/doc/ja/weechat_dev.ja.adoc @@ -653,7 +653,8 @@ WeeChat "core" は以下のディレクトリに配置されています: |       weechat_faq.XX.adoc | link:weechat_faq.ja.html[FAQ ^↗^^] |       weechat_plugin_api.XX.adoc | link:weechat_plugin_api.ja.html[プラグイン API リファレンス ^↗^^] |       weechat_quickstart.XX.adoc | link:weechat_quickstart.ja.html[クイックスタートガイド ^↗^^] -|       weechat_relay_protocol.XX.adoc | link:weechat_relay_protocol.ja.html[リレープロトコル ^↗^^] (リモートインターフェース用) +// TRANSLATION MISSING +|       weechat_relay_weechat.XX.adoc | link:weechat_relay_weechat.ja.html[Relay "weechat" protocol ^↗^^] (for remote interfaces). |       weechat_scripting.XX.adoc | link:weechat_scripting.ja.html[スクリプト作成ガイド ^↗^^] |       weechat_user.XX.adoc | link:weechat_user.ja.html[ユーザーズガイド ^↗^^] // TRANSLATION MISSING @@ -1402,9 +1403,9 @@ _component_ には以下から 1 つ選んで記入してください: Plugin API reference | doc/relay -| doc/xx/weechat_relay_protocol.xx.adoc | +| doc/xx/weechat_relay_weechat.xx.adoc | // TRANSLATION MISSING - Relay protocol + Relay "weechat" protocol | doc/dev | doc/xx/weechat_dev.en.adoc | diff --git a/doc/ja/weechat_relay_protocol.ja.adoc b/doc/ja/weechat_relay_weechat.ja.adoc similarity index 100% rename from doc/ja/weechat_relay_protocol.ja.adoc rename to doc/ja/weechat_relay_weechat.ja.adoc diff --git a/doc/sr/weechat_dev.sr.adoc b/doc/sr/weechat_dev.sr.adoc index de8964852..b19b2d764 100644 --- a/doc/sr/weechat_dev.sr.adoc +++ b/doc/sr/weechat_dev.sr.adoc @@ -534,7 +534,8 @@ WeeChat „језгро” се налази у следећим директо |       weechat_faq.XX.adoc | link:weechat_faq.sr.html[ЧПП ^↗^^]. |       weechat_plugin_api.XX.adoc | link:weechat_plugin_api.sr.html[Референца за API додатака ^↗^^]. |       weechat_quickstart.XX.adoc | link:weechat_quickstart.sr.html[Водич за брзи почетак ^↗^^]. -|       weechat_relay_protocol.XX.adoc | link:weechat_relay_protocol.sr.html[Релеј протокол ^↗^^] (за удаљене интерфејсе). +// TRANSLATION MISSING +|       weechat_relay_weechat.XX.adoc | link:weechat_relay_weechat.sr.html[Relay "weechat" protocol ^↗^^] (for remote interfaces). |       weechat_scripting.XX.adoc | link:weechat_scripting.sr.html[Водич за скриптовање ^↗^^]. |       weechat_user.XX.adoc | link:weechat_user.sr.html[Корисничко упутство ^↗^^]. |       includes/ | Фајлови укључени у документацију. @@ -1223,8 +1224,9 @@ server->hook_timer_sasl = weechat_hook_timer (timeout * 1000, | Референтни приручник API додатака | doc/relay -| doc/xx/weechat_relay_protocol.xx.adoc -| Релеј протокол +| doc/xx/weechat_relay_weechat.xx.adoc +// TRANSLATION MISSING +| Relay "weechat" protocol | doc/dev | doc/xx/weechat_dev.en.adoc diff --git a/doc/sr/weechat_relay_protocol.sr.adoc b/doc/sr/weechat_relay_weechat.sr.adoc similarity index 100% rename from doc/sr/weechat_relay_protocol.sr.adoc rename to doc/sr/weechat_relay_weechat.sr.adoc