doc: add French developer's guide
Sebastien Helleu
parent
6b0bd1302a
commit
74d236dfeb
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-dev-en
|
||||
Title: WeeChat Developer's Guide (English)
|
||||
Title: WeeChat developer's guide (English)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This manual describes WeeChat internals and
|
||||
how to contribute to WeeChat (English version).
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
Document: weechat-dev-fr
|
||||
Title: WeeChat developer's guide (French)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This manual describes WeeChat internals and
|
||||
how to contribute to WeeChat (French version).
|
||||
Section: Network/Communication
|
||||
|
||||
Format: HTML
|
||||
Index: /usr/share/doc/weechat-doc/html/weechat_dev.fr.html
|
||||
Files: /usr/share/doc/weechat-doc/html/weechat_dev.fr.html
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-dev-ja
|
||||
Title: WeeChat Developer's Guide (Japanese)
|
||||
Title: WeeChat developer's guide (Japanese)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This manual describes WeeChat internals and
|
||||
how to contribute to WeeChat (Japanese version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-plugin-en
|
||||
Title: WeeChat plugins API (English)
|
||||
Title: WeeChat plugin API reference (English)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create plugins
|
||||
for WeeChat (English version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-plugin-fr
|
||||
Title: WeeChat plugins API (French)
|
||||
Title: WeeChat plugin API reference (French)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create plugins
|
||||
for WeeChat (French version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-plugin-it
|
||||
Title: WeeChat plugins API (Italian)
|
||||
Title: WeeChat plugin API reference (Italian)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create plugins
|
||||
for WeeChat (Italian version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-plugin-ja
|
||||
Title: WeeChat plugins API (Japanese)
|
||||
Title: WeeChat plugin API reference (Japanese)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create plugins
|
||||
for WeeChat (Japanese version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-quickstart-de
|
||||
Title: WeeChat Quickstart (German)
|
||||
Title: WeeChat quick start guide (German)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: A short HowTo for new WeeChat users (German version).
|
||||
Section: Network/Communication
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-quickstart-en
|
||||
Title: WeeChat Quickstart (English)
|
||||
Title: WeeChat quick start guide (English)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: A short HowTo for new WeeChat users (English version).
|
||||
Section: Network/Communication
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-quickstart-es
|
||||
Title: WeeChat Quickstart (Spanish)
|
||||
Title: WeeChat quick start guide (Spanish)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: A short HowTo for new WeeChat users (Spanish version).
|
||||
Section: Network/Communication
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-quickstart-fr
|
||||
Title: WeeChat Quickstart (French)
|
||||
Title: WeeChat quick start guide (French)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: A short HowTo for new WeeChat users (French version).
|
||||
Section: Network/Communication
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-quickstart-it
|
||||
Title: WeeChat Quickstart (Italian)
|
||||
Title: WeeChat quick start guide (Italian)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: A short HowTo for new WeeChat users (Italian version).
|
||||
Section: Network/Communication
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-quickstart-ja
|
||||
Title: WeeChat Quickstart (Japanese)
|
||||
Title: WeeChat quick start guide (Japanese)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: A short HowTo for new WeeChat users (Japanese version).
|
||||
Section: Network/Communication
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-quickstart-pl
|
||||
Title: WeeChat Quickstart (Polish)
|
||||
Title: WeeChat quick start guide (Polish)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: A short HowTo for new WeeChat users (Polish version).
|
||||
Section: Network/Communication
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-quickstart-ru
|
||||
Title: WeeChat Quickstart (Russian)
|
||||
Title: WeeChat quick start guide (Russian)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: A short HowTo for new WeeChat users (Russian version).
|
||||
Section: Network/Communication
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-relay-protocol-en
|
||||
Title: WeeChat Relay Protocol (English)
|
||||
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).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-scripting-de
|
||||
Title: WeeChat Scripting Guide (German)
|
||||
Title: WeeChat scripting guide (German)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create scripts
|
||||
for WeeChat (German version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-scripting-en
|
||||
Title: WeeChat Scripting Guide (English)
|
||||
Title: WeeChat scripting guide (English)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create scripts
|
||||
for WeeChat (English version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-scripting-fr
|
||||
Title: WeeChat Scripting Guide (French)
|
||||
Title: WeeChat scripting guide (French)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create scripts
|
||||
for WeeChat (French version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-scripting-it
|
||||
Title: WeeChat Scripting Guide (Italian)
|
||||
Title: WeeChat scripting guide (Italian)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create scripts
|
||||
for WeeChat (Italian version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-scripting-ja
|
||||
Title: WeeChat Scripting Guide (Japanese)
|
||||
Title: WeeChat scripting guide (Japanese)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create scripts
|
||||
for WeeChat (Japanese version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-scripting-pl
|
||||
Title: WeeChat Scripting Guide (Polish)
|
||||
Title: WeeChat scripting guide (Polish)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes the API to create scripts
|
||||
for WeeChat (Polish version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-tester-de
|
||||
Title: WeeChat Tester's Guide (German)
|
||||
Title: WeeChat tester's guide (German)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes how to test and report
|
||||
bugs against the WeeChat IRC Client (German version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-tester-en
|
||||
Title: WeeChat Tester's Guide (English)
|
||||
Title: WeeChat tester's guide (English)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes how to test and report
|
||||
bugs against the WeeChat IRC Client (English version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-tester-fr
|
||||
Title: WeeChat Tester's Guide (French)
|
||||
Title: WeeChat tester's guide (French)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes how to test and report
|
||||
bugs against the WeeChat IRC Client (French version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-tester-it
|
||||
Title: WeeChat Tester's Guide (Italian)
|
||||
Title: WeeChat tester's guide (Italian)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes how to test and report
|
||||
bugs against the WeeChat IRC Client (Italian version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-tester-ja
|
||||
Title: WeeChat Tester's Guide (Japanese)
|
||||
Title: WeeChat tester's guide (Japanese)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes how to test and report
|
||||
bugs against the WeeChat IRC Client (Japanese version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-tester-pl
|
||||
Title: WeeChat Tester's Guide (Polish)
|
||||
Title: WeeChat tester's guide (Polish)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This document describes how to test and report
|
||||
bugs against the WeeChat IRC Client (Polish version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-user-de
|
||||
Title: WeeChat User's Guide (German)
|
||||
Title: WeeChat user's guide (German)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This manual describes how to use the WeeChat
|
||||
IRC client (German version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-user-en
|
||||
Title: WeeChat User's Guide (English)
|
||||
Title: WeeChat user's guide (English)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This manual describes how to use the WeeChat
|
||||
IRC client (English version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-user-fr
|
||||
Title: WeeChat User's Guide (French)
|
||||
Title: WeeChat user's guide (French)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This manual describes how to use the WeeChat
|
||||
IRC client (French version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-user-it
|
||||
Title: WeeChat User's Guide (Italian)
|
||||
Title: WeeChat user's guide (Italian)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This manual describes how to use the WeeChat
|
||||
IRC client (Italian version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-user-ja
|
||||
Title: WeeChat User's Guide (Japanese)
|
||||
Title: WeeChat user's guide (Japanese)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This manual describes how to use the WeeChat
|
||||
IRC client (Japanese version).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Document: weechat-user-pl
|
||||
Title: WeeChat User's Guide (Polish)
|
||||
Title: WeeChat user's guide (Polish)
|
||||
Author: Sébastien Helleu
|
||||
Abstract: This manual describes how to use the WeeChat
|
||||
IRC client (Polish version).
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= WeeChat Developer's Guide
|
||||
= WeeChat developer's guide
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: en
|
||||
|
|
@ -34,7 +34,7 @@ WeeChat has two main repositories:
|
|||
* core repository: it contains source code and documentation,
|
||||
URL is: http://git.savannah.gnu.org/gitweb/?p=weechat.git
|
||||
* scripts: the 'official' scripts submitted on weechat.org,
|
||||
URL is: http://git.savannah.gnu.org/gitweb/?p=weechat/scripts.git;a=summary
|
||||
URL is: http://git.savannah.gnu.org/gitweb/?p=weechat/scripts.git
|
||||
|
||||
This manual documents only core repository.
|
||||
|
||||
|
|
@ -46,7 +46,6 @@ The main WeeChat directories are:
|
|||
[width="100%",cols="1v,5",options="header"]
|
||||
|===
|
||||
| Directory | Description
|
||||
| debian/ | Debian packaging
|
||||
| src/ | Root of sources
|
||||
| core/ | Core functions: entry point, internal structures
|
||||
| gui/ | Functions for buffers, windows, ... (used by all interfaces)
|
||||
|
|
@ -56,7 +55,7 @@ The main WeeChat directories are:
|
|||
| aspell/ | Aspell plugin
|
||||
| charset/ | Charset plugin
|
||||
| fifo/ | Fifo plugin (FIFO pipe used to remotely send commands to WeeChat)
|
||||
| irc/ | IRC plugin
|
||||
| irc/ | IRC (Internet Relay Chat) plugin
|
||||
| logger/ | Logger plugin (write messages displayed to files)
|
||||
| relay/ | Relay plugin (irc proxy + relay for remote interfaces)
|
||||
| rmodifier/ | Rmodifier plugin (alter modifier strings with regular expressions)
|
||||
|
|
@ -67,10 +66,11 @@ The main WeeChat directories are:
|
|||
| lua/ | Lua scripting API
|
||||
| tcl/ | Tcl scripting API
|
||||
| guile/ | Guile (scheme) scripting API
|
||||
| xfer/ | Xfer (IRC DCC file/chat)
|
||||
| xfer/ | Xfer plugin (IRC DCC file/chat)
|
||||
| doc/ | Documentation
|
||||
| po/ | Translations files (gettext)
|
||||
| test/ | Weercd: WeeChat flood irc server, written in Python
|
||||
| test/ | Tools/files to test WeeChat (like Weercd, an IRC server)
|
||||
| debian/ | Debian packaging
|
||||
|===
|
||||
|
||||
[[sources]]
|
||||
|
|
@ -79,7 +79,7 @@ The main WeeChat directories are:
|
|||
[[sources_core]]
|
||||
==== Core
|
||||
|
||||
WeeChat "core" reside in following directories:
|
||||
WeeChat "core" is located in following directories:
|
||||
|
||||
* 'src/core/': core functions (for data manipulation)
|
||||
* 'src/gui/': functions about interface (buffers, windows, ...)
|
||||
|
|
@ -89,21 +89,21 @@ WeeChat "core" reside in following directories:
|
|||
| Path/file | Description
|
||||
| core/ | Core functions: entry point, internal structures
|
||||
| weechat.c | Entry point, command line options, main functions, startup
|
||||
| wee-backtrace.c | Display backtrace after a segfault
|
||||
| wee-backtrace.c | Display a backtrace after a crash
|
||||
| wee-command.c | WeeChat core commands
|
||||
| wee-completion.c | Completion on command line
|
||||
| wee-completion.c | Default completions
|
||||
| wee-config-file.c | Configuration file management
|
||||
| wee-config.c | Configuration options for WeeChat core (file weechat.conf)
|
||||
| wee-debug.c | Some debug functions
|
||||
| wee-eval.c | Evaluate expressions with references to internal vars
|
||||
| wee-eval.c | Evaluation of expressions with references to internal vars
|
||||
| wee-hashtable.c | Hashtables
|
||||
| wee-hdata.c | Hdata (direct access to data using hashtables)
|
||||
| wee-hook.c | Hooks
|
||||
| wee-infolist.c | Infolists (lists built with data about objects)
|
||||
| wee-infolist.c | Infolists (lists with objects data)
|
||||
| wee-input.c | Input of commands/text
|
||||
| wee-list.c | Sorted lists
|
||||
| wee-log.c | Write to WeeChat log file (weechat.log)
|
||||
| wee-network.c | Network functions (connection to servers, proxy)
|
||||
| wee-network.c | Network functions (connection to servers/proxies)
|
||||
| wee-proxy.c | Proxy management
|
||||
| wee-secure.c | Secured data options (file sec.conf)
|
||||
| wee-string.c | Functions on strings
|
||||
|
|
@ -120,11 +120,11 @@ WeeChat "core" reside in following directories:
|
|||
| gui-buffer.c | Buffers
|
||||
| gui-chat.c | Chat functions (display message, ...)
|
||||
| gui-color.c | Color functions
|
||||
| gui-completion.c | Default completions
|
||||
| gui-completion.c | Completion on command line
|
||||
| gui-cursor.c | Cursor mode (free movement of cursor)
|
||||
| gui-filter.c | Filters
|
||||
| gui-focus.c | Functions about focus (for cursor mode and mouse)
|
||||
| gui-history.c | commands/text saved in buffers
|
||||
| gui-history.c | Commands/text saved in buffers
|
||||
| gui-hotlist.c | Hotlist management (list of buffers with activity)
|
||||
| gui-input.c | Input functions (input bar)
|
||||
| gui-key.c | Keyboard functions
|
||||
|
|
@ -183,7 +183,7 @@ WeeChat "core" reside in following directories:
|
|||
| irc-bar-item.c | IRC bar items
|
||||
| irc-buffer.c | IRC buffers
|
||||
| irc-channel.c | IRC channels
|
||||
| irc-color.c | Color functions
|
||||
| irc-color.c | IRC colors
|
||||
| irc-command.c | IRC commands
|
||||
| irc-completion.c | IRC completions
|
||||
| irc-config.c | IRC config options (file irc.conf)
|
||||
|
|
@ -201,14 +201,14 @@ WeeChat "core" reside in following directories:
|
|||
| irc-raw.c | IRC raw buffer
|
||||
| irc-redirect.c | Redirection of IRC command output
|
||||
| irc-sasl.c | SASL authentication with IRC server
|
||||
| irc-server.c | I/O communication with IRC servers
|
||||
| irc-upgrade.c | Save/restore IRC data when upgrading WeeChat
|
||||
| irc-server.c | I/O communication with IRC server
|
||||
| irc-upgrade.c | Save/restore of IRC data when upgrading WeeChat
|
||||
| logger/ | Logger plugin
|
||||
| logger.c | Main logger functions
|
||||
| logger-buffer.c | Logger buffer list management
|
||||
| logger-config.c | Logger config options (file logger.conf)
|
||||
| logger-info.c | Logger info/infolists/hdata
|
||||
| logger-tail.c | Return last lines of a file
|
||||
| logger-tail.c | Functions to get last lines of a file
|
||||
| lua/ | Lua plugin
|
||||
| weechat-lua.c | Main lua functions (load/unload scripts, execute lua code)
|
||||
| weechat-lua-api.c | Lua scripting API functions
|
||||
|
|
@ -229,12 +229,12 @@ WeeChat "core" reside in following directories:
|
|||
| relay-network.c | Network functions for relay
|
||||
| relay-raw.c | Relay raw buffer
|
||||
| relay-server.c | Relay server
|
||||
| relay-upgrade.c | Save/restore relay data when upgrading WeeChat
|
||||
| relay-websocket.c | Websocket server functions for relay (RFC 6455)
|
||||
| relay-upgrade.c | Save/restore of relay data when upgrading WeeChat
|
||||
| relay-websocket.c | WebSocket server functions (RFC 6455)
|
||||
| irc/ | IRC proxy
|
||||
| relay-irc.c | Main IRC proxy functions
|
||||
| weechat/ | Relay for remote interface
|
||||
| relay-weechat.c | Relay for remote interface (main functions)
|
||||
| weechat/ | Relay for remote interfaces
|
||||
| relay-weechat.c | Relay for remote interfaces (main functions)
|
||||
| relay-weechat-msg.c | Send binary messages to clients
|
||||
| relay-weechat-nicklist.c | Nicklist functions
|
||||
| relay-weechat-protocol.c | Read commands from clients
|
||||
|
|
@ -250,7 +250,7 @@ WeeChat "core" reside in following directories:
|
|||
| weechat-ruby-api.c | Ruby scripting API functions
|
||||
| script/ | Scripts manager
|
||||
| script.c | Main functions for scripts manager
|
||||
| script-action.c | Actions on scripts (load/unload, install/remove, hold, ...)
|
||||
| script-action.c | Actions on scripts (load/unload, install/remove, ...)
|
||||
| script-buffer.c | Buffer for scripts manager
|
||||
| script-command.c | Commands for scripts manager
|
||||
| script-completion.c | Completions for scripts manager
|
||||
|
|
@ -263,15 +263,15 @@ WeeChat "core" reside in following directories:
|
|||
| xfer/ | Xfer plugin (IRC DCC file/chat)
|
||||
| xfer.c | Main xfer functions
|
||||
| xfer-buffer.c | Xfer buffer
|
||||
| xfer-chat.c | Xfer DCC chat
|
||||
| xfer-chat.c | DCC chat
|
||||
| xfer-command.c | Xfer commands
|
||||
| xfer-completion.c | Xfer completions
|
||||
| xfer-config.c | Xfer config options (file xfer.conf)
|
||||
| xfer-dcc.c | Xfer DCC file
|
||||
| xfer-dcc.c | DCC file transfer
|
||||
| xfer-file.c | File functions for xfer
|
||||
| xfer-info.c | Xfer info/infolists/hdata
|
||||
| xfer-network.c | Network functions for xfer
|
||||
| xfer-upgrade.c | Save/restore xfer data when upgrading WeeChat
|
||||
| xfer-upgrade.c | Save/restore of xfer data when upgrading WeeChat
|
||||
|===
|
||||
|
||||
[[documentation_translations]]
|
||||
|
|
@ -297,12 +297,13 @@ Documentation files:
|
|||
| weechat_dev.XX.txt | Developer's guide (this document)
|
||||
| weechat_relay_protocol.XX.txt | Relay protocol
|
||||
| cmdline_options.XX.txt | Command-line options (file included in man page and user's guide)
|
||||
| autogen/ | Files auto-built with script docgen.py (do *NEVER* update manually!)
|
||||
| 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!)
|
||||
|===
|
||||
|
||||
Translations for WeeChat and plugins are done with gettext, files are in 'po/' directory:
|
||||
Translations for WeeChat and plugins are done with gettext, files are in 'po/'
|
||||
directory:
|
||||
|
||||
[width="100%",cols="1v,5",options="header"]
|
||||
|===
|
||||
|
|
@ -319,9 +320,15 @@ Translations for WeeChat and plugins are done with gettext, files are in 'po/' d
|
|||
=== General rules
|
||||
|
||||
* In source code, your comments, variable names, .. must be written in English
|
||||
*only* (no other language is allowed)
|
||||
* Use a copyright header in each new source file, with date, name, e-mail,
|
||||
license and below that a short description of file. Example in C:
|
||||
*only* (no other language is allowed).
|
||||
* Use a copyright header in each new source file with:
|
||||
** short description of file (one line),
|
||||
** date,
|
||||
** name,
|
||||
** e-mail,
|
||||
** license.
|
||||
|
||||
Example in C:
|
||||
|
||||
[source,C]
|
||||
----
|
||||
|
|
@ -356,8 +363,8 @@ Some basic rules you *must* follow when you write C code:
|
|||
* Try to not exceed 80 chars by line, except if this is needed to increase
|
||||
readability.
|
||||
* Use comments `/* comment */` (not C99-style comments like `// comment`).
|
||||
* Add a comment before any function, to explain what does the function (always
|
||||
use a multi-line comment, even if description is very short).
|
||||
* Add a comment before any function, to explain what it does (always use a
|
||||
multi-line comment, even if description is very short).
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -406,7 +413,7 @@ foo ()
|
|||
----
|
||||
|
||||
* Use parentheses to explicitly show how expression is evaluated, even if
|
||||
they are not required, for example: write `x + (y * z)` instead of `x + y * z`
|
||||
they are not required, for example: write `x + (y * z)` instead of `x + y * z`.
|
||||
* Place curly brackets `{ }` alone on lines, and indent them with number of
|
||||
spaces used for line above opening curly bracket (the `if` in example):
|
||||
|
||||
|
|
@ -504,7 +511,7 @@ switch (string[0])
|
|||
}
|
||||
----
|
||||
|
||||
* Use `typedef` for function prototypes, not structures:
|
||||
* Use `typedef` for function prototypes but not for structures:
|
||||
|
||||
[source,C]
|
||||
----
|
||||
|
|
@ -554,8 +561,8 @@ See http://www.python.org/dev/peps/pep-0008/
|
|||
==== Files
|
||||
|
||||
File names are composed by letters and hyphens, with format: 'xxx-yyyyy.[ch]',
|
||||
where 'xxx' is directory/component (can be abbreviation) where the file is, and
|
||||
'yyyyy' a name for the file, which shows the purpose of file.
|
||||
where 'xxx' is directory/component (can be abbreviation) and 'yyyyy' a name for
|
||||
the file.
|
||||
|
||||
The main file of a directory may have same name as directory, for example
|
||||
'irc.c' in irc plugin.
|
||||
|
|
@ -625,7 +632,7 @@ struct t_gui_window *gui_current_window = NULL; /* current window */
|
|||
----
|
||||
|
||||
There is no naming convention for local variables (in functions). The only
|
||||
recommendation is that name is explicit (not too short).
|
||||
recommendation is that name is explicit (not too short). +
|
||||
Nevertheless, pointers to structures are often named 'ptr_xxxx', for example a
|
||||
pointer on a 'struct t_gui_buffer *' will be: '*ptr_buffer'.
|
||||
|
||||
|
|
@ -633,7 +640,7 @@ pointer on a 'struct t_gui_buffer *' will be: '*ptr_buffer'.
|
|||
==== Functions
|
||||
|
||||
Naming convention for functions is the same as
|
||||
<<naming_convention_variables,variables,>>.
|
||||
<<naming_convention_variables,variables>>.
|
||||
|
||||
Example: creation of a new window (from 'src/gui/gui-window.c'):
|
||||
|
||||
|
|
@ -730,7 +737,7 @@ In following table, these conventions are used:
|
|||
|
||||
All combinations are summarized in this table:
|
||||
|
||||
[width="100%",cols="3,2,1,5",options="header"]
|
||||
[width="100%",cols="4,2,2,8",options="header"]
|
||||
|===
|
||||
| Code | Example | Areas | Description
|
||||
| hex[19] + STD | hex[19]`01` | chat + bars | Set attributes and color using option, see table below
|
||||
|
|
@ -753,16 +760,17 @@ All combinations are summarized in this table:
|
|||
| hex[19] + "b" + "#" | hex[19]`b#` | input bar | Move cursor char (used only in item "input_text")
|
||||
| hex[19] + "b" + "i" | hex[19]`bi` | bars | Start item
|
||||
| hex[19] + "b" + "l" (lower L) | hex[19]`bl` | bars | Start line item
|
||||
| hex[19] + "E" | hex[19]`E` | chat + bars | Emphasize text _(new in version 0.4.2)_
|
||||
| hex[19] + "E" | hex[19]`E` | chat + bars | Emphasize text _(WeeChat ≥ 0.4.2)_
|
||||
| hex[19] + hex[1C] | hex[19]hex[1C] | chat + bars | Reset color (keep attributes)
|
||||
| hex[1A] + ATTR | hex[1A]`*` | chat + bars | Set attribute
|
||||
| hex[1B] + ATTR | hex[1B]`*` | chat + bars | Remove attribute
|
||||
| hex[1C] | hex[1C] | chat + bars | Reset attributes and color
|
||||
|===
|
||||
|
||||
Color codes using options (see 't_gui_color_enum', in file 'src/gui/gui-color.h'):
|
||||
Color codes using options (see 't_gui_color_enum', in file
|
||||
'src/gui/gui-color.h'):
|
||||
|
||||
[width="60%",cols="^1m,10",options="header"]
|
||||
[width="70%",cols="^1m,10",options="header"]
|
||||
|===
|
||||
| Code | Option
|
||||
| 00 | weechat.color.separator
|
||||
|
|
@ -799,21 +807,21 @@ Color codes using options (see 't_gui_color_enum', in file 'src/gui/gui-color.h'
|
|||
| 31 | weechat.color.chat_text_found
|
||||
| 32 | weechat.color.chat_value
|
||||
| 33 | weechat.color.chat_prefix_buffer
|
||||
| 34 | weechat.color.chat_tags _(new in version 0.3.6)_
|
||||
| 35 | weechat.color.chat_inactive_window _(new in version 0.3.6)_
|
||||
| 36 | weechat.color.chat_inactive_buffer _(new in version 0.3.6)_
|
||||
| 37 | weechat.color.chat_prefix_buffer_inactive_buffer _(new in version 0.3.6)_
|
||||
| 38 | weechat.color.chat_nick_offline _(new in version 0.3.9)_
|
||||
| 39 | weechat.color.chat_nick_offline_highlight _(new in version 0.3.9)_
|
||||
| 40 | weechat.color.chat_nick_prefix _(new in version 0.4.1)_
|
||||
| 41 | weechat.color.chat_nick_suffix _(new in version 0.4.1)_
|
||||
| 42 | weechat.color.emphasis _(new in version 0.4.2)_
|
||||
| 43 | weechat.color.chat_day_change _(new in version 0.4.2)_
|
||||
| 34 | weechat.color.chat_tags _(WeeChat ≥ 0.3.6)_
|
||||
| 35 | weechat.color.chat_inactive_window _(WeeChat ≥ 0.3.6)_
|
||||
| 36 | weechat.color.chat_inactive_buffer _(WeeChat ≥ 0.3.6)_
|
||||
| 37 | weechat.color.chat_prefix_buffer_inactive_buffer _(WeeChat ≥ 0.3.6)_
|
||||
| 38 | weechat.color.chat_nick_offline _(WeeChat ≥ 0.3.9)_
|
||||
| 39 | weechat.color.chat_nick_offline_highlight _(WeeChat ≥ 0.3.9)_
|
||||
| 40 | weechat.color.chat_nick_prefix _(WeeChat ≥ 0.4.1)_
|
||||
| 41 | weechat.color.chat_nick_suffix _(WeeChat ≥ 0.4.1)_
|
||||
| 42 | weechat.color.emphasis _(WeeChat ≥ 0.4.2)_
|
||||
| 43 | weechat.color.chat_day_change _(WeeChat ≥ 0.4.2)_
|
||||
|===
|
||||
|
||||
WeeChat colors are:
|
||||
|
||||
[width="40%",cols="^1m,6",options="header"]
|
||||
[width="70%",cols="^1m,6",options="header"]
|
||||
|===
|
||||
| Code | Color
|
||||
| 00 | Default (terminal foreground/background)
|
||||
|
|
@ -837,7 +845,7 @@ WeeChat colors are:
|
|||
|
||||
Examples of color codes:
|
||||
|
||||
[width="50%",cols="1,2",options="header"]
|
||||
[width="70%",cols="1,2",options="header"]
|
||||
|===
|
||||
| Code | Description
|
||||
| hex[19]`01` | Color of option "01" (chat text)
|
||||
|
|
@ -853,13 +861,13 @@ Examples of color codes:
|
|||
== Plugin internals
|
||||
|
||||
The file 'src/plugins/weechat-plugin.h' defines and exports all functions
|
||||
available for API.
|
||||
available in the API.
|
||||
|
||||
A structure called 't_weechat_plugin' is used to store info about plugin
|
||||
(filename, name, author, description, ...) and all API functions, as pointers
|
||||
to WeeChat functions.
|
||||
|
||||
Then some macros are defined to call these functions in an easier way.
|
||||
Then some macros are defined to call these functions.
|
||||
|
||||
For example, function 'hook_timer' is defined in structure 't_weechat_plugin'
|
||||
like this:
|
||||
|
|
@ -915,7 +923,7 @@ component: fix a problem (bug #12345)
|
|||
|
||||
Where 'component' is one of following:
|
||||
|
||||
* WeeChat core: 'core' (files in directory 'src/' except doc and plugins)
|
||||
* WeeChat core: 'core' (files in directory 'src/' except 'doc' and 'plugins')
|
||||
* documentation files: 'doc' (files in directory 'doc/')
|
||||
* name of a plugin: 'irc', 'python', 'relay', ... (files in directory 'src/plugins/')
|
||||
|
||||
|
|
@ -943,6 +951,7 @@ core: update Japanese translations (patch #7783)
|
|||
==== Gettext
|
||||
|
||||
Gettext files are in directory 'po/'.
|
||||
|
||||
If you want to initialize a new language, use command `msginit`. For example to
|
||||
create a dutch empty file:
|
||||
|
||||
|
|
@ -951,8 +960,8 @@ $ cd po
|
|||
$ msginit -i weechat.pot -l nl_NL -o nl.po
|
||||
----
|
||||
|
||||
Base language for WeeChat is English, so you must of course understand English
|
||||
in order to translate to your language.
|
||||
Base language for WeeChat is English, so you must of course perfectly understand
|
||||
English in order to translate to your language.
|
||||
|
||||
When done, you *have* to check your file with script 'msgcheck.py'
|
||||
(https://github.com/flashcode/msgcheck):
|
||||
|
|
@ -980,18 +989,20 @@ Then create this alias to build files:
|
|||
/alias doc /perl unload; /python unload; /ruby unload; /lua unload; /tcl unload; /guile unload; /python load docgen.py; /wait 1ms /docgen
|
||||
----
|
||||
|
||||
And use command `/doc` to build all auto-generated files (for all languages).
|
||||
And use command `/doc` to build all files, for all languages.
|
||||
|
||||
[IMPORTANT]
|
||||
When using command `/doc`, be sure all C plugins (irc, charset, ...) are loaded,
|
||||
because files are built using options currently in memory.
|
||||
because files are built using data currently in memory.
|
||||
|
||||
[[asciidoc]]
|
||||
==== Asciidoc
|
||||
|
||||
Asciidoc files are in directory 'doc/XX/' where 'XX' is language (en, fr, de, it, ...)
|
||||
Asciidoc files are in directory 'doc/XX/' where 'XX' is language (en, fr, de,
|
||||
it, ...).
|
||||
|
||||
First make a copy of an English asciidoc file (in directory 'doc/en/'), then work on it.
|
||||
First make a copy of an English asciidoc file (in directory 'doc/en/'), then
|
||||
work on it.
|
||||
|
||||
The translations missing in files are indicated by this string:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= WeeChat Plugin API Reference
|
||||
= WeeChat plugin API reference
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: en
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= WeeChat Quick Start Guide
|
||||
= WeeChat quick start guide
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: en
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= WeeChat Relay Protocol
|
||||
= WeeChat Relay protocol
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: en
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= WeeChat Scripting Guide
|
||||
= WeeChat scripting guide
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: en
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= WeeChat Tester's Guide
|
||||
= WeeChat tester's guide
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: en
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= WeeChat User's Guide
|
||||
= WeeChat user's guide
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: en
|
||||
|
|
|
|||
|
|
@ -104,4 +104,15 @@ IF(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
|
|||
ADD_CUSTOM_TARGET(doc-tester-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.fr.html)
|
||||
INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.fr.html DESTINATION ${SHAREDIR}/doc/${PROJECT_NAME})
|
||||
|
||||
# developer's guide
|
||||
ADD_CUSTOM_COMMAND(
|
||||
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_dev.fr.html
|
||||
COMMAND ${ASCIIDOC_EXECUTABLE} ARGS -a revision="${VERSION}" -a stylesheet=${CMAKE_CURRENT_SOURCE_DIR}/../asciidoc.css -f ${CMAKE_CURRENT_SOURCE_DIR}/../asciidoc.conf -n -o ${CMAKE_CURRENT_BINARY_DIR}/weechat_dev.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_dev.fr.txt
|
||||
DEPENDS
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/weechat_dev.fr.txt
|
||||
COMMENT "Building weechat_dev.fr.html"
|
||||
)
|
||||
ADD_CUSTOM_TARGET(doc-dev-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_dev.fr.html)
|
||||
INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat_dev.fr.html DESTINATION ${SHAREDIR}/doc/${PROJECT_NAME})
|
||||
|
||||
ENDIF(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@ EXTRA_DIST = CMakeLists.txt \
|
|||
weechat_faq.fr.txt \
|
||||
weechat_quickstart.fr.txt \
|
||||
weechat_tester.fr.txt \
|
||||
weechat_dev.fr.txt \
|
||||
$(wildcard autogen/user/*.txt) \
|
||||
$(wildcard autogen/plugin_api/*.txt)
|
||||
|
||||
|
|
@ -43,7 +44,8 @@ if DOC
|
|||
weechat_scripting.fr.html \
|
||||
weechat_faq.fr.html \
|
||||
weechat_quickstart.fr.html \
|
||||
weechat_tester.fr.html
|
||||
weechat_tester.fr.html \
|
||||
weechat_dev.fr.html
|
||||
doc_install = install-doc
|
||||
doc_uninstall = uninstall-doc
|
||||
endif
|
||||
|
|
@ -79,6 +81,10 @@ weechat_quickstart.fr.html: weechat_quickstart.fr.txt
|
|||
weechat_tester.fr.html: weechat_tester.fr.txt
|
||||
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_tester.fr.html $(abs_top_srcdir)/doc/fr/weechat_tester.fr.txt
|
||||
|
||||
# developer's guide
|
||||
weechat_dev.fr.html: weechat_dev.fr.txt
|
||||
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_dev.fr.html $(abs_top_srcdir)/doc/fr/weechat_dev.fr.txt
|
||||
|
||||
# install man/docs
|
||||
|
||||
install-data-hook: $(man_install) $(doc_install)
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,4 +1,4 @@
|
|||
= Référence API Extension WeeChat
|
||||
= Référence API extension WeeChat
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: fr
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= Guide de Démarrage Rapide WeeChat
|
||||
= Guide de démarrage rapide WeeChat
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: fr
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= WeeChat Guide pour Scripts
|
||||
= Guide pour scripts WeeChat
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: fr
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
= Guide Utilisateur WeeChat
|
||||
= Guide utilisateur WeeChat
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
:lang: fr
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ WeeChat の主要なリポジトリは 2 つあります:
|
|||
* コアリポジトリ: ソースコードと文書が含まれています、
|
||||
URL は: http://git.savannah.gnu.org/gitweb/?p=weechat.git
|
||||
* スクリプト: weechat.org に投稿された '公式' スクリプト、
|
||||
URL は: http://git.savannah.gnu.org/gitweb/?p=weechat/scripts.git;a=summary
|
||||
URL は: http://git.savannah.gnu.org/gitweb/?p=weechat/scripts.git
|
||||
|
||||
このマニュアルはコアリポジトリの解説です。
|
||||
|
||||
|
|
@ -46,7 +46,6 @@ WeeChat の主要なリポジトリは 2 つあります:
|
|||
[width="100%",cols="1v,5",options="header"]
|
||||
|===
|
||||
| ディレクトリ | 説明
|
||||
| debian/ | Debian パッケージ用
|
||||
| src/ | ソースコードのルートディレクトリ
|
||||
| core/ | コア関数: エントリポイント、内部構造体
|
||||
| gui/ | バッファ、ウィンドウ、... を操作する関数 (全てのインターフェイスで使う)
|
||||
|
|
@ -56,7 +55,7 @@ WeeChat の主要なリポジトリは 2 つあります:
|
|||
| aspell/ | aspell プラグイン
|
||||
| charset/ | charset プラグイン
|
||||
| fifo/ | fifo プラグイン (WeeChat にコマンドを送信する FIFO パイプ)
|
||||
| irc/ | IRC プラグイン
|
||||
| irc/ | IRC (Internet Relay Chat) プラグイン
|
||||
| logger/ | logger プラグイン (表示されたメッセージをファイルに書き込む)
|
||||
| relay/ | relay プラグイン (irc プロキシ + リモートインターフェイス用の中継)
|
||||
| rmodifier/ | rmodifier プラグイン (正規表現を含む修飾子文字列)
|
||||
|
|
@ -70,7 +69,9 @@ WeeChat の主要なリポジトリは 2 つあります:
|
|||
| xfer/ | xfer (IRC DCC ファイル/チャット)
|
||||
| doc/ | 文書
|
||||
| po/ | 翻訳ファイル (gettext)
|
||||
| test/ | Weercd: WeeChat flood irc サーバ、Python 製
|
||||
// TRANSLATION MISSING
|
||||
| test/ | Tools/files to test WeeChat (like Weercd, an IRC server)
|
||||
| debian/ | Debian パッケージ用
|
||||
|===
|
||||
|
||||
[[sources]]
|
||||
|
|
@ -89,9 +90,10 @@ WeeChat "core" は以下のディレクトリに配置されています:
|
|||
| パス/ファイル名 | 説明
|
||||
| core/ | コア関数: エントリポイント、内部構造体
|
||||
| weechat.c | エントリポイント、コマンドラインオプション、main 関数、起動
|
||||
| wee-backtrace.c | セグメンテーション違反の後にバックトレースを表示
|
||||
// TRANSLATION MISSING
|
||||
| wee-backtrace.c | Display a backtrace after a crash
|
||||
| wee-command.c | WeeChat コアコマンド
|
||||
| wee-completion.c | コマンドラインの補完
|
||||
| wee-completion.c | デフォルト補完
|
||||
| wee-config-file.c | 設定ファイル管理
|
||||
| wee-config.c | WeeChat コアの設定オプション (weechat.conf ファイル)
|
||||
| wee-debug.c | デバッグ用関数
|
||||
|
|
@ -120,7 +122,7 @@ WeeChat "core" は以下のディレクトリに配置されています:
|
|||
| gui-buffer.c | バッファ
|
||||
| gui-chat.c | チャット関数 (メッセージの表示、...)
|
||||
| gui-color.c | 色関数
|
||||
| gui-completion.c | デフォルト補完
|
||||
| gui-completion.c | コマンドラインの補完
|
||||
| gui-cursor.c | カーソルモード (カーソルを自由に移動)
|
||||
| gui-filter.c | フィルタ
|
||||
| gui-focus.c | フォーカスについての関数 (カーソルモードとマウス用)
|
||||
|
|
@ -183,7 +185,8 @@ WeeChat "core" は以下のディレクトリに配置されています:
|
|||
| irc-bar-item.c | IRC バー要素
|
||||
| irc-buffer.c | IRC バッファ
|
||||
| irc-channel.c | IRC チャンネル
|
||||
| irc-color.c | 色関数
|
||||
// TRANSLATION MISSING
|
||||
| irc-color.c | IRC colors
|
||||
| irc-command.c | IRC コマンド
|
||||
| irc-completion.c | IRC 補完
|
||||
| irc-config.c | IRC 設定オプション (irc.conf ファイル)
|
||||
|
|
@ -250,7 +253,8 @@ WeeChat "core" は以下のディレクトリに配置されています:
|
|||
| weechat-ruby-api.c | ruby スクリプト作成 API 関数
|
||||
| script/ | スクリプトマネージャ
|
||||
| script.c | スクリプトマネージャの主要関数
|
||||
| script-action.c | スクリプトに対する操作 (ロード/アンロード、インストール/削除、ホールド、...)
|
||||
// TRANSLATION MISSING
|
||||
| script-action.c | Actions on scripts (load/unload, install/remove, ...)
|
||||
| script-buffer.c | スクリプトマネージャ用のバッファ
|
||||
| script-command.c | スクリプトマネージャ用のコマンド
|
||||
| script-completion.c | スクリプトマネージャ用の補完
|
||||
|
|
@ -267,7 +271,8 @@ WeeChat "core" は以下のディレクトリに配置されています:
|
|||
| xfer-command.c | xfer コマンド
|
||||
| xfer-completion.c | xfer 補完
|
||||
| xfer-config.c | xfer 設定オプション (xfer.conf ファイル)
|
||||
| xfer-dcc.c | xfer DCC ファイル
|
||||
// TRANSLATION MISSING
|
||||
| xfer-dcc.c | DCC file transfer
|
||||
| xfer-file.c | xfer のファイル関数
|
||||
| xfer-info.c | xfer の情報/インフォリスト/hdata
|
||||
| xfer-network.c | xfer のネットワーク関数
|
||||
|
|
@ -297,7 +302,7 @@ WeeChat "core" は以下のディレクトリに配置されています:
|
|||
| weechat_dev.XX.txt | 開発者リファレンス (この文書)
|
||||
| weechat_relay_protocol.XX.txt | リレープロトコル
|
||||
| cmdline_options.XX.txt | コマンドラインオプション (man ページとユーザガイドに含まれるファイル)
|
||||
| autogen/ | docgen.py スクリプトが自動生成するファイル (手作業による編集は*禁止* !)
|
||||
| autogen/ | docgen.py スクリプトが自動生成するファイル
|
||||
| user/ | ユーザーガイド用の自動生成ファイル (手作業による編集は*禁止* !)
|
||||
| plugin_api/ | プラグイン API 用の自動生成ファイル (手作業による編集は*禁止* !)
|
||||
|===
|
||||
|
|
@ -320,8 +325,13 @@ WeeChat とプラグインの翻訳は gettext で行います、ファイルは
|
|||
|
||||
* ソースコード内で使用する、コメント、変数名、...
|
||||
は必ず*英語* で記述してください (他の言語を使わないでください)
|
||||
* 新しいファイルのヘッダにはコピーライトを入れてください。日付、名前、電子メールアドレス、ライセンスを明記し、その後に短い説明を入れてください。C
|
||||
言語の例:
|
||||
// TRANSLATION MISSING
|
||||
* Use a copyright header in each new source file with:
|
||||
** short description of file (one line),
|
||||
** date,
|
||||
** name,
|
||||
** e-mail,
|
||||
** license.
|
||||
|
||||
[source,C]
|
||||
----
|
||||
|
|
@ -552,9 +562,10 @@ http://www.python.org/dev/peps/pep-0008/ を参照
|
|||
[[naming_convention_files]]
|
||||
==== ファイル
|
||||
|
||||
ファイル名に使えるのは文字とハイフンだけで、フォーマット: 'xxx-yyyyy.[ch]'
|
||||
に従ってください。'xxx' はファイルを置くディレクトリおよび構成要素
|
||||
(略称も可)で、'yyyyy' はファイルの目的を表す名前です。
|
||||
// TRANSLATION MISSING
|
||||
File names are composed by letters and hyphens, with format: 'xxx-yyyyy.[ch]',
|
||||
where 'xxx' is directory/component (can be abbreviation) and 'yyyyy' a name for
|
||||
the file.
|
||||
|
||||
主要ファイルにはディレクトリと同じ名前を付ける事ができます。例えば
|
||||
irc プラグインの 'irc.c' など。
|
||||
|
|
@ -631,7 +642,7 @@ struct t_gui_window *gui_current_window = NULL; /* current window */
|
|||
[[naming_convention_functions]]
|
||||
==== 関数
|
||||
|
||||
関数に対する命名規則は<<naming_convention_variables,変数,>>と同じです。
|
||||
関数に対する命名規則は<<naming_convention_variables,変数>>と同じです。
|
||||
|
||||
例: 新しいウィンドウの作成 ('src/gui/gui-window.c' より):
|
||||
|
||||
|
|
@ -728,7 +739,7 @@ WeeChat は文字列中に独自の色コードを使うことで、属性
|
|||
|
||||
以下の表にすべての組み合わせをまとめています:
|
||||
|
||||
[width="100%",cols="3,2,1,5",options="header"]
|
||||
[width="100%",cols="4,2,2,8",options="header"]
|
||||
|===
|
||||
| コード | 例 | エリア | 説明
|
||||
| hex[19] + STD | hex[19]`01` | chat + bars | オプションを使って属性と色を指定、色コードは以下の表を参照
|
||||
|
|
@ -751,7 +762,7 @@ WeeChat は文字列中に独自の色コードを使うことで、属性
|
|||
| hex[19] + "b" + "#" | hex[19]`b#` | input bar | カーソル文字を移動 ("input_text" 要素のみで利用可)
|
||||
| hex[19] + "b" + "i" | hex[19]`bi` | bars | 要素を開始
|
||||
| hex[19] + "b" + "l" (小文字の L) | hex[19]`bl` | bars | 行要素を開始
|
||||
| hex[19] + "E" | hex[19]`E` | chat + bars | テキストを強調 _(バージョン 0.4.2 の新機能)_
|
||||
| hex[19] + "E" | hex[19]`E` | chat + bars | テキストを強調 _(WeeChat ≥ 0.4.2)_
|
||||
| hex[19] + hex[1C] | hex[19]hex[1C] | chat + bars | 色をリセット (属性は保存)
|
||||
| hex[1A] + ATTR | hex[1A]`*` | chat + bars | 属性を設定
|
||||
| hex[1B] + ATTR | hex[1B]`*` | chat + bars | 属性を削除
|
||||
|
|
@ -760,7 +771,7 @@ WeeChat は文字列中に独自の色コードを使うことで、属性
|
|||
|
||||
オプションを使う色コード ('src/gui/gui-color.h' ファイルの 't_gui_color_enum' を参照):
|
||||
|
||||
[width="60%",cols="^1m,10",options="header"]
|
||||
[width="70%",cols="^1m,10",options="header"]
|
||||
|===
|
||||
| コード | オプション
|
||||
| 00 | weechat.color.separator
|
||||
|
|
@ -797,21 +808,21 @@ WeeChat は文字列中に独自の色コードを使うことで、属性
|
|||
| 31 | weechat.color.chat_text_found
|
||||
| 32 | weechat.color.chat_value
|
||||
| 33 | weechat.color.chat_prefix_buffer
|
||||
| 34 | weechat.color.chat_tags _(バージョン 0.3.6 の新機能)_
|
||||
| 35 | weechat.color.chat_inactive_window _(バージョン 0.3.6 の新機能)_
|
||||
| 36 | weechat.color.chat_inactive_buffer _(バージョン 0.3.6 の新機能)_
|
||||
| 37 | weechat.color.chat_prefix_buffer_inactive_buffer _(バージョン 0.3.6 の新機能)_
|
||||
| 38 | weechat.color.chat_nick_offline _(バージョン 0.3.9 の新機能)_
|
||||
| 39 | weechat.color.chat_nick_offline_highlight _(バージョン 0.3.9 の新機能)_
|
||||
| 40 | weechat.color.chat_nick_prefix _(バージョン 0.4.1 の新機能)_
|
||||
| 41 | weechat.color.chat_nick_suffix _(バージョン 0.4.1 の新機能)_
|
||||
| 42 | weechat.color.emphasis _(バージョン 0.4.2 の新機能)_
|
||||
| 43 | weechat.color.chat_day_change _(バージョン 0.4.2 の新機能)_
|
||||
| 34 | weechat.color.chat_tags _(WeeChat ≥ 0.3.6)_
|
||||
| 35 | weechat.color.chat_inactive_window _(WeeChat ≥ 0.3.6)_
|
||||
| 36 | weechat.color.chat_inactive_buffer _(WeeChat ≥ 0.3.6)_
|
||||
| 37 | weechat.color.chat_prefix_buffer_inactive_buffer _(WeeChat ≥ 0.3.6)_
|
||||
| 38 | weechat.color.chat_nick_offline _(WeeChat ≥ 0.3.9)_
|
||||
| 39 | weechat.color.chat_nick_offline_highlight _(WeeChat ≥ 0.3.9)_
|
||||
| 40 | weechat.color.chat_nick_prefix _(WeeChat ≥ 0.4.1)_
|
||||
| 41 | weechat.color.chat_nick_suffix _(WeeChat ≥ 0.4.1)_
|
||||
| 42 | weechat.color.emphasis _(WeeChat ≥ 0.4.2)_
|
||||
| 43 | weechat.color.chat_day_change _(WeeChat ≥ 0.4.2)_
|
||||
|===
|
||||
|
||||
WeeChat 色は:
|
||||
|
||||
[width="40%",cols="^1m,6",options="header"]
|
||||
[width="70%",cols="^1m,6",options="header"]
|
||||
|===
|
||||
| コード | 色
|
||||
| 00 | デフォルト (ターミナルの文字色/背景色)
|
||||
|
|
@ -835,7 +846,7 @@ WeeChat 色は:
|
|||
|
||||
色コードの例:
|
||||
|
||||
[width="50%",cols="1,2",options="header"]
|
||||
[width="70%",cols="1,2",options="header"]
|
||||
|===
|
||||
| コード | 説明
|
||||
| hex[19]`01` | オプション "01" の色 (チャットテキスト)
|
||||
|
|
@ -941,6 +952,7 @@ core: update Japanese translations (patch #7783)
|
|||
==== Gettext
|
||||
|
||||
Gettext ファイルは 'po/'
|
||||
|
||||
ディレクトリに入っています。新しい言語の翻訳を始める際は、コマンド
|
||||
`msginit` を使ってください。例えばオランダ語の空ファイルを作成するには:
|
||||
|
||||
|
|
@ -980,9 +992,10 @@ $ msgcheck.py xx.po
|
|||
|
||||
コマンド `/doc` を使って全ての (全てのプログラミング言語について) 自動生成するファイルを作成してください。
|
||||
|
||||
// TRANSLATION MISSING
|
||||
[IMPORTANT]
|
||||
コマンド `/doc` を使う際に、すべての C 言語プラグイン (irc、charset、...)
|
||||
がロードされていることを確認して下さい、これはメモリ上にあるオプションを使ってファイルを作成するためです。
|
||||
When using command `/doc`, be sure all C plugins (irc, charset, ...) are loaded,
|
||||
because files are built using data currently in memory.
|
||||
|
||||
[[asciidoc]]
|
||||
==== Asciidoc
|
||||
|
|
|
|||
Loading…
Reference in New Issue