pegasus/weechat
1
0
Fork 0
mirror of https://github.com/weechat/weechat.git synced 2026-06-12 14:14:48 +02:00
Code Activity

doc/relay: add doc on "api" relay

Browse Source
This commit is contained in:
Sébastien Helleu
2024-06-18 20:32:05 +02:00
parent 7d4e0acfef
commit eb83e8d018
12 changed files with 3431 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+1
View File
@@ -23,6 +23,7 @@
- core: add hdata count in evaluation of expressions with `hdata_count:name[list]` or `hdata_count:name[pointer]`
- core: add completion "bars_items"
- api: add hashtable type "longlong"
- doc: add doc on "api" relay
### Fixed
debian-devel/weechat-devel-doc.doc-base.relay-api-en
+10
View File
@@ -0,0 +1,10 @@
Document: weechat-relay-api-en
Title: WeeChat Relay "api" protocol (English)
Author: Sébastien Helleu
Abstract: This manual describes WeeChat Relay "api" protocol, used by
remote GUI or WeeChat to communicate with Relay plugin (English version).
Section: Network/Communication
Format: HTML
Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_api.en.html
Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_api.en.html
debian-devel/weechat-devel-doc.doc-base.relay-api-fr
+10
View File
@@ -0,0 +1,10 @@
Document: weechat-relay-api-fr
Title: WeeChat Relay "api" protocol (French)
Author: Sébastien Helleu
Abstract: This manual describes WeeChat Relay "api" protocol, used by
remote GUI or WeeChat to communicate with Relay plugin (French version).
Section: Network/Communication
Format: HTML
Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_api.fr.html
Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_api.fr.html
debian-stable/weechat-devel-doc.doc-base.relay-api-en
+10
View File
@@ -0,0 +1,10 @@
Document: weechat-relay-api-en
Title: WeeChat Relay "api" protocol (English)
Author: Sébastien Helleu
Abstract: This manual describes WeeChat Relay "api" protocol, used by
remote GUI or WeeChat to communicate with Relay plugin (English version).
Section: Network/Communication
Format: HTML
Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_api.en.html
Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_api.en.html
debian-stable/weechat-devel-doc.doc-base.relay-api-fr
+10
View File
@@ -0,0 +1,10 @@
Document: weechat-relay-api-fr
Title: WeeChat Relay "api" protocol (French)
Author: Sébastien Helleu
Abstract: This manual describes WeeChat Relay "api" protocol, used by
remote GUI or WeeChat to communicate with Relay plugin (French version).
Section: Network/Communication
Format: HTML
Index: /usr/share/doc/weechat-devel-doc/html/weechat_relay_api.fr.html
Files: /usr/share/doc/weechat-devel-doc/html/weechat_relay_api.fr.html
doc/CMakeLists.txt
+25
View File
@@ -28,6 +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_API_LANG en fr)
set(RELAY_WEECHAT_LANG en fr ja sr)
set(DEV_LANG en fr ja sr)
@@ -93,6 +94,15 @@ if(ENABLE_MAN OR ENABLE_DOC)
-a docinfo1
)
# asciidoctor arguments for relay "api"
set(ASCIIDOCTOR_RELAY_API_ARGS
-a toc=left
-a toclevels=3
-a sectnums
-a sectnumlevels=2
-a docinfo1
)
# asciidoctor arguments for relay "weechat"
set(ASCIIDOCTOR_RELAY_WEECHAT_ARGS
-a toc=left
@@ -275,6 +285,21 @@ 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 "api"
foreach(lang ${RELAY_API_LANG})
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_api.${lang}.html"
COMMAND "${ASCIIDOCTOR_EXECUTABLE}" ARGS ${ASCIIDOCTOR_ARGS} ${ASCIIDOCTOR_RELAY_API_ARGS} -o "weechat_relay_api.${lang}.html" "${CMAKE_CURRENT_SOURCE_DIR}/${lang}/weechat_relay_api.${lang}.adoc"
DEPENDS
"${CMAKE_CURRENT_SOURCE_DIR}/docinfo.html"
"${CMAKE_CURRENT_SOURCE_DIR}/${lang}/weechat_relay_api.${lang}.adoc"
"${CMAKE_CURRENT_SOURCE_DIR}/${lang}/includes/relay.${lang}.adoc"
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
COMMENT "Building weechat_relay_api.${lang}.html"
)
add_custom_target(doc-relay-api-${lang} ALL DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_api.${lang}.html")
install(FILES "${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_api.${lang}.html" DESTINATION "${DATAROOTDIR}/doc/${PROJECT_NAME}")
endforeach()
# relay "weechat"
foreach(lang ${RELAY_WEECHAT_LANG})
add_custom_command(
doc/en/weechat_dev.en.adoc
+4 -2
View File
@@ -532,6 +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_api.XX.adoc | link:weechat_relay_api.en.html[Relay "api" 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 ^↗^^].
@@ -1253,8 +1254,9 @@ Where _component_ is one of following:
| Plugin API reference
| doc/relay
| doc/xx/weechat_relay_weechat.xx.adoc
| Relay "weechat" protocol
| doc/xx/weechat_relay_api.xx.adoc +
doc/xx/weechat_relay_weechat.xx.adoc
| Relay protocols
| doc/dev
| doc/xx/weechat_dev.en.adoc
doc/en/weechat_relay_api.en.adoc
+1646
View File
File diff suppressed because it is too large Load Diff
doc/fr/weechat_dev.fr.adoc
+4 -2
View File
@@ -534,6 +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_api.XX.adoc | link:weechat_relay_api.fr.html[Protocole relay "api" ^↗^^] (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 ^↗^^].
@@ -1273,8 +1274,9 @@ Où _composant_ est :
| Référence extension API
| doc/relay
| doc/xx/weechat_relay_weechat.xx.adoc
| Protocole relay "weechat"
| doc/xx/weechat_relay_api.xx.adoc +
doc/xx/weechat_relay_weechat.xx.adoc
| Protocoles relay
| doc/dev
| doc/xx/weechat_dev.en.adoc
doc/fr/weechat_relay_api.fr.adoc
+1673
View File
File diff suppressed because it is too large Load Diff
doc/ja/weechat_dev.ja.adoc
+33 -30
View File
@@ -654,6 +654,8 @@ WeeChat "core" は以下のディレクトリに配置されています:
|       weechat_plugin_api.XX.adoc | link:weechat_plugin_api.ja.html[プラグイン API リファレンス ^↗^^]
|       weechat_quickstart.XX.adoc | link:weechat_quickstart.ja.html[クイックスタートガイド ^↗^^]
// TRANSLATION MISSING
|       weechat_relay_api.XX.adoc | Relay "api" protocol (for remote interfaces).
// 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[ユーザーズガイド ^↗^^]
@@ -1338,87 +1340,88 @@ _component_ には以下から 1 つ選んで記入してください:
src/core/* +
src/gui/* +
version.sh +
weechat.desktop |
weechat.desktop
// TRANSLATION MISSING
WeeChat core
| WeeChat core
| build
| CMakeLists.txt +
cmake/* +
tools/* +
weechat.cygport.in |
weechat.cygport.in
// TRANSLATION MISSING
Build
| Build
| ci
| .github/workflows/* |
| .github/workflows/*
// TRANSLATION MISSING
Continuous integration
| Continuous integration
| debian
| debian-devel/* +
debian-stable/* |
debian-stable/*
// TRANSLATION MISSING
Debian packaging
| Debian packaging
| tests
| tests/* |
| tests/*
// TRANSLATION MISSING
Tests
| Tests
| doc
| doc/* |
| doc/*
// TRANSLATION MISSING
General doc updates, for example build
| General doc updates, for example build
| doc/man
| doc/xx/weechat.1.xx.adoc +
doc/xx/weechat-headless.1.xx.adoc |
doc/xx/weechat-headless.1.xx.adoc
// TRANSLATION MISSING
Man pages
| Man pages
| doc/faq
| doc/xx/weechat_faq.xx.adoc |
| doc/xx/weechat_faq.xx.adoc
// TRANSLATION MISSING
Frequently asked questions (FAQ)
| Frequently asked questions (FAQ)
| doc/quickstart
| doc/xx/weechat_quickstart.xx.adoc |
| doc/xx/weechat_quickstart.xx.adoc
// TRANSLATION MISSING
Quickstart guide
| Quickstart guide
| doc/user
| doc/xx/weechat_user.xx.adoc |
| doc/xx/weechat_user.xx.adoc
// TRANSLATION MISSING
User's guide
| User's guide
| doc/scripting
| doc/xx/weechat_scripting.xx.adoc |
| doc/xx/weechat_scripting.xx.adoc
// TRANSLATION MISSING
Scripting guide
| Scripting guide
| doc/api
| doc/xx/weechat_plugin_api.xx.adoc |
| doc/xx/weechat_plugin_api.xx.adoc
// TRANSLATION MISSING
Plugin API reference
| Plugin API reference
| doc/relay
| doc/xx/weechat_relay_weechat.xx.adoc |
| doc/xx/weechat_relay_api.xx.adoc +
doc/xx/weechat_relay_weechat.xx.adoc
// TRANSLATION MISSING
Relay "weechat" protocol
| Relay protocols
| doc/dev
| doc/xx/weechat_dev.en.adoc |
| doc/xx/weechat_dev.en.adoc
// TRANSLATION MISSING
Developer's guide
| Developer's guide
| irc +
python +
relay +
…
| src/plugins/<name>/* |
| src/plugins/<name>/*
// TRANSLATION MISSING
Plugin
| Plugin
|===
doc/sr/weechat_dev.sr.adoc
+5 -2
View File
@@ -535,6 +535,8 @@ WeeChat „језгро” се налази у следећим директо
|       weechat_plugin_api.XX.adoc | link:weechat_plugin_api.sr.html[Референца за API додатака ^↗^^].
|       weechat_quickstart.XX.adoc | link:weechat_quickstart.sr.html[Водич за брзи почетак ^↗^^].
// TRANSLATION MISSING
|       weechat_relay_api.XX.adoc | Relay "api" protocol (for remote interfaces).
// 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[Корисничко упутство ^↗^^].
@@ -1224,9 +1226,10 @@ server->hook_timer_sasl = weechat_hook_timer (timeout * 1000,
| Референтни приручник API додатака
| doc/relay
| doc/xx/weechat_relay_weechat.xx.adoc
| doc/xx/weechat_relay_api.xx.adoc +
doc/xx/weechat_relay_weechat.xx.adoc
// TRANSLATION MISSING
| Relay "weechat" protocol
| Relay protocols
| doc/dev
| doc/xx/weechat_dev.en.adoc