diff options
author | Sébastien Helleu <flashcode@flashtux.org> | 2015-05-17 07:48:21 +0200 |
---|---|---|
committer | Sébastien Helleu <flashcode@flashtux.org> | 2015-05-17 07:48:21 +0200 |
commit | 1fb3e8b2dcb2e5f59912fe0351f62193b843b388 (patch) | |
tree | 1574fe7486d6144749e8d89f92a0444495f4ff10 /doc | |
parent | fd3b3d6711369fe36bae5d1a4b52c29c51993914 (diff) | |
download | weechat-1fb3e8b2dcb2e5f59912fe0351f62193b843b388.zip |
doc: sort directories and files, reformat emacs lisp example in developer's guide
Diffstat (limited to 'doc')
-rw-r--r-- | doc/en/weechat_dev.en.asciidoc | 43 | ||||
-rw-r--r-- | doc/fr/weechat_dev.fr.asciidoc | 37 | ||||
-rw-r--r-- | doc/ja/weechat_dev.ja.asciidoc | 37 |
3 files changed, 60 insertions, 57 deletions
diff --git a/doc/en/weechat_dev.en.asciidoc b/doc/en/weechat_dev.en.asciidoc index f24c9423c..2dcaec778 100644 --- a/doc/en/weechat_dev.en.asciidoc +++ b/doc/en/weechat_dev.en.asciidoc @@ -70,17 +70,17 @@ The main WeeChat directories are: | charset/ | Charset plugin | exec/ | Exec plugin | fifo/ | Fifo plugin (FIFO pipe used to remotely send commands to WeeChat) +| guile/ | Guile (scheme) scripting API | irc/ | IRC (Internet Relay Chat) plugin +| javascript/ | Javascript scripting API | logger/ | Logger plugin (write messages displayed to files) -| relay/ | Relay plugin (irc proxy + relay for remote interfaces) -| script/ | Scripts manager -| python/ | Python scripting API +| lua/ | Lua scripting API | perl/ | Perl scripting API +| python/ | Python scripting API +| relay/ | Relay plugin (irc proxy + relay for remote interfaces) | ruby/ | Ruby scripting API -| lua/ | Lua scripting API +| script/ | Scripts manager | tcl/ | Tcl scripting API -| guile/ | Guile (scheme) scripting API -| javascript/ | Javascript scripting API | trigger/ | Trigger plugin | xfer/ | Xfer plugin (IRC DCC file/chat) | tests/ | Tests @@ -106,7 +106,6 @@ WeeChat "core" is located in following directories: |=== | Path/file | Description | core/ | Core functions: entry point, internal structures -| weechat.c | Main functions: command line options, startup | wee-arraylist.c | Array lists | wee-backtrace.c | Display a backtrace after a crash | wee-command.c | WeeChat core commands @@ -132,6 +131,7 @@ WeeChat "core" is located in following directories: | wee-utf8.c | UTF-8 functions | wee-util.c | Some other functions | wee-version.c | Functions for WeeChat version +| weechat.c | Main functions: command line options, startup | gui/ | Functions for buffers, windows, ... (used by all interfaces) | gui-bar-item.c | Bar items | gui-bar-window.c | Bar windows @@ -339,16 +339,16 @@ Documentation files: | asciidoc.css | Asciidoc style | docgen.py | Python script to build files in 'autogen/' directory (see below) | XX/ | Documentation for language XX (languages: en, fr, de, it, ...) +| cmdline_options.XX.asciidoc | Command-line options (file included in man page and user's guide) | weechat.1.XX.asciidoc | Man page (`man weechat`) -| weechat_quickstart.XX.asciidoc | Quickstart guide -| weechat_user.XX.asciidoc | User's guide +| weechat_dev.XX.asciidoc | Developer's guide (this document) | weechat_faq.XX.asciidoc | FAQ | weechat_plugin_api.XX.asciidoc | Plugin API reference +| weechat_quickstart.XX.asciidoc | Quickstart guide +| weechat_relay_protocol.XX.asciidoc | Relay protocol (for remote interfaces) | weechat_scripting.XX.asciidoc | Scripting guide | weechat_tester.XX.asciidoc | Tester's guide -| weechat_dev.XX.asciidoc | Developer's guide (this document) -| weechat_relay_protocol.XX.asciidoc | Relay protocol (for remote interfaces) -| cmdline_options.XX.asciidoc | Command-line options (file included in man page and user's guide) +| weechat_user.XX.asciidoc | User's guide | autogen/ | Files auto-built with script docgen.py | user/ | Files auto-built for user's guide (do *NEVER* update manually!) | plugin_api/ | Files auto-built for plugin API (do *NEVER* update manually!) @@ -590,12 +590,13 @@ new_hook_fd = malloc (sizeof (*new_hook_fd)); [source,lisp] ---- -(add-hook 'c-mode-common-hook '(lambda () - (c-toggle-hungry-state t) - (c-set-style "k&r") - (setq c-basic-offset 4 - c-tab-always-indent t) - (c-set-offset 'case-label '+))) +(add-hook 'c-mode-common-hook + '(lambda () + (c-toggle-hungry-state t) + (c-set-style "k&r") + (setq c-basic-offset 4) + (c-tab-always-indent t) + (c-set-offset 'case-label '+))) ---- [[coding_python_style]] @@ -964,9 +965,9 @@ server->hook_timer_sasl = weechat_hook_timer (timeout * 1000, Git repository is at this URL: https://github.com/weechat/weechat -Any patch for bug or new feature must be done on master branch, preferred way is -a GitHub pull request. A patch can also be sent by e-mail (made with `git diff` -or `git format-patch`). +Any patch for bug or new feature must be done on master branch, preferred way +is a GitHub pull request. A patch can also be sent by e-mail +(made with `git diff` or `git format-patch`). Format of commit message is the following (to close a GitHub issue): diff --git a/doc/fr/weechat_dev.fr.asciidoc b/doc/fr/weechat_dev.fr.asciidoc index 880860da2..b61e714f9 100644 --- a/doc/fr/weechat_dev.fr.asciidoc +++ b/doc/fr/weechat_dev.fr.asciidoc @@ -71,17 +71,17 @@ Les répertoires principaux de WeeChat sont : | charset/ | Extension Charset | exec/ | Extension Exec | fifo/ | Extension Fifo (tube FIFO utilisé pour envoyer des commandes à WeeChat) +| guile/ | API script Guile (scheme) | irc/ | Extension IRC (Internet Relay Chat) +| javascript/ | API script Javascript | logger/ | Extension Logger (enregistrer les messages affichés dans des fichiers) -| relay/ | Extension Relay (proxy IRC + relai pour interfaces distantes) -| script/ | Gestionnaire de scripts -| python/ | API script Python +| lua/ | API script Lua | perl/ | API script Perl +| python/ | API script Python +| relay/ | Extension Relay (proxy IRC + relai pour interfaces distantes) | ruby/ | API script Ruby -| lua/ | API script Lua +| script/ | Gestionnaire de scripts | tcl/ | API script Tcl -| guile/ | API script Guile (scheme) -| javascript/ | API script Javascript | trigger/ | Extension Trigger | xfer/ | Extension Xfer (IRC DCC fichier/discussion) | tests/ | Tests @@ -107,7 +107,6 @@ Le cœur de WeeChat est situé dans les répertoires suivants : |=== | Chemin/fichier | Description | core/ | Fonctions du cœur : point d'entrée, structures internes -| weechat.c | Fonctions principales : options de ligne de commande, démarrage | wee-arraylist.c | Listes avec tableau (« arraylists ») | wee-backtrace.c | Afficher une trace après un plantage | wee-command.c | Commandes du cœur de WeeChat @@ -133,6 +132,7 @@ Le cœur de WeeChat est situé dans les répertoires suivants : | wee-utf8.c | Fonctions UTF-8 | wee-util.c | Quelques autres fonctions utilitaires | wee-version.c | Fonctions pour la version de WeeChat +| weechat.c | Fonctions principales : options de ligne de commande, démarrage | gui/ | Fonctions pour les tampons, fenêtres, ... (utilisées par toutes les interfaces) | gui-bar-item.c | Objets de barre | gui-bar-window.c | Fenêtres de barre @@ -340,16 +340,16 @@ Fichiers de documentation : | asciidoc.css | Style Asciidoc | docgen.py | Script Python pour construire les fichiers dans le répertoire 'autogen/' (voir ci-dessous) | XX/ | Documentation pour la langue XX (langues : en, fr, de, it, ...) +| cmdline_options.XX.asciidoc | Options de ligne de commande (fichier inclus dans la page de manuel et le guide utilisateur) | weechat.1.XX.asciidoc | Page de manuel (`man weechat`) -| weechat_quickstart.XX.asciidoc | Guide de démarrage -| weechat_user.XX.asciidoc | Guide utilisateur +| weechat_dev.XX.asciidoc | Guide du développeur (ce document) | weechat_faq.XX.asciidoc | FAQ (questions fréquemment posées) | weechat_plugin_api.XX.asciidoc | Référence API extension +| weechat_quickstart.XX.asciidoc | Guide de démarrage +| weechat_relay_protocol.XX.asciidoc | Protocole Relay (pour les interfaces distantes) | weechat_scripting.XX.asciidoc | Guide pour scripts | weechat_tester.XX.asciidoc | Guide du testeur -| weechat_dev.XX.asciidoc | Guide du développeur (ce document) -| weechat_relay_protocol.XX.asciidoc | Protocole Relay (pour les interfaces distantes) -| cmdline_options.XX.asciidoc | Options de ligne de commande (fichier inclus dans la page de manuel et le guide utilisateur) +| weechat_user.XX.asciidoc | Guide utilisateur | autogen/ | Fichiers automatiquement générés avec le script docgen.py | user/ | Fichiers automatiquement générés pour le guide utilisateur (ne *JAMAIS* les mettre à jour manuellement !) | plugin_api/ | Fichiers automatiquement générés pour l'API extension (ne *JAMAIS* les mettre à jour manuellement !) @@ -600,12 +600,13 @@ new_hook_fd = malloc (sizeof (*new_hook_fd)); [source,lisp] ---- -(add-hook 'c-mode-common-hook '(lambda () - (c-toggle-hungry-state t) - (c-set-style "k&r") - (setq c-basic-offset 4 - c-tab-always-indent t) - (c-set-offset 'case-label '+))) +(add-hook 'c-mode-common-hook + '(lambda () + (c-toggle-hungry-state t) + (c-set-style "k&r") + (setq c-basic-offset 4) + (c-tab-always-indent t) + (c-set-offset 'case-label '+))) ---- [[coding_python_style]] diff --git a/doc/ja/weechat_dev.ja.asciidoc b/doc/ja/weechat_dev.ja.asciidoc index 7102b72d7..5818b64fc 100644 --- a/doc/ja/weechat_dev.ja.asciidoc +++ b/doc/ja/weechat_dev.ja.asciidoc @@ -80,17 +80,17 @@ This manual documents only 'weechat' repository. | charset/ | charset プラグイン | exec/ | exec プラグイン | fifo/ | fifo プラグイン (WeeChat にコマンドを送信する FIFO パイプ) +| guile/ | guile (scheme) スクリプト用 API | irc/ | IRC (Internet Relay Chat) プラグイン +| javascript/ | javascript スクリプト用 API | logger/ | logger プラグイン (表示されたメッセージをファイルに書き込む) -| relay/ | relay プラグイン (irc プロキシ + リモートインターフェイス用の中継) -| script/ | スクリプトマネージャ -| python/ | python スクリプト用 API +| lua/ | lua スクリプト用 API | perl/ | perl スクリプト用 API +| python/ | python スクリプト用 API +| relay/ | relay プラグイン (irc プロキシ + リモートインターフェイス用の中継) | ruby/ | ruby スクリプト用 API -| lua/ | lua スクリプト用 API +| script/ | スクリプトマネージャ | tcl/ | tcl スクリプト用 API -| guile/ | guile (scheme) スクリプト用 API -| javascript/ | javascript スクリプト用 API | trigger/ | trigger プラグイン | xfer/ | xfer (IRC DCC ファイル/チャット) | tests/ | テスト @@ -116,7 +116,6 @@ WeeChat "core" は以下のディレクトリに配置されています: |=== | パス/ファイル名 | 説明 | core/ | コア関数: エントリポイント、内部構造体 -| weechat.c | 主要関数: コマンドラインオプション、起動 | wee-arraylist.c | 配列リスト | wee-backtrace.c | クラッシュした際にバックトレースを表示 | wee-command.c | WeeChat コアコマンド @@ -142,6 +141,7 @@ WeeChat "core" は以下のディレクトリに配置されています: | wee-utf8.c | UTF-8 関数 | wee-util.c | その他の関数 | wee-version.c | WeeChat バージョンについての関数 +| weechat.c | 主要関数: コマンドラインオプション、起動 | gui/ | バッファ、ウィンドウなどの関数 (全てのインターフェイスで利用) | gui-bar-item.c | バー要素 | gui-bar-window.c | バーウィンドウ @@ -349,16 +349,16 @@ WeeChat "core" は以下のディレクトリに配置されています: | asciidoc.css | asciidoc スタイル | docgen.py | 'autogen/' ディレクトリ内のファイルを作成する Python スクリプト (以下を参照) | XX/ | 言語コード XX (言語コード: en、fr、de、it、...) 用のディレクトリ +| cmdline_options.XX.asciidoc | コマンドラインオプション (man ページとユーザガイドに含まれるファイル) | weechat.1.XX.asciidoc | man ページ (`man weechat`) -| weechat_quickstart.XX.asciidoc | クイックスタートガイド -| weechat_user.XX.asciidoc | ユーザーガイド +| weechat_dev.XX.asciidoc | 開発者リファレンス (この文書) | weechat_faq.XX.asciidoc | FAQ | weechat_plugin_api.XX.asciidoc | プラグイン API リファレンス +| weechat_quickstart.XX.asciidoc | クイックスタートガイド +| weechat_relay_protocol.XX.asciidoc | リレープロトコル (リモートインターフェイス用) | weechat_scripting.XX.asciidoc | スクリプト作成ガイド | weechat_tester.XX.asciidoc | テスターガイド -| weechat_dev.XX.asciidoc | 開発者リファレンス (この文書) -| weechat_relay_protocol.XX.asciidoc | リレープロトコル (リモートインターフェイス用) -| cmdline_options.XX.asciidoc | コマンドラインオプション (man ページとユーザガイドに含まれるファイル) +| weechat_user.XX.asciidoc | ユーザーガイド | autogen/ | docgen.py スクリプトが自動生成するファイル | user/ | ユーザーガイド用の自動生成ファイル (手作業による編集は*禁止* !) | plugin_api/ | プラグイン API 用の自動生成ファイル (手作業による編集は*禁止* !) @@ -596,12 +596,13 @@ new_hook_fd = malloc (sizeof (*new_hook_fd)); [source,lisp] ---- -(add-hook 'c-mode-common-hook '(lambda () - (c-toggle-hungry-state t) - (c-set-style "k&r") - (setq c-basic-offset 4 - c-tab-always-indent t) - (c-set-offset 'case-label '+))) +(add-hook 'c-mode-common-hook + '(lambda () + (c-toggle-hungry-state t) + (c-set-style "k&r") + (setq c-basic-offset 4) + (c-tab-always-indent t) + (c-set-offset 'case-label '+))) ---- [[coding_python_style]] |