doc: use .asciidoc extension instead of .txt for doc files

v2.8-utf8proc
Sébastien Helleu 2014-05-25 12:25:58 +02:00
parent 76a066c9cc
commit dc0229617a
275 changed files with 581 additions and 577 deletions

View File

@ -21,12 +21,12 @@ if(ENABLE_MAN)
# man page
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat.1
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.de.txt ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.de.txt ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${A2X_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -d manpage -f manpage -L ${CMAKE_CURRENT_BINARY_DIR}/weechat.1.de.txt
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.de.asciidoc ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.de.asciidoc ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${A2X_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -d manpage -f manpage -L ${CMAKE_CURRENT_BINARY_DIR}/weechat.1.de.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.de.txt
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.de.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.de.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.de.asciidoc
COMMENT "Building weechat.1 (de)"
)
add_custom_target(doc-man-de ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat.1)
@ -38,11 +38,11 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# user's guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.de.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_user.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.de.txt
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_user.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.de.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.de.txt
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.de.txt
${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.de.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.de.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.asciidoc
COMMENT "Building weechat_user.de.html"
)
add_custom_target(doc-user-de ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.de.html)
@ -51,9 +51,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# scripting guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_scripting.de.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_scripting.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.de.txt
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_scripting.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.de.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.de.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.de.asciidoc
COMMENT "Building weechat_scripting.de.html"
)
add_custom_target(doc-scripting-de ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_scripting.de.html)
@ -62,9 +62,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# FAQ
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_faq.de.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_faq.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.de.txt
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_faq.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.de.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.de.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.de.asciidoc
COMMENT "Building weechat_faq.de.html"
)
add_custom_target(doc-faq-de ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_faq.de.html)
@ -73,9 +73,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# quickstart
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.de.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_quickstart.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.de.txt
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_quickstart.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.de.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.de.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.de.asciidoc
COMMENT "Building weechat_quickstart.de.html"
)
add_custom_target(doc-quickstart-de ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.de.html)
@ -84,9 +84,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# tester's guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.de.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_tester.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.de.txt
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_tester.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.de.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.de.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.de.asciidoc
COMMENT "Building weechat_tester.de.html"
)
add_custom_target(doc-tester-de ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.de.html)

View File

@ -21,14 +21,14 @@
docdir = $(datadir)/doc/$(PACKAGE)
EXTRA_DIST = CMakeLists.txt \
weechat.1.de.txt \
cmdline_options.de.txt \
weechat_user.de.txt \
weechat_scripting.de.txt \
weechat_faq.de.txt \
weechat_quickstart.de.txt \
weechat_tester.de.txt \
$(wildcard autogen/user/*.txt)
weechat.1.de.asciidoc \
cmdline_options.de.asciidoc \
weechat_user.de.asciidoc \
weechat_scripting.de.asciidoc \
weechat_faq.de.asciidoc \
weechat_quickstart.de.asciidoc \
weechat_tester.de.asciidoc \
$(wildcard autogen/user/*.asciidoc)
if MAN
man_targets = weechat.1
@ -47,30 +47,30 @@ endif
all-local: $(man_targets) $(doc_targets)
# man page
weechat.1: weechat.1.de.txt cmdline_options.de.txt
cp -f $(abs_top_srcdir)/doc/de/weechat.1.de.txt .
cp -f $(abs_top_srcdir)/doc/de/cmdline_options.de.txt .
$(A2X) -a revision="WeeChat $(VERSION)" -d manpage -f manpage -L weechat.1.de.txt
weechat.1: weechat.1.de.asciidoc cmdline_options.de.asciidoc
cp -f $(abs_top_srcdir)/doc/de/weechat.1.de.asciidoc .
cp -f $(abs_top_srcdir)/doc/de/cmdline_options.de.asciidoc .
$(A2X) -a revision="WeeChat $(VERSION)" -d manpage -f manpage -L weechat.1.de.asciidoc
# user's guide
weechat_user.de.html: weechat_user.de.txt cmdline_options.de.txt $(wildcard autogen/user/*.txt)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_user.de.html $(abs_top_srcdir)/doc/de/weechat_user.de.txt
weechat_user.de.html: weechat_user.de.asciidoc cmdline_options.de.asciidoc $(wildcard autogen/user/*.asciidoc)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_user.de.html $(abs_top_srcdir)/doc/de/weechat_user.de.asciidoc
# scripting guide
weechat_scripting.de.html: weechat_scripting.de.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_scripting.de.html $(abs_top_srcdir)/doc/de/weechat_scripting.de.txt
weechat_scripting.de.html: weechat_scripting.de.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_scripting.de.html $(abs_top_srcdir)/doc/de/weechat_scripting.de.asciidoc
# FAQ
weechat_faq.de.html: weechat_faq.de.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_faq.de.html $(abs_top_srcdir)/doc/de/weechat_faq.de.txt
weechat_faq.de.html: weechat_faq.de.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_faq.de.html $(abs_top_srcdir)/doc/de/weechat_faq.de.asciidoc
# quickstart
weechat_quickstart.de.html: weechat_quickstart.de.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_quickstart.de.html $(abs_top_srcdir)/doc/de/weechat_quickstart.de.txt
weechat_quickstart.de.html: weechat_quickstart.de.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_quickstart.de.html $(abs_top_srcdir)/doc/de/weechat_quickstart.de.asciidoc
# tester's guide
weechat_tester.de.html: weechat_tester.de.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_tester.de.html $(abs_top_srcdir)/doc/de/weechat_tester.de.txt
weechat_tester.de.html: weechat_tester.de.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_tester.de.html $(abs_top_srcdir)/doc/de/weechat_tester.de.asciidoc
# install man/docs
@ -99,5 +99,5 @@ uninstall-doc:
# clean
clean-local:
-rm -f weechat.1 weechat.1.de.txt cmdline_options.de.txt
-rm -f weechat.1 weechat.1.de.asciidoc cmdline_options.de.asciidoc
-rm -f *.html

View File

@ -25,7 +25,7 @@ verschiedenen Sprachen unterstützt werden.
== OPTIONEN
include::cmdline_options.de.txt[]
include::cmdline_options.de.asciidoc[]
== OPTIONEN von ERWEITERUNGEN

View File

@ -434,7 +434,7 @@ Sollte WeeChat abgestürzt sein, muss der Befehl `bt full` genutzt werden:
Befehlszeile:
include::cmdline_options.de.txt[]
include::cmdline_options.de.asciidoc[]
Um WeeChat zu starten muss folgender Befehl ausgeführt werden:
@ -1680,7 +1680,7 @@ Sektionen:
Optionen:
include::autogen/user/sec_options.txt[]
include::autogen/user/sec_options.asciidoc[]
[[weechat_options]]
==== WeeChat Optionen (weechat.conf)
@ -1715,12 +1715,12 @@ Sektionen:
Optionen:
include::autogen/user/weechat_options.txt[]
include::autogen/user/weechat_options.asciidoc[]
[[weechat_commands]]
==== WeeChat Befehle
include::autogen/user/weechat_commands.txt[]
include::autogen/user/weechat_commands.asciidoc[]
[[plugins]]
== Erweiterungen
@ -1786,7 +1786,7 @@ Die Alias-Erweiterung erlaubt es, für Befehle, sogenannte Kurzbefehle (einen Al
[[alias_commands]]
==== Befehle
include::autogen/user/alias_commands.txt[]
include::autogen/user/alias_commands.asciidoc[]
[[aspell_plugin]]
=== Aspell Erweiterung
@ -1811,12 +1811,12 @@ Sektionen:
Optionen:
include::autogen/user/aspell_options.txt[]
include::autogen/user/aspell_options.asciidoc[]
[[aspell_commands]]
==== Befehle
include::autogen/user/aspell_commands.txt[]
include::autogen/user/aspell_commands.asciidoc[]
[[aspell_speller_options]]
==== Optionen für Rechtschreibprüfung
@ -1919,12 +1919,12 @@ Sektionen:
Optionen:
include::autogen/user/charset_options.txt[]
include::autogen/user/charset_options.asciidoc[]
[[charset_commands]]
==== Befehle
include::autogen/user/charset_commands.txt[]
include::autogen/user/charset_commands.asciidoc[]
[[charset_set]]
==== Zeichensatz auswählen
@ -2005,12 +2005,12 @@ Sections:
Options:
include::autogen/user/exec_options.txt[]
include::autogen/user/exec_options.asciidoc[]
[[exec_commands]]
==== Commands
include::autogen/user/exec_commands.txt[]
include::autogen/user/exec_commands.asciidoc[]
[[fifo_plugin]]
=== Fifo Erweiterung
@ -2120,12 +2120,12 @@ Sektionen:
Optionen:
include::autogen/user/irc_options.txt[]
include::autogen/user/irc_options.asciidoc[]
[[irc_commands]]
==== Befehle
include::autogen/user/irc_commands.txt[]
include::autogen/user/irc_commands.asciidoc[]
[[irc_ssl_certificates]]
==== SSL Zertifikate
@ -2546,12 +2546,12 @@ Sektionen:
Optionen:
include::autogen/user/logger_options.txt[]
include::autogen/user/logger_options.asciidoc[]
[[logger_commands]]
==== Befehle
include::autogen/user/logger_commands.txt[]
include::autogen/user/logger_commands.asciidoc[]
[[logger_log_levels]]
==== Log Levels
@ -2707,12 +2707,12 @@ Sektionen:
Optionen:
include::autogen/user/relay_options.txt[]
include::autogen/user/relay_options.asciidoc[]
[[relay_commands]]
==== Befehle
include::autogen/user/relay_commands.txt[]
include::autogen/user/relay_commands.asciidoc[]
[[relay_password]]
==== Passwort
@ -2859,42 +2859,42 @@ Sektionen:
Optionen:
include::autogen/user/script_options.txt[]
include::autogen/user/script_options.asciidoc[]
[[script_commands]]
==== Skript Befehle
include::autogen/user/script_commands.txt[]
include::autogen/user/script_commands.asciidoc[]
[[python_commands]]
==== Python Befehle
include::autogen/user/python_commands.txt[]
include::autogen/user/python_commands.asciidoc[]
[[perl_commands]]
==== Perl Befehle
include::autogen/user/perl_commands.txt[]
include::autogen/user/perl_commands.asciidoc[]
[[ruby_commands]]
==== Ruby Befehle
include::autogen/user/ruby_commands.txt[]
include::autogen/user/ruby_commands.asciidoc[]
[[lua_commands]]
==== Lua Befehle
include::autogen/user/lua_commands.txt[]
include::autogen/user/lua_commands.asciidoc[]
[[tcl_commands]]
==== Tcl Befehle
include::autogen/user/tcl_commands.txt[]
include::autogen/user/tcl_commands.asciidoc[]
[[guile_commands]]
==== Guile Befehle
include::autogen/user/guile_commands.txt[]
include::autogen/user/guile_commands.asciidoc[]
[[trigger_plugin]]
=== Trigger Erweiterung
@ -2926,12 +2926,12 @@ Sektionen:
Optionen:
include::autogen/user/trigger_options.txt[]
include::autogen/user/trigger_options.asciidoc[]
[[trigger_commands]]
==== Befehle
include::autogen/user/trigger_commands.txt[]
include::autogen/user/trigger_commands.asciidoc[]
[[trigger_anatomy]]
==== Aufbau eines Triggers
@ -3444,12 +3444,12 @@ Sektionen:
Optionen:
include::autogen/user/xfer_options.txt[]
include::autogen/user/xfer_options.asciidoc[]
[[xfer_commands]]
==== Befehle
include::autogen/user/xfer_commands.txt[]
include::autogen/user/xfer_commands.asciidoc[]
[[support]]
== Unterstützung

View File

@ -410,7 +410,7 @@ def docgen_cmd_cb(data, buf, args):
# write commands
for plugin in commands:
filename = directory + '/user/' + plugin + '_commands.txt'
filename = directory + '/user/' + plugin + '_commands.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
for command in sorted(commands[plugin]):
@ -438,7 +438,7 @@ def docgen_cmd_cb(data, buf, args):
# write config options
for config in options:
filename = directory + '/user/' + config + '_options.txt'
filename = directory + '/user/' + config + '_options.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
for section in sorted(options[config]):
@ -502,7 +502,7 @@ def docgen_cmd_cb(data, buf, args):
'options')
# write infos hooked
filename = directory + '/plugin_api/infos.txt'
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')
@ -524,7 +524,7 @@ def docgen_cmd_cb(data, buf, args):
'infos')
# write infos (hashtable) hooked
filename = directory + '/plugin_api/infos_hashtable.txt'
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')
@ -548,7 +548,7 @@ def docgen_cmd_cb(data, buf, args):
'infos_hashtable')
# write infolists hooked
filename = directory + '/plugin_api/infolists.txt'
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')
@ -572,7 +572,7 @@ def docgen_cmd_cb(data, buf, args):
'infolists')
# write hdata hooked
filename = directory + '/plugin_api/hdata.txt'
filename = directory + '/plugin_api/hdata.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
for plugin in sorted(hdata):
@ -600,7 +600,7 @@ def docgen_cmd_cb(data, buf, args):
'hdata')
# write completions hooked
filename = directory + '/plugin_api/completions.txt'
filename = directory + '/plugin_api/completions.asciidoc'
tmpfilename = filename + '.tmp'
_file = open(tmpfilename, 'w')
_file.write('[width="65%",cols="^1,^2,8",options="header"]\n')
@ -620,7 +620,7 @@ def docgen_cmd_cb(data, buf, args):
'completions')
# write url options
filename = directory + '/plugin_api/url_options.txt'
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')

View File

@ -21,12 +21,12 @@ if(ENABLE_MAN)
# man page
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat.1
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.txt ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.txt ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${A2X_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -d manpage -f manpage -L ${CMAKE_CURRENT_BINARY_DIR}/weechat.1.en.txt
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.asciidoc ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.asciidoc ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${A2X_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -d manpage -f manpage -L ${CMAKE_CURRENT_BINARY_DIR}/weechat.1.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.asciidoc
COMMENT "Building weechat.1 (en)"
)
add_custom_target(doc-man-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat.1)
@ -38,11 +38,11 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# user's guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.en.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_user.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.en.txt
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_user.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.en.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.asciidoc
COMMENT "Building weechat_user.en.html"
)
add_custom_target(doc-user-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.en.html)
@ -51,10 +51,10 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# plugin API reference
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_plugin_api.en.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_plugin_api.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_plugin_api.en.txt
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_plugin_api.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_plugin_api.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_plugin_api.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/autogen/plugin_api/*.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_plugin_api.en.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/autogen/plugin_api/*.asciidoc
COMMENT "Building weechat_plugin_api.en.html"
)
add_custom_target(doc-plugin-api-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_plugin_api.en.html)
@ -63,9 +63,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# scripting guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_scripting.en.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_scripting.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.en.txt
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_scripting.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.en.asciidoc
COMMENT "Building weechat_scripting.en.html"
)
add_custom_target(doc-scripting-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_scripting.en.html)
@ -74,9 +74,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# FAQ
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_faq.en.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_faq.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.en.txt
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_faq.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.en.asciidoc
COMMENT "Building weechat_faq.en.html"
)
add_custom_target(doc-faq-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_faq.en.html)
@ -85,9 +85,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# quickstart
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.en.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_quickstart.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.en.txt
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_quickstart.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.en.asciidoc
COMMENT "Building weechat_quickstart.en.html"
)
add_custom_target(doc-quickstart-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.en.html)
@ -96,9 +96,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# tester's guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.en.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_tester.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.en.txt
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_tester.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.en.asciidoc
COMMENT "Building weechat_tester.en.html"
)
add_custom_target(doc-tester-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.en.html)
@ -107,9 +107,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# relay protocol
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_protocol.en.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_relay_protocol.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_relay_protocol.en.txt
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_relay_protocol.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_relay_protocol.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_relay_protocol.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_relay_protocol.en.asciidoc
COMMENT "Building weechat_relay_protocol.en.html"
)
add_custom_target(doc-relay-protocol-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_protocol.en.html)
@ -118,9 +118,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# developer's guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_dev.en.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.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_dev.en.txt
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.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_dev.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_dev.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_dev.en.asciidoc
COMMENT "Building weechat_dev.en.html"
)
add_custom_target(doc-dev-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_dev.en.html)

View File

@ -21,18 +21,18 @@
docdir = $(datadir)/doc/$(PACKAGE)
EXTRA_DIST = CMakeLists.txt \
weechat.1.en.txt \
cmdline_options.en.txt \
weechat_user.en.txt \
weechat_plugin_api.en.txt \
weechat_scripting.en.txt \
weechat_faq.en.txt \
weechat_quickstart.en.txt \
weechat_tester.en.txt \
weechat_relay_protocol.en.txt \
weechat_dev.en.txt \
$(wildcard autogen/user/*.txt) \
$(wildcard autogen/plugin_api/*.txt)
weechat.1.en.asciidoc \
cmdline_options.en.asciidoc \
weechat_user.en.asciidoc \
weechat_plugin_api.en.asciidoc \
weechat_scripting.en.asciidoc \
weechat_faq.en.asciidoc \
weechat_quickstart.en.asciidoc \
weechat_tester.en.asciidoc \
weechat_relay_protocol.en.asciidoc \
weechat_dev.en.asciidoc \
$(wildcard autogen/user/*.asciidoc) \
$(wildcard autogen/plugin_api/*.asciidoc)
if MAN
man_targets = weechat.1
@ -54,42 +54,42 @@ endif
all-local: $(man_targets) $(doc_targets)
# man page
weechat.1: weechat.1.en.txt cmdline_options.en.txt
cp -f $(abs_top_srcdir)/doc/en/weechat.1.en.txt .
cp -f $(abs_top_srcdir)/doc/en/cmdline_options.en.txt .
$(A2X) -a revision="WeeChat $(VERSION)" -d manpage -f manpage -L weechat.1.en.txt
weechat.1: weechat.1.en.asciidoc cmdline_options.en.asciidoc
cp -f $(abs_top_srcdir)/doc/en/weechat.1.en.asciidoc .
cp -f $(abs_top_srcdir)/doc/en/cmdline_options.en.asciidoc .
$(A2X) -a revision="WeeChat $(VERSION)" -d manpage -f manpage -L weechat.1.en.asciidoc
# user's guide
weechat_user.en.html: weechat_user.en.txt cmdline_options.en.txt $(wildcard autogen/user/*.txt)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_user.en.html $(abs_top_srcdir)/doc/en/weechat_user.en.txt
weechat_user.en.html: weechat_user.en.asciidoc cmdline_options.en.asciidoc $(wildcard autogen/user/*.asciidoc)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_user.en.html $(abs_top_srcdir)/doc/en/weechat_user.en.asciidoc
# plugin API reference
weechat_plugin_api.en.html: weechat_plugin_api.en.txt $(wildcard autogen/plugin_api/*.txt)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_plugin_api.en.html $(abs_top_srcdir)/doc/en/weechat_plugin_api.en.txt
weechat_plugin_api.en.html: weechat_plugin_api.en.asciidoc $(wildcard autogen/plugin_api/*.asciidoc)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_plugin_api.en.html $(abs_top_srcdir)/doc/en/weechat_plugin_api.en.asciidoc
# scripting guide
weechat_scripting.en.html: weechat_scripting.en.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_scripting.en.html $(abs_top_srcdir)/doc/en/weechat_scripting.en.txt
weechat_scripting.en.html: weechat_scripting.en.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_scripting.en.html $(abs_top_srcdir)/doc/en/weechat_scripting.en.asciidoc
# FAQ
weechat_faq.en.html: weechat_faq.en.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_faq.en.html $(abs_top_srcdir)/doc/en/weechat_faq.en.txt
weechat_faq.en.html: weechat_faq.en.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_faq.en.html $(abs_top_srcdir)/doc/en/weechat_faq.en.asciidoc
# quickstart
weechat_quickstart.en.html: weechat_quickstart.en.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_quickstart.en.html $(abs_top_srcdir)/doc/en/weechat_quickstart.en.txt
weechat_quickstart.en.html: weechat_quickstart.en.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_quickstart.en.html $(abs_top_srcdir)/doc/en/weechat_quickstart.en.asciidoc
# tester's guide
weechat_tester.en.html: weechat_tester.en.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_tester.en.html $(abs_top_srcdir)/doc/en/weechat_tester.en.txt
weechat_tester.en.html: weechat_tester.en.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_tester.en.html $(abs_top_srcdir)/doc/en/weechat_tester.en.asciidoc
# relay protocol
weechat_relay_protocol.en.html: weechat_relay_protocol.en.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_relay_protocol.en.html $(abs_top_srcdir)/doc/en/weechat_relay_protocol.en.txt
weechat_relay_protocol.en.html: weechat_relay_protocol.en.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_relay_protocol.en.html $(abs_top_srcdir)/doc/en/weechat_relay_protocol.en.asciidoc
# developer's guide
weechat_dev.en.html: weechat_dev.en.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_dev.en.html $(abs_top_srcdir)/doc/en/weechat_dev.en.txt
weechat_dev.en.html: weechat_dev.en.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_dev.en.html $(abs_top_srcdir)/doc/en/weechat_dev.en.asciidoc
# install man/docs
@ -118,5 +118,5 @@ uninstall-doc:
# clean
clean-local:
-rm -f weechat.1 weechat.1.en.txt cmdline_options.en.txt
-rm -f weechat.1 weechat.1.en.asciidoc cmdline_options.en.asciidoc
-rm -f *.html

View File

@ -24,7 +24,7 @@ extensible with C and scripts written in several languages.
== OPTIONS
include::cmdline_options.en.txt[]
include::cmdline_options.en.asciidoc[]
== PLUGIN OPTIONS

View File

@ -288,25 +288,25 @@ Documentation files:
[width="100%",cols="1v,5",options="header"]
|===
| Path/file | Description
| doc/ | Documentation
| asciidoc.conf | Asciidoc configuration file (some macros)
| 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, ...)
| weechat.1.XX.txt | Man page (`man weechat`)
| weechat_quickstart.XX.txt | Quickstart guide
| weechat_user.XX.txt | User's guide
| weechat_faq.XX.txt | FAQ
| weechat_plugin_api.XX.txt | Plugin API reference
| weechat_scripting.XX.txt | Scripting guide
| weechat_tester.XX.txt | Tester's guide
| weechat_dev.XX.txt | Developer's guide (this document)
| weechat_relay_protocol.XX.txt | Relay protocol (for remote interfaces)
| cmdline_options.XX.txt | Command-line options (file included in man page and 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!)
| Path/file | Description
| doc/ | Documentation
| asciidoc.conf | Asciidoc configuration file (some macros)
| 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, ...)
| weechat.1.XX.asciidoc | Man page (`man weechat`)
| weechat_quickstart.XX.asciidoc | Quickstart guide
| weechat_user.XX.asciidoc | User's guide
| weechat_faq.XX.asciidoc | FAQ
| weechat_plugin_api.XX.asciidoc | Plugin API reference
| 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)
| 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/'

View File

@ -6739,7 +6739,8 @@ Arguments:
* 'callback_data': pointer given to callback when it is called by WeeChat
Default completion codes are:
include::autogen/plugin_api/completions.txt[]
include::autogen/plugin_api/completions.asciidoc[]
Special codes:
@ -7238,7 +7239,7 @@ available:
For command "url:...", following options are available (see
`man curl_easy_setopt` for a description of each option):
include::autogen/plugin_api/url_options.txt[]
include::autogen/plugin_api/url_options.asciidoc[]
[NOTE]
^(1)^ When constants are available they must be used as value for option. For
@ -12490,7 +12491,7 @@ Return value:
Infos:
include::autogen/plugin_api/infos.txt[]
include::autogen/plugin_api/infos.asciidoc[]
C example:
@ -12542,7 +12543,7 @@ Return value:
Infos:
include::autogen/plugin_api/infos_hashtable.txt[]
include::autogen/plugin_api/infos_hashtable.asciidoc[]
C example:
@ -12920,7 +12921,7 @@ Return value:
Infolists:
include::autogen/plugin_api/infolists.txt[]
include::autogen/plugin_api/infolists.asciidoc[]
C example:
@ -13635,7 +13636,7 @@ Return value:
List of hdata:
include::autogen/plugin_api/hdata.txt[]
include::autogen/plugin_api/hdata.asciidoc[]
C example:

View File

@ -433,7 +433,7 @@ Then like for a crash, use command `bt full`:
Command line arguments:
include::cmdline_options.en.txt[]
include::cmdline_options.en.asciidoc[]
To start WeeChat, issue this command:
@ -1646,7 +1646,7 @@ Sections:
Options:
include::autogen/user/sec_options.txt[]
include::autogen/user/sec_options.asciidoc[]
[[weechat_options]]
==== WeeChat options (weechat.conf)
@ -1681,12 +1681,12 @@ Sections:
Options:
include::autogen/user/weechat_options.txt[]
include::autogen/user/weechat_options.asciidoc[]
[[weechat_commands]]
==== WeeChat commands
include::autogen/user/weechat_commands.txt[]
include::autogen/user/weechat_commands.asciidoc[]
[[plugins]]
== Plugins
@ -1752,7 +1752,7 @@ plugins).
[[alias_commands]]
==== Commands
include::autogen/user/alias_commands.txt[]
include::autogen/user/alias_commands.asciidoc[]
[[aspell_plugin]]
=== Aspell plugin
@ -1777,12 +1777,12 @@ Sections:
Options:
include::autogen/user/aspell_options.txt[]
include::autogen/user/aspell_options.asciidoc[]
[[aspell_commands]]
==== Commands
include::autogen/user/aspell_commands.txt[]
include::autogen/user/aspell_commands.asciidoc[]
[[aspell_speller_options]]
==== Speller options
@ -1881,12 +1881,12 @@ Sections:
Options:
include::autogen/user/charset_options.txt[]
include::autogen/user/charset_options.asciidoc[]
[[charset_commands]]
==== Commands
include::autogen/user/charset_commands.txt[]
include::autogen/user/charset_commands.asciidoc[]
[[charset_set]]
==== Set charset
@ -1963,12 +1963,12 @@ Sections:
Options:
include::autogen/user/exec_options.txt[]
include::autogen/user/exec_options.asciidoc[]
[[exec_commands]]
==== Commands
include::autogen/user/exec_commands.txt[]
include::autogen/user/exec_commands.asciidoc[]
[[fifo_plugin]]
=== Fifo plugin
@ -2078,12 +2078,12 @@ Sections:
Options:
include::autogen/user/irc_options.txt[]
include::autogen/user/irc_options.asciidoc[]
[[irc_commands]]
==== Commands
include::autogen/user/irc_commands.txt[]
include::autogen/user/irc_commands.asciidoc[]
[[irc_ssl_certificates]]
==== SSL certificates
@ -2496,12 +2496,12 @@ Sections:
Options:
include::autogen/user/logger_options.txt[]
include::autogen/user/logger_options.asciidoc[]
[[logger_commands]]
==== Commands
include::autogen/user/logger_commands.txt[]
include::autogen/user/logger_commands.asciidoc[]
[[logger_log_levels]]
==== Log levels
@ -2651,12 +2651,12 @@ Sections:
Options:
include::autogen/user/relay_options.txt[]
include::autogen/user/relay_options.asciidoc[]
[[relay_commands]]
==== Commands
include::autogen/user/relay_commands.txt[]
include::autogen/user/relay_commands.asciidoc[]
[[relay_password]]
==== Password
@ -2793,42 +2793,42 @@ Sections:
Options:
include::autogen/user/script_options.txt[]
include::autogen/user/script_options.asciidoc[]
[[script_commands]]
==== Script commands
include::autogen/user/script_commands.txt[]
include::autogen/user/script_commands.asciidoc[]
[[python_commands]]
==== Python commands
include::autogen/user/python_commands.txt[]
include::autogen/user/python_commands.asciidoc[]
[[perl_commands]]
==== Perl commands
include::autogen/user/perl_commands.txt[]
include::autogen/user/perl_commands.asciidoc[]
[[ruby_commands]]
==== Ruby commands
include::autogen/user/ruby_commands.txt[]
include::autogen/user/ruby_commands.asciidoc[]
[[lua_commands]]
==== Lua commands
include::autogen/user/lua_commands.txt[]
include::autogen/user/lua_commands.asciidoc[]
[[tcl_commands]]
==== Tcl commands
include::autogen/user/tcl_commands.txt[]
include::autogen/user/tcl_commands.asciidoc[]
[[guile_commands]]
==== Guile commands
include::autogen/user/guile_commands.txt[]
include::autogen/user/guile_commands.asciidoc[]
[[trigger_plugin]]
=== Trigger plugin
@ -2859,12 +2859,12 @@ Sections:
Options:
include::autogen/user/trigger_options.txt[]
include::autogen/user/trigger_options.asciidoc[]
[[trigger_commands]]
==== Commands
include::autogen/user/trigger_commands.txt[]
include::autogen/user/trigger_commands.asciidoc[]
[[trigger_anatomy]]
==== Anatomy of a trigger
@ -3370,12 +3370,12 @@ Sections:
Options:
include::autogen/user/xfer_options.txt[]
include::autogen/user/xfer_options.asciidoc[]
[[xfer_commands]]
==== Commands
include::autogen/user/xfer_commands.txt[]
include::autogen/user/xfer_commands.asciidoc[]
[[support]]
== Support

View File

@ -22,9 +22,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# quickstart
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.es.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_quickstart.es.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.es.txt
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_quickstart.es.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.es.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.es.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.es.asciidoc
COMMENT "Building weechat_quickstart.es.html"
)
add_custom_target(doc-quickstart-es ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.es.html)

View File

@ -20,7 +20,7 @@
docdir = $(datadir)/doc/$(PACKAGE)
EXTRA_DIST = CMakeLists.txt \
weechat_quickstart.es.txt
weechat_quickstart.es.asciidoc
if MAN
man_targets =
@ -35,8 +35,8 @@ endif
all-local: $(man_targets) $(doc_targets)
# quickstart
weechat_quickstart.es.html: weechat_quickstart.es.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_quickstart.es.html $(abs_top_srcdir)/doc/es/weechat_quickstart.es.txt
weechat_quickstart.es.html: weechat_quickstart.es.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_quickstart.es.html $(abs_top_srcdir)/doc/es/weechat_quickstart.es.asciidoc
# install man/docs

View File

@ -21,12 +21,12 @@ if(ENABLE_MAN)
# man page
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat.1
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.fr.txt ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.fr.txt ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${A2X_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -d manpage -f manpage -L ${CMAKE_CURRENT_BINARY_DIR}/weechat.1.fr.txt
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.fr.asciidoc ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.fr.asciidoc ${CMAKE_CURRENT_BINARY_DIR}/
COMMAND ${A2X_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -d manpage -f manpage -L ${CMAKE_CURRENT_BINARY_DIR}/weechat.1.fr.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.fr.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.fr.asciidoc
COMMENT "Building weechat.1 (fr)"
)
add_custom_target(doc-man-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat.1)
@ -38,11 +38,11 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# user's guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.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_user.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.fr.txt
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_user.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.fr.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.fr.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.fr.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.asciidoc
COMMENT "Building weechat_user.fr.html"
)
add_custom_target(doc-user-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.fr.html)
@ -51,10 +51,10 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# plugin API reference
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_plugin_api.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_plugin_api.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_plugin_api.fr.txt
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_plugin_api.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_plugin_api.fr.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_plugin_api.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/autogen/plugin_api/*.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_plugin_api.fr.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/autogen/plugin_api/*.asciidoc
COMMENT "Building weechat_plugin_api.fr.html"
)
add_custom_target(doc-plugin-api-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_plugin_api.fr.html)
@ -63,9 +63,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# scripting guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_scripting.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_scripting.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.fr.txt
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_scripting.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.fr.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_scripting.fr.asciidoc
COMMENT "Building weechat_scripting.fr.html"
)
add_custom_target(doc-scripting-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_scripting.fr.html)
@ -74,9 +74,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# FAQ
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_faq.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_faq.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.fr.txt
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_faq.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.fr.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_faq.fr.asciidoc
COMMENT "Building weechat_faq.fr.html"
)
add_custom_target(doc-faq-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_faq.fr.html)
@ -85,9 +85,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# quickstart
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.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_quickstart.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.fr.txt
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_quickstart.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.fr.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_quickstart.fr.asciidoc
COMMENT "Building weechat_quickstart.fr.html"
)
add_custom_target(doc-quickstart-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_quickstart.fr.html)
@ -96,9 +96,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# tester's guide
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.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_tester.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.fr.txt
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_tester.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.fr.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_tester.fr.asciidoc
COMMENT "Building weechat_tester.fr.html"
)
add_custom_target(doc-tester-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_tester.fr.html)
@ -107,9 +107,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# relay protocol
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_protocol.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_relay_protocol.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_relay_protocol.fr.txt
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_relay_protocol.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_relay_protocol.fr.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_relay_protocol.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_relay_protocol.fr.asciidoc
COMMENT "Building weechat_relay_protocol.fr.html"
)
add_custom_target(doc-relay-protocol-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_relay_protocol.fr.html)
@ -118,9 +118,9 @@ if(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
# 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
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.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat_dev.fr.txt
${CMAKE_CURRENT_SOURCE_DIR}/weechat_dev.fr.asciidoc
COMMENT "Building weechat_dev.fr.html"
)
add_custom_target(doc-dev-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat_dev.fr.html)

View File

@ -21,18 +21,18 @@
docdir = $(datadir)/doc/$(PACKAGE)
EXTRA_DIST = CMakeLists.txt \
weechat.1.fr.txt \
cmdline_options.fr.txt \
weechat_user.fr.txt \
weechat_plugin_api.fr.txt \
weechat_scripting.fr.txt \
weechat_faq.fr.txt \
weechat_quickstart.fr.txt \
weechat_tester.fr.txt \
weechat_relay_protocol.fr.txt \
weechat_dev.fr.txt \
$(wildcard autogen/user/*.txt) \
$(wildcard autogen/plugin_api/*.txt)
weechat.1.fr.asciidoc \
cmdline_options.fr.asciidoc \
weechat_user.fr.asciidoc \
weechat_plugin_api.fr.asciidoc \
weechat_scripting.fr.asciidoc \
weechat_faq.fr.asciidoc \
weechat_quickstart.fr.asciidoc \
weechat_tester.fr.asciidoc \
weechat_relay_protocol.fr.asciidoc \
weechat_dev.fr.asciidoc \
$(wildcard autogen/user/*.asciidoc) \
$(wildcard autogen/plugin_api/*.asciidoc)
if MAN
man_targets = weechat.1
@ -54,42 +54,42 @@ endif
all-local: $(man_targets) $(doc_targets)
# man page
weechat.1: weechat.1.fr.txt cmdline_options.fr.txt
cp -f $(abs_top_srcdir)/doc/fr/weechat.1.fr.txt .
cp -f $(abs_top_srcdir)/doc/fr/cmdline_options.fr.txt .
$(A2X) -a revision="WeeChat $(VERSION)" -d manpage -f manpage -L weechat.1.fr.txt
weechat.1: weechat.1.fr.asciidoc cmdline_options.fr.asciidoc
cp -f $(abs_top_srcdir)/doc/fr/weechat.1.fr.asciidoc .
cp -f $(abs_top_srcdir)/doc/fr/cmdline_options.fr.asciidoc .
$(A2X) -a revision="WeeChat $(VERSION)" -d manpage -f manpage -L weechat.1.fr.asciidoc
# user's guide
weechat_user.fr.html: weechat_user.fr.txt cmdline_options.fr.txt $(wildcard autogen/user/*.txt)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_user.fr.html $(abs_top_srcdir)/doc/fr/weechat_user.fr.txt
weechat_user.fr.html: weechat_user.fr.asciidoc cmdline_options.fr.asciidoc $(wildcard autogen/user/*.asciidoc)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_user.fr.html $(abs_top_srcdir)/doc/fr/weechat_user.fr.asciidoc
# plugin API reference
weechat_plugin_api.fr.html: weechat_plugin_api.fr.txt $(wildcard autogen/plugin_api/*.txt)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_plugin_api.fr.html $(abs_top_srcdir)/doc/fr/weechat_plugin_api.fr.txt
weechat_plugin_api.fr.html: weechat_plugin_api.fr.asciidoc $(wildcard autogen/plugin_api/*.asciidoc)
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_plugin_api.fr.html $(abs_top_srcdir)/doc/fr/weechat_plugin_api.fr.asciidoc
# scripting guide
weechat_scripting.fr.html: weechat_scripting.fr.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_scripting.fr.html $(abs_top_srcdir)/doc/fr/weechat_scripting.fr.txt
weechat_scripting.fr.html: weechat_scripting.fr.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_scripting.fr.html $(abs_top_srcdir)/doc/fr/weechat_scripting.fr.asciidoc
# FAQ
weechat_faq.fr.html: weechat_faq.fr.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_faq.fr.html $(abs_top_srcdir)/doc/fr/weechat_faq.fr.txt
weechat_faq.fr.html: weechat_faq.fr.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_faq.fr.html $(abs_top_srcdir)/doc/fr/weechat_faq.fr.asciidoc
# quickstart
weechat_quickstart.fr.html: weechat_quickstart.fr.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_quickstart.fr.html $(abs_top_srcdir)/doc/fr/weechat_quickstart.fr.txt
weechat_quickstart.fr.html: weechat_quickstart.fr.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_quickstart.fr.html $(abs_top_srcdir)/doc/fr/weechat_quickstart.fr.asciidoc
# tester's guide
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
weechat_tester.fr.html: weechat_tester.fr.asciidoc
$(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.asciidoc
# relay protocol
weechat_relay_protocol.fr.html: weechat_relay_protocol.fr.txt
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_relay_protocol.fr.html $(abs_top_srcdir)/doc/fr/weechat_relay_protocol.fr.txt
weechat_relay_protocol.fr.html: weechat_relay_protocol.fr.asciidoc
$(ASCIIDOC) -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_relay_protocol.fr.html $(abs_top_srcdir)/doc/fr/weechat_relay_protocol.fr.asciidoc
# 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
weechat_dev.fr.html: weechat_dev.fr.asciidoc
$(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.asciidoc
# install man/docs
@ -118,5 +118,5 @@ uninstall-doc:
# clean
clean-local:
-rm -f weechat.1 weechat.1.fr.txt cmdline_options.fr.txt
-rm -f weechat.1 weechat.1.fr.asciidoc cmdline_options.fr.asciidoc
-rm -f *.html

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