foxiepaws
/
weechat
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: add comment in auto-generated doc files to prevent any changes by hand

v2.8-utf8proc
Sébastien Helleu 2015-03-11 20:15:23 +01:00
parent 80ccb335a4
commit ad499d944e
223 changed files with 1044 additions and 175 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/de/autogen/plugin_api/completions.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="65%",cols="^1,^2,8",options="header"]
|===
| Erweiterung | Name | Beschreibung

4
doc/de/autogen/plugin_api/hdata.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* 'guile_callback': Callback eines Skripts
** Erweiterung: guile
** Variablen:

4
doc/de/autogen/plugin_api/infolists.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="^1,^2,5,5,5",options="header"]
|===
| Erweiterung | Name | Beschreibung | Pointer | Argumente

4
doc/de/autogen/plugin_api/infos.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="^1,^2,6,6",options="header"]
|===
| Erweiterung | Name | Beschreibung | Argumente

4
doc/de/autogen/plugin_api/infos_hashtable.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="^1,^2,6,6,6",options="header"]
|===
| Erweiterung | Name | Beschreibung | Hashtable (Eingabe) | Hashtable (Ausgabe)

4
doc/de/autogen/plugin_api/plugins_priority.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
. charset (13000)
. logger (12000)
. exec (11000)

4
doc/de/autogen/plugin_api/url_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="2,^1,7",options="header"]
|===
| Einstellung | Type | Konstanten ^(1)^

4
doc/de/autogen/user/alias_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_alias_alias]]
[command]*`alias`* Einem Befehl wird ein Alias zugewiesen::

4
doc/de/autogen/user/aspell_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_aspell_aspell]]
[command]*`aspell`* Konfiguration für Aspell-Erweiterung::

4
doc/de/autogen/user/aspell_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_aspell.check.commands]] *aspell.check.commands*
** Beschreibung: `durch Kommata getrennte Liste der Befehle, für die eine Rechtschreibprüfung gelten soll (Rechtschreibprüfung ist für andere Befehle deaktiviert)`
** Typ: Zeichenkette

4
doc/de/autogen/user/charset_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_charset_charset]]
[command]*`charset`* Ändert den Zeichensatz für aktuellen Buffer::

4
doc/de/autogen/user/charset_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_charset.default.decode]] *charset.default.decode*
** Beschreibung: `globale Zeichendekodierung: Zeichendekodierung die für eingehende Nachrichten genutzt werden soll, falls diese nicht UTF-8 gültig ist`
** Typ: Zeichenkette

4
doc/de/autogen/user/exec_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_exec_exec]]
[command]*`exec`* führe externe Befehle aus::

4
doc/de/autogen/user/exec_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_exec.color.flag_finished]] *exec.color.flag_finished*
** Beschreibung: `Textfarbe des Statusindikator (in der Auflistung der Befehle) für beendete Befehle`
** Typ: Farbe

4
doc/de/autogen/user/guile_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_guile_guile]]
[command]*`guile`* auflisten/installieren/beenden von Skripten::

4
doc/de/autogen/user/irc_colors.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="30%",cols="^2m,3",options="header"]
|===
| IRC-Farbe | WeeChat-Farbe

4
doc/de/autogen/user/irc_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_irc_admin]]
[command]*`admin`* Information über den Server-Administrator abfragen::

4
doc/de/autogen/user/irc_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_irc.color.input_nick]] *irc.color.input_nick*
** Beschreibung: `Farbe des eigenen Nicknamens in der Eingabezeile`
** Typ: Farbe

4
doc/de/autogen/user/javascript_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_javascript_javascript]]
[command]*`javascript`* auflisten/installieren/beenden von Skripten::

4
doc/de/autogen/user/logger_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_logger_logger]]
[command]*`logger`* Konfiguration für "logger" Erweiterung (dient zum protokollieren der Buffer)::

4
doc/de/autogen/user/logger_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_logger.color.backlog_end]] *logger.color.backlog_end*
** Beschreibung: `Farbe für die letzte Zeile im Verlaufsspeicher`
** Typ: Farbe

4
doc/de/autogen/user/lua_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_lua_lua]]
[command]*`lua`* auflisten/installieren/beenden von Skripten::

4
doc/de/autogen/user/perl_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_perl_perl]]
[command]*`perl`* auflisten/installieren/beenden von Skripten::

4
doc/de/autogen/user/python_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_python_python]]
[command]*`python`* auflisten/installieren/beenden von Skripten::

4
doc/de/autogen/user/relay_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_relay_relay]]
[command]*`relay`* Relay-Kontrolle::

4
doc/de/autogen/user/relay_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_relay.color.client]] *relay.color.client*
** Beschreibung: `Textfarbe für Client-Beschreibung`
** Typ: Farbe

4
doc/de/autogen/user/ruby_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_ruby_ruby]]
[command]*`ruby`* auflisten/installieren/beenden von Skripten::

4
doc/de/autogen/user/script_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_script_script]]
[command]*`script`* WeeChat Skripten-Manager::

4
doc/de/autogen/user/script_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_script.color.status_autoloaded]] *script.color.status_autoloaded*
** Beschreibung: `Farbe in der der Status "autoloaded" ("a") dargestellt werden soll`
** Typ: Farbe

4
doc/de/autogen/user/sec_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_sec.crypt.cipher]] *sec.crypt.cipher*
** Beschreibung: `zu nutzendes Chiffre zum Verschlüsseln von Daten (die Zahl hinter dem Algorithmus bestimmt die Größe des Schlüssels, in Bits)`
** Typ: integer

4
doc/de/autogen/user/tcl_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_tcl_tcl]]
[command]*`tcl`* auflisten/installieren/beenden von Skripten::

4
doc/de/autogen/user/trigger_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_trigger_trigger]]
[command]*`trigger`* verwaltet Trigger, das Schweizer Armeemesser für WeeChat::

4
doc/de/autogen/user/trigger_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_trigger.color.flag_command]] *trigger.color.flag_command*
** Beschreibung: `Textfarbe für Befehls-Flag (in /trigger list)`
** Typ: Farbe

4
doc/de/autogen/user/weechat_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_weechat_away]]
[command]*`away`* Abwesenheitsstatus setzen oder entfernen::

4
doc/de/autogen/user/weechat_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_weechat.color.bar_more]] *weechat.color.bar_more*
** Beschreibung: `Farbe des '+' beim Scrollen von Info-Bars`
** Typ: Farbe

4
doc/de/autogen/user/xfer_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_xfer_me]]
[command]*`me`* sendet CTCP Aktion an entfernten Host::

4
doc/de/autogen/user/xfer_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_xfer.color.status_aborted]] *xfer.color.status_aborted*
** Beschreibung: `Textfarbe für Status: "abgebrochen"`
** Typ: Farbe

331
doc/docgen.py
View File

@ -137,6 +137,56 @@ IGNORE_COMPLETIONS_ITEMS = (
)
class AutogenDoc(object):
"""A class to write auto-generated doc files."""
def __init__(self, directory, doc, name):
"""Initialize auto-generated doc file."""
self.filename = os.path.join(directory, doc, name + '.asciidoc')
self.filename_tmp = self.filename + '.tmp'
self._file = open(self.filename_tmp, 'w')
self.write('//\n')
self.write('// This file is auto-generated by script docgen.py.\n')
self.write('// DO NOT EDIT BY HAND!\n')
self.write('//\n')
def write(self, string):
"""Write a line in auto-generated doc file."""
self._file.write(string)
def update(self, obj_name, num_files, num_files_updated):
"""Update doc file if needed (if content has changed)."""
# close temp file
self._file.close()
# compute checksum on old file
try:
with open(self.filename, 'r') as _file:
shaold = hashlib.sha256(_file.read()).hexdigest()
except IOError:
shaold = ''
# compute checksum on new (temp) file
try:
with open(self.filename_tmp, 'r') as _file:
shanew = hashlib.sha256(_file.read()).hexdigest()
except IOError:
shanew = ''
# compare checksums
if shaold != shanew:
# update doc file
if os.path.exists(self.filename):
os.unlink(self.filename)
os.rename(self.filename_tmp, self.filename)
num_files_updated['total1'] += 1
num_files_updated['total2'] += 1
num_files_updated[obj_name] += 1
else:
os.unlink(self.filename_tmp)
# update counters
num_files['total1'] += 1
num_files['total2'] += 1
num_files[obj_name] += 1
def get_commands():
"""
Get list of WeeChat/plugins commands as dictionary with 3 indexes: plugin,
@ -369,33 +419,6 @@ def get_plugins_priority():
return plugins_priority
def update_file(oldfile, newfile, num_files, num_files_updated, obj):
"""Update a doc file."""
try:
with open(oldfile, 'r') as _file:
shaold = hashlib.sha224(_file.read()).hexdigest()
except IOError:
shaold = ''
try:
with open(newfile, 'r') as _file:
shanew = hashlib.sha224(_file.read()).hexdigest()
except IOError:
shanew = ''
if shaold != shanew:
if os.path.exists(oldfile):
os.unlink(oldfile)
os.rename(newfile, oldfile)
num_files_updated['total1'] += 1
num_files_updated['total2'] += 1
num_files_updated[obj] += 1
else:
if os.path.exists(oldfile):
os.unlink(newfile)
num_files['total1'] += 1
num_files['total2'] += 1
num_files[obj] += 1
# pylint: disable=too-many-locals, too-many-branches, too-many-statements
def docgen_cmd_cb(data, buf, args):
"""Callback for /docgen command."""
@ -446,37 +469,31 @@ def docgen_cmd_cb(data, buf, args):
# write commands
for plugin in commands:
filename = directory + '/user/' + plugin + '_commands.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
doc = AutogenDoc(directory, 'user', plugin + '_commands')
for command in sorted(commands[plugin]):
_cmd = commands[plugin][command]
args = translate(_cmd['args'])
args_formats = args.split(' || ')
desc = translate(_cmd['description'])
args_desc = translate(_cmd['args_description'])
_file.write('[[command_{0}_{1}]]\n'.format(plugin, command))
_file.write('[command]*`{0}`* {1}::\n\n'.format(command, desc))
_file.write('----\n')
doc.write('[[command_{0}_{1}]]\n'.format(plugin, command))
doc.write('[command]*`{0}`* {1}::\n\n'.format(command, desc))
doc.write('----\n')
prefix = '/' + command + ' '
if args_formats != ['']:
for fmt in args_formats:
_file.write(prefix + fmt + '\n')
doc.write(prefix + fmt + '\n')
prefix = ' ' * len(prefix)
if args_desc:
_file.write('\n')
doc.write('\n')
for line in args_desc.split('\n'):
_file.write(line + '\n')
_file.write('----\n\n')
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'commands')
doc.write(line + '\n')
doc.write('----\n\n')
doc.update('commands', num_files, num_files_updated)
# write config options
for config in options:
filename = directory + '/user/' + config + '_options.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
doc = AutogenDoc(directory, 'user', config + '_options')
for section in sorted(options[config]):
for option in sorted(options[config][section]):
_opt = options[config][section][option]
@ -519,98 +536,93 @@ def docgen_cmd_cb(data, buf, args):
'only, not background): \"*\" for bold, '
'\"!\" for reverse, \"/\" for italic, '
'\"_\" for underline')
_file.write('* [[option_{0}.{1}.{2}]] *{3}.{4}.{5}*\n'
''.format(config, section, option, config,
section, option))
_file.write('** {0}: `{1}`\n'.format(_('description'),
desc))
_file.write('** {0}: {1}\n'.format(_('type'), type_nls))
_file.write('** {0}: {1} ({2}: `{3}`)\n'
''.format(_('values'), values,
_('default value'), default_value))
doc.write('* [[option_{0}.{1}.{2}]] *{3}.{4}.{5}*\n'
''.format(config, section, option, config,
section, option))
doc.write('** {0}: `{1}`\n'.format(_('description'), desc))
doc.write('** {0}: {1}\n'.format(_('type'), type_nls))
doc.write('** {0}: {1} ({2}: `{3}`)\n'
''.format(_('values'), values,
_('default value'), default_value))
if null_value_allowed:
_file.write('** {0}\n'
''.format(
_('undefined value allowed (null)')))
_file.write('\n')
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'options')
doc.write('** {0}\n'.format(
_('undefined value allowed (null)')))
doc.write('\n')
doc.update('options', num_files, num_files_updated)
# write IRC colors
doc = AutogenDoc(directory, 'user', 'irc_colors')
doc.write('[width="30%",cols="^2m,3",options="header"]\n')
doc.write('|===\n')
doc.write('| {0} | {1}\n\n'
''.format(_('IRC color'), _('WeeChat color')))
for color in irc_colors:
doc.write('| {0} | {1}\n'
''.format(escape(color['color_irc']),
escape(color['color_weechat'])))
doc.write('|===\n')
doc.update('irc_colors', num_files, num_files_updated)
# write infos hooked
filename = directory + '/plugin_api/infos.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
_file.write('[width="100%",cols="^1,^2,6,6",options="header"]\n')
_file.write('|===\n')
_file.write('| {0} | {1} | {2} | {3}\n\n'
''.format(_('Plugin'), _('Name'), _('Description'),
_('Arguments')))
doc = AutogenDoc(directory, 'plugin_api', 'infos')
doc.write('[width="100%",cols="^1,^2,6,6",options="header"]\n')
doc.write('|===\n')
doc.write('| {0} | {1} | {2} | {3}\n\n'
''.format(_('Plugin'), _('Name'), _('Description'),
_('Arguments')))
for plugin in sorted(infos):
for info in sorted(infos[plugin]):
_inf = infos[plugin][info]
desc = translate(_inf['description'])
args_desc = translate(_inf['args_description'] or '-')
_file.write('| {0} | {1} | {2} | {3}\n\n'
''.format(escape(plugin), escape(info),
escape(desc), escape(args_desc)))
_file.write('|===\n')
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'infos')
doc.write('| {0} | {1} | {2} | {3}\n\n'
''.format(escape(plugin), escape(info),
escape(desc), escape(args_desc)))
doc.write('|===\n')
doc.update('infos', num_files, num_files_updated)
# write infos (hashtable) hooked
filename = directory + '/plugin_api/infos_hashtable.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
_file.write('[width="100%",cols="^1,^2,6,6,6",options="header"]\n')
_file.write('|===\n')
_file.write('| {0} | {1} | {2} | {3} | {4}\n\n'
''.format(_('Plugin'), _('Name'), _('Description'),
_('Hashtable (input)'), _('Hashtable (output)')))
doc = AutogenDoc(directory, 'plugin_api', 'infos_hashtable')
doc.write('[width="100%",cols="^1,^2,6,6,6",options="header"]\n')
doc.write('|===\n')
doc.write('| {0} | {1} | {2} | {3} | {4}\n\n'
''.format(_('Plugin'), _('Name'), _('Description'),
_('Hashtable (input)'), _('Hashtable (output)')))
for plugin in sorted(infos_hashtable):
for info in sorted(infos_hashtable[plugin]):
_inh = infos_hashtable[plugin][info]
desc = translate(_inh['description'])
args_desc = translate(_inh['args_description'])
output_desc = translate(_inh['output_description']) or '-'
_file.write('| {0} | {1} | {2} | {3} | {4}\n\n'
''.format(escape(plugin), escape(info),
escape(desc), escape(args_desc),
escape(output_desc)))
_file.write('|===\n')
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'infos_hashtable')
doc.write('| {0} | {1} | {2} | {3} | {4}\n\n'
''.format(escape(plugin), escape(info),
escape(desc), escape(args_desc),
escape(output_desc)))
doc.write('|===\n')
doc.update('infos_hashtable', num_files, num_files_updated)
# write infolists hooked
filename = directory + '/plugin_api/infolists.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
_file.write('[width="100%",cols="^1,^2,5,5,5",options="header"]\n')
_file.write('|===\n')
_file.write('| {0} | {1} | {2} | {3} | {4}\n\n'
''.format(_('Plugin'), _('Name'), _('Description'),
_('Pointer'), _('Arguments')))
doc = AutogenDoc(directory, 'plugin_api', 'infolists')
doc.write('[width="100%",cols="^1,^2,5,5,5",options="header"]\n')
doc.write('|===\n')
doc.write('| {0} | {1} | {2} | {3} | {4}\n\n'
''.format(_('Plugin'), _('Name'), _('Description'),
_('Pointer'), _('Arguments')))
for plugin in sorted(infolists):
for infolist in sorted(infolists[plugin]):
_inl = infolists[plugin][infolist]
desc = translate(_inl['description'])
pointer_desc = translate(_inl['pointer_description']) or '-'
args_desc = translate(_inl['args_description']) or '-'
_file.write('| {0} | {1} | {2} | {3} | {4}\n\n'
''.format(escape(plugin), escape(infolist),
escape(desc), escape(pointer_desc),
escape(args_desc)))
_file.write('|===\n')
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'infolists')
doc.write('| {0} | {1} | {2} | {3} | {4}\n\n'
''.format(escape(plugin), escape(infolist),
escape(desc), escape(pointer_desc),
escape(args_desc)))
doc.write('|===\n')
doc.update('infolists', num_files, num_files_updated)
# write hdata hooked
filename = directory + '/plugin_api/hdata.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
doc = AutogenDoc(directory, 'plugin_api', 'hdata')
for plugin in sorted(hdata):
for hdata_name in sorted(hdata[plugin]):
_hda = hdata[plugin][hdata_name]
@ -618,92 +630,61 @@ def docgen_cmd_cb(data, buf, args):
variables = _hda['vars']
variables_update = _hda['vars_update']
lists = _hda['lists']
_file.write('* \'{0}\': {1}\n'.format(escape(hdata_name),
escape(desc)))
_file.write('** {0}: {1}\n'.format(_('plugin'),
escape(plugin)))
_file.write('** {0}:\n{1}'.format(_('variables'),
escape(variables)))
doc.write('* \'{0}\': {1}\n'.format(escape(hdata_name),
escape(desc)))
doc.write('** {0}: {1}\n'.format(_('plugin'),
escape(plugin)))
doc.write('** {0}:\n{1}'.format(_('variables'),
escape(variables)))
if variables_update:
_file.write('** {0}:\n{1}'.format(
doc.write('** {0}:\n{1}'.format(
_('update allowed'),
escape(variables_update)))
if lists:
_file.write('** {0}:\n{1}'.format(_('lists'),
escape(lists)))
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'hdata')
doc.write('** {0}:\n{1}'.format(_('lists'),
escape(lists)))
doc.update('hdata', num_files, num_files_updated)
# write completions hooked
filename = directory + '/plugin_api/completions.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
_file.write('[width="65%",cols="^1,^2,8",options="header"]\n')
_file.write('|===\n')
_file.write('| {0} | {1} | {2}\n\n'
''.format(_('Plugin'), _('Name'), _('Description')))
doc = AutogenDoc(directory, 'plugin_api', 'completions')
doc.write('[width="65%",cols="^1,^2,8",options="header"]\n')
doc.write('|===\n')
doc.write('| {0} | {1} | {2}\n\n'
''.format(_('Plugin'), _('Name'), _('Description')))
for plugin in sorted(completions):
for completion_item in sorted(completions[plugin]):
_cmp = completions[plugin][completion_item]
desc = translate(_cmp['description'])
_file.write('| {0} | {1} | {2}\n\n'
''.format(escape(plugin), escape(completion_item),
escape(desc)))
_file.write('|===\n')
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'completions')
doc.write('| {0} | {1} | {2}\n\n'
''.format(escape(plugin), escape(completion_item),
escape(desc)))
doc.write('|===\n')
doc.update('completions', num_files, num_files_updated)
# write url options
filename = directory + '/plugin_api/url_options.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
_file.write('[width="100%",cols="2,^1,7",options="header"]\n')
_file.write('|===\n')
_file.write('| {0} | {1} | {2}\n\n'
''.format(_('Option'), _('Type'),
_('Constants') + ' ^(1)^'))
doc = AutogenDoc(directory, 'plugin_api', 'url_options')
doc.write('[width="100%",cols="2,^1,7",options="header"]\n')
doc.write('|===\n')
doc.write('| {0} | {1} | {2}\n\n'
''.format(_('Option'), _('Type'),
_('Constants') + ' ^(1)^'))
for option in url_options:
constants = option['constants']
if constants:
constants = ' ' + constants
_file.write('| {0} | {1} |{2}\n\n'
''.format(escape(option['name']),
escape(option['type']),
escape(constants)))
_file.write('|===\n')
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'url_options')
# write IRC colors
filename = directory + '/user/irc_colors.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
_file.write('[width="30%",cols="^2m,3",options="header"]\n')
_file.write('|===\n')
_file.write('| {0} | {1}\n\n'
''.format(_('IRC color'), _('WeeChat color')))
for color in irc_colors:
_file.write('| {0} | {1}\n'
''.format(escape(color['color_irc']),
escape(color['color_weechat'])))
_file.write('|===\n')
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'irc_colors')
doc.write('| {0} | {1} |{2}\n\n'
''.format(escape(option['name']),
escape(option['type']),
escape(constants)))
doc.write('|===\n')
doc.update('url_options', num_files, num_files_updated)
# write plugins priority
filename = directory + '/plugin_api/plugins_priority.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
doc = AutogenDoc(directory, 'plugin_api', 'plugins_priority')
for priority in sorted(plugins_priority, reverse=True):
plugins = ', '.join(sorted(plugins_priority[priority]))
_file.write('. {0} ({1})\n'.format(escape(plugins), priority))
_file.close()
update_file(filename, tmpfilename, num_files, num_files_updated,
'plugins_priority')
doc.write('. {0} ({1})\n'.format(escape(plugins), priority))
doc.update('plugins_priority', num_files, num_files_updated)
# write counters
weechat.prnt('',

4
doc/en/autogen/plugin_api/completions.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="65%",cols="^1,^2,8",options="header"]
|===
| Plugin | Name | Description

4
doc/en/autogen/plugin_api/hdata.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* 'guile_callback': callback of a script
** plugin: guile
** variables:

4
doc/en/autogen/plugin_api/infolists.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="^1,^2,5,5,5",options="header"]
|===
| Plugin | Name | Description | Pointer | Arguments

4
doc/en/autogen/plugin_api/infos.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="^1,^2,6,6",options="header"]
|===
| Plugin | Name | Description | Arguments

4
doc/en/autogen/plugin_api/infos_hashtable.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="^1,^2,6,6,6",options="header"]
|===
| Plugin | Name | Description | Hashtable (input) | Hashtable (output)

4
doc/en/autogen/plugin_api/plugins_priority.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
. charset (13000)
. logger (12000)
. exec (11000)

4
doc/en/autogen/plugin_api/url_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="2,^1,7",options="header"]
|===
| Option | Type | Constants ^(1)^

4
doc/en/autogen/user/alias_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_alias_alias]]
[command]*`alias`* create an alias for a command::

4
doc/en/autogen/user/aspell_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_aspell_aspell]]
[command]*`aspell`* aspell plugin configuration::

4
doc/en/autogen/user/aspell_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_aspell.check.commands]] *aspell.check.commands*
** description: `comma separated list of commands for which spell checking is enabled (spell checking is disabled for all other commands)`
** type: string

4
doc/en/autogen/user/charset_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_charset_charset]]
[command]*`charset`* change charset for current buffer::

4
doc/en/autogen/user/charset_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_charset.default.decode]] *charset.default.decode*
** description: `global decoding charset: charset used to decode incoming messages when they are not UTF-8 valid`
** type: string

4
doc/en/autogen/user/exec_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_exec_exec]]
[command]*`exec`* execute external commands::

4
doc/en/autogen/user/exec_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_exec.color.flag_finished]] *exec.color.flag_finished*
** description: `text color for a finished command flag in list of commands`
** type: color

4
doc/en/autogen/user/guile_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_guile_guile]]
[command]*`guile`* list/load/unload scripts::

4
doc/en/autogen/user/irc_colors.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="30%",cols="^2m,3",options="header"]
|===
| IRC color | WeeChat color

4
doc/en/autogen/user/irc_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_irc_admin]]
[command]*`admin`* find information about the administrator of the server::

4
doc/en/autogen/user/irc_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_irc.color.input_nick]] *irc.color.input_nick*
** description: `color for nick in input bar`
** type: color

4
doc/en/autogen/user/javascript_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_javascript_javascript]]
[command]*`javascript`* list/load/unload scripts::

4
doc/en/autogen/user/logger_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_logger_logger]]
[command]*`logger`* logger plugin configuration::

4
doc/en/autogen/user/logger_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_logger.color.backlog_end]] *logger.color.backlog_end*
** description: `color for line ending the backlog`
** type: color

4
doc/en/autogen/user/lua_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_lua_lua]]
[command]*`lua`* list/load/unload scripts::

4
doc/en/autogen/user/perl_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_perl_perl]]
[command]*`perl`* list/load/unload scripts::

4
doc/en/autogen/user/python_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_python_python]]
[command]*`python`* list/load/unload scripts::

4
doc/en/autogen/user/relay_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_relay_relay]]
[command]*`relay`* relay control::

4
doc/en/autogen/user/relay_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_relay.color.client]] *relay.color.client*
** description: `text color for client description`
** type: color

4
doc/en/autogen/user/ruby_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_ruby_ruby]]
[command]*`ruby`* list/load/unload scripts::

4
doc/en/autogen/user/script_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_script_script]]
[command]*`script`* WeeChat scripts manager::

4
doc/en/autogen/user/script_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_script.color.status_autoloaded]] *script.color.status_autoloaded*
** description: `color for status "autoloaded" ("a")`
** type: color

4
doc/en/autogen/user/sec_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_sec.crypt.cipher]] *sec.crypt.cipher*
** description: `cipher used to crypt data (the number after algorithm is the size of the key in bits)`
** type: integer

4
doc/en/autogen/user/tcl_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_tcl_tcl]]
[command]*`tcl`* list/load/unload scripts::

4
doc/en/autogen/user/trigger_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_trigger_trigger]]
[command]*`trigger`* manage triggers, the Swiss Army knife for WeeChat::

4
doc/en/autogen/user/trigger_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_trigger.color.flag_command]] *trigger.color.flag_command*
** description: `text color for command flag (in /trigger list)`
** type: color

4
doc/en/autogen/user/weechat_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_weechat_away]]
[command]*`away`* set or remove away status::

4
doc/en/autogen/user/weechat_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_weechat.color.bar_more]] *weechat.color.bar_more*
** description: `text color for '+' when scrolling bars`
** type: color

4
doc/en/autogen/user/xfer_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_xfer_me]]
[command]*`me`* send a CTCP action to remote host::

4
doc/en/autogen/user/xfer_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_xfer.color.status_aborted]] *xfer.color.status_aborted*
** description: `text color for "aborted" status`
** type: color

4
doc/fr/autogen/plugin_api/completions.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="65%",cols="^1,^2,8",options="header"]
|===
| Extension | Nom | Description

4
doc/fr/autogen/plugin_api/hdata.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* 'guile_callback': callback d'un script
** extension: guile
** variables:

4
doc/fr/autogen/plugin_api/infolists.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="^1,^2,5,5,5",options="header"]
|===
| Extension | Nom | Description | Pointeur | Paramètres

4
doc/fr/autogen/plugin_api/infos.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="^1,^2,6,6",options="header"]
|===
| Extension | Nom | Description | Paramètres

4
doc/fr/autogen/plugin_api/infos_hashtable.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="^1,^2,6,6,6",options="header"]
|===
| Extension | Nom | Description | Table de hachage (entrée) | Table de hachage (sortie)

4
doc/fr/autogen/plugin_api/plugins_priority.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
. charset (13000)
. logger (12000)
. exec (11000)

4
doc/fr/autogen/plugin_api/url_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="100%",cols="2,^1,7",options="header"]
|===
| Option | Type | Constantes ^(1)^

4
doc/fr/autogen/user/alias_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_alias_alias]]
[command]*`alias`* créer un alias pour une commande::

4
doc/fr/autogen/user/aspell_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_aspell_aspell]]
[command]*`aspell`* configuration de l'extension aspell::

4
doc/fr/autogen/user/aspell_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_aspell.check.commands]] *aspell.check.commands*
** description: `liste de commandes (séparées par des virgules) pour lesquelles la vérification orthographique est activée (la vérification est désactivée pour toutes les autres commandes)`
** type: chaîne

4
doc/fr/autogen/user/charset_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_charset_charset]]
[command]*`charset`* changer le charset pour le tampon courant::

4
doc/fr/autogen/user/charset_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_charset.default.decode]] *charset.default.decode*
** description: `charset de décodage global : charset utilisé pour décoder les messages entrants lorsqu'ils ne sont pas valides UTF-8`
** type: chaîne

4
doc/fr/autogen/user/exec_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_exec_exec]]
[command]*`exec`* exécuter des commandes externes::

4
doc/fr/autogen/user/exec_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_exec.color.flag_finished]] *exec.color.flag_finished*
** description: `couleur du texte pour le drapeau d'une commande terminée dans la liste des commandes`
** type: couleur

4
doc/fr/autogen/user/guile_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_guile_guile]]
[command]*`guile`* lister/charger/décharger des scripts::

4
doc/fr/autogen/user/irc_colors.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[width="30%",cols="^2m,3",options="header"]
|===
| Couleur IRC | Couleur WeeChat

4
doc/fr/autogen/user/irc_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_irc_admin]]
[command]*`admin`* trouver les informations sur l'administrateur du serveur::

4
doc/fr/autogen/user/irc_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_irc.color.input_nick]] *irc.color.input_nick*
** description: `couleur du pseudo dans la barre de saisie`
** type: couleur

4
doc/fr/autogen/user/javascript_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_javascript_javascript]]
[command]*`javascript`* lister/charger/décharger des scripts::

4
doc/fr/autogen/user/logger_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_logger_logger]]
[command]*`logger`* configuration de l'extension logger::

4
doc/fr/autogen/user/logger_options.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
* [[option_logger.color.backlog_end]] *logger.color.backlog_end*
** description: `couleur pour la ligne de fin de l'historique`
** type: couleur

4
doc/fr/autogen/user/lua_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_lua_lua]]
[command]*`lua`* lister/charger/décharger des scripts::

4
doc/fr/autogen/user/perl_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_perl_perl]]
[command]*`perl`* lister/charger/décharger des scripts::

4
doc/fr/autogen/user/python_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_python_python]]
[command]*`python`* lister/charger/décharger des scripts::

4
doc/fr/autogen/user/relay_commands.asciidoc
View File

@ -1,3 +1,7 @@
//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_relay_relay]]
[command]*`relay`* contrôle du relai::

Some files were not shown because too many files have changed in this diff Show More