diff options
| author | 2014-11-21 14:34:32 +0000 | |
|---|---|---|
| committer | 2014-11-21 14:34:32 +0000 | |
| commit | 43e0468a233a49b1010f34c5ce888204fa4e9416 (patch) | |
| tree | b1f97b1b9fdfc72677b935d34e26c70fa7030feb /doc | |
| parent | Trivial typo (diff) | |
| download | KVIrc-43e0468a233a49b1010f34c5ce888204fa4e9416.tar.gz KVIrc-43e0468a233a49b1010f34c5ce888204fa4e9416.tar.bz2 KVIrc-43e0468a233a49b1010f34c5ce888204fa4e9416.zip | |
- massive trailing whitespace cleanup (yes, one of these "you can hate me for that" commits)
- apply patch by d00p: show the correct protocol version instead of just "SSLv3/TLSv1", thanks!
- fix compilation on qt 5.4 on windows
git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@6398 17fca916-40b9-46aa-a4ea-0a15b648b75c
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CMakeLists.txt | 2 | ||||
| -rw-r--r-- | doc/COPYING | 2 | ||||
| -rw-r--r-- | doc/INSTALL | 60 | ||||
| -rw-r--r-- | doc/INSTALL-MacOS.txt | 8 | ||||
| -rw-r--r-- | doc/INSTALL-Win32.txt | 40 | ||||
| -rw-r--r-- | doc/LICENSE-GPLV2 | 25 | ||||
| -rw-r--r-- | doc/LICENSE-GPLV3 | 18 | ||||
| -rw-r--r-- | doc/LICENSE-OPENSSL | 2 | ||||
| -rw-r--r-- | doc/README | 2 | ||||
| -rw-r--r-- | doc/TODO-docs | 4 | ||||
| -rw-r--r-- | doc/addon.howto.txt | 30 | ||||
| -rw-r--r-- | doc/hackers.guide.txt | 6 | ||||
| -rw-r--r-- | doc/translations.howto.txt | 2 |
13 files changed, 100 insertions, 101 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 8e2acc300..ac3f06c17 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -64,7 +64,7 @@ if(PERL_FOUND) COMMENT "Generating user documentation..." COMMAND ${PERL_EXECUTABLE} ${PROJECT_SOURCE_DIR}/admin/gendoc.pl -v ${USERDOCS_VERSION} ${CMAKE_CURRENT_BINARY_DIR}/help/en/ ${PROJECT_SOURCE_DIR}/data/doctemplates/ ${PROJECT_SOURCE_DIR}/src/ ) - install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/help/ DESTINATION ${CMAKE_INSTALL_PREFIX}/help) + install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/help/ DESTINATION ${CMAKE_INSTALL_PREFIX}/help) add_custom_target( docs COMMENT "Generating user documentation..." diff --git a/doc/COPYING b/doc/COPYING index 7fd8dc85e..29d5818fe 100644 --- a/doc/COPYING +++ b/doc/COPYING @@ -1,7 +1,7 @@ This is the KVIrc Irc Client license. It is based on the GNU General Public License either version 2, or -(at your option) any later version. The full text of versions 2 and 3 of +(at your option) any later version. The full text of versions 2 and 3 of the GPL can be found respectively in the files LICENSE-GPLV2 and LICENSE-GPLV3. KVIrc License contains all the GPL terms and conditions and adds a special exception (see "OpenSSL Exception" below) to the distribution limitations. diff --git a/doc/INSTALL b/doc/INSTALL index ba51efdb4..a3fb66f05 100644 --- a/doc/INSTALL +++ b/doc/INSTALL @@ -85,18 +85,18 @@ General notes for the installation of the 4.2 release of KVIrc QMake version 2.01a Using Qt version 4.7.2 in /usr/lib64/qt/lib - If you have multiple versions of Qt4 installed in your system and want to - use a specific version, exporting QTDIR won't suffice. Since the CMake + If you have multiple versions of Qt4 installed in your system and want to + use a specific version, exporting QTDIR won't suffice. Since the CMake module searching for Qt4 uses qmake itself to determine the Qt4 library dir, - you can set your $PATH variable to have CMake using + you can set your $PATH variable to have CMake using your preferred qmake version: # PATH=/opt/qt4.7/bin/:$PATH cmake .. - Please note that compiling with KDE4 support enabled will force KVIrc to - link against the Qt4 version that KDE4 is using. This may lead to problems + Please note that compiling with KDE4 support enabled will force KVIrc to + link against the Qt4 version that KDE4 is using. This may lead to problems in linking. Disabling KDE4 support is the only known solution at the moment. - Note also that in this case you'll need to override the Qt libraries used + Note also that in this case you'll need to override the Qt libraries used when running KVIrc: # LD_LIBRARY_PATH=/opt/qt4.7/lib/ kvirc4 @@ -119,11 +119,11 @@ General notes for the installation of the 4.2 release of KVIrc # C++ compiler # - You need a decent C++ compiler. Usually under linux it is GCC from GNU + You need a decent C++ compiler. Usually under linux it is GCC from GNU tools. It is preferred to use GCC 4.x, but GCC 3.4.6 works as well. Older version *might* work. - ICC is *neither* officially supported *nor* tested. Reports are welcome, + ICC is *neither* officially supported *nor* tested. Reports are welcome, though. To check your GCC version, just run: @@ -133,12 +133,12 @@ General notes for the installation of the 4.2 release of KVIrc Reading specs from /usr/lib64/gcc/x86_64-slackware-linux/4.3.3/specs Target: x86_64-slackware-linux - Configured with: ../gcc-4.3.3/configure --prefix=/usr --libdir=/usr/lib64 ---enable-shared --enable-bootstrap ---enable-languages=ada,c,c++,fortran,java,objc --enable-threads=posix ---enable-checking=release --with-system-zlib --disable-libunwind-exceptions ---enable-__cxa_atexit --enable-libssp --with-gnu-ld --verbose ---disable-multilib --target=x86_64-slackware-linux + Configured with: ../gcc-4.3.3/configure --prefix=/usr --libdir=/usr/lib64 +--enable-shared --enable-bootstrap +--enable-languages=ada,c,c++,fortran,java,objc --enable-threads=posix +--enable-checking=release --with-system-zlib --disable-libunwind-exceptions +--enable-__cxa_atexit --enable-libssp --with-gnu-ld --verbose +--disable-multilib --target=x86_64-slackware-linux --build=x86_64-slackware-linux --host=x86_64-slackware-linux Thread model: posix gcc version 4.3.3 (GCC) @@ -213,8 +213,8 @@ General notes for the installation of the 4.2 release of KVIrc If you want PERL SCRIPTING support to be compiled, you need a working perl installation. Your libperl.so MUST be compiled with the MULTIPLICITY option. You can check it with perl -V - The way external software can embed perl has changed between perl version - 5.8 and 5.10. KVIrc should play nice with perl as of version 5.004 and + The way external software can embed perl has changed between perl version + 5.8 and 5.10. KVIrc should play nice with perl as of version 5.004 and higher, but 5.10 is strongly recommended, since future updates can break backwards compatibility. @@ -223,7 +223,7 @@ General notes for the installation of the 4.2 release of KVIrc # OpenSSL (Optional) # - If you want the secure socket layer (SSL) support to be compiled, you need + If you want the secure socket layer (SSL) support to be compiled, you need the OpenSSL library and headers. (libssl.so and openssl/ssl.h) - (Optional) If you want DCC VOICE to support the gsm codec, @@ -281,8 +281,8 @@ General notes for the installation of the 4.2 release of KVIrc # cd release # cmake [your options] .. - In this way you have just created an out-of-source environment which is - clean at the beginning and can be changed afterwards, as well as a clean + In this way you have just created an out-of-source environment which is + clean at the beginning and can be changed afterwards, as well as a clean source directory. Note that the final dots are required or CMake will NOT create the right environment. @@ -308,23 +308,23 @@ General notes for the installation of the 4.2 release of KVIrc Useful for reporting bugs. -DWANT_STRIP (default: OFF) - Available only if debug is disabled, this flag disables objects + Available only if debug is disabled, this flag disables objects stripping before installation. - (Object stripping discards symbols from object files, lowering their - size on disk, at the expense of more complicated or rather impossible + (Object stripping discards symbols from object files, lowering their + size on disk, at the expense of more complicated or rather impossible debugging.) -DWANT_VERBOSE (default: OFF) Generate verbose output when compiling. - (Note: this will be deactivated when using a job setting higher than 1 - with gmake. I.e., make -j2 will *not* show any verbose compilation + (Note: this will be deactivated when using a job setting higher than 1 + with gmake. I.e., make -j2 will *not* show any verbose compilation output.) -DCMAKE_INSTALL_PREFIX=PATH (default: a system-dependant directory) This will install all stuff under PATH directory. -DLIB_SUFFIX=SUFFIX (default: empty) - This will install libkvilib and KVIrc modules to + This will install libkvilib and KVIrc modules to ${CMAKE_INSTALL_PREFIX}/lib${LIB_SUFFIX} directory. It defaults to an empty suffix. Mainly used for 64bit distros. @@ -337,14 +337,14 @@ General notes for the installation of the 4.2 release of KVIrc different KVIrc versions can co-exist on the same system. -DWANT_ENV_FLAGS (default: OFF) - When enabled, KVIrc install rules won't try to figure out and set + When enabled, KVIrc install rules won't try to figure out and set CMAKE_C(XX)_FLAGS. Instead, it will let CMake use the ones taken from environment variables. Activating this flag will override the value of -DWANT_DEBUG. -DCMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT (default: OFF, not cached) This will re-initialize the installation path to a good default. - Following compilations should use the correct path value cached by + Following compilations should use the correct path value cached by CMake. This flag is useful to solve MacOS X install problems. @@ -489,10 +489,10 @@ General notes for the installation of the 4.2 release of KVIrc Most probably you will not need to enable this flag. -DMANUAL_REVISION (default: empty) - Manually set a revision number if subversion is not found on your + Manually set a revision number if subversion is not found on your system. This is useful mostly on windows. - Please do not specify useless information here, as it will make + Please do not specify useless information here, as it will make debugging harder and you won't profit from it. -DWANT_PIZZA (default: OFF) @@ -551,7 +551,7 @@ General notes for the installation of the 4.2 release of KVIrc # ldconfig with super-user privileges. - + If you have decided to use the KDE support the installation might have placed all these files in your $KDEDIR tree instead of /usr/local. In this case you should be OK since KDE requires its library dir to be diff --git a/doc/INSTALL-MacOS.txt b/doc/INSTALL-MacOS.txt index 1099c1ecc..b7b489fac 100644 --- a/doc/INSTALL-MacOS.txt +++ b/doc/INSTALL-MacOS.txt @@ -3,11 +3,11 @@ Last updated by Fabio Bas, 2012.04.07 ######################### This document contains step-by-step instructions for compiling KVIrc4 from SVN -sources on a Mac OS X system. Due to changed prerequisites and compilation +sources on a Mac OS X system. Due to changed prerequisites and compilation system, this compilation howto does not apply to older versions of KVirc. -All this has worked fine several times for me. I've been using KVirc on Mac +All this has worked fine several times for me. I've been using KVirc on Mac since May 2004 without any crashes & faults. Only the sound interface does not work, but I have no use for it within an IRC client. However, I cannot guarantee that this instructions will work for you as they do for me and I'm @@ -17,7 +17,7 @@ them. You should always understand what you are doing! IMPORTANT: Installing KVIrc "the usual way" like on other popular Unix-like OSes with files spread across several directories does not work and is -unsupported. The provided compilation system builds a typical "Bundle" for +unsupported. The provided compilation system builds a typical "Bundle" for Mac OS X. A bundle is "just" a special directory structure on Mac systems which contains the application binary, dependant libraries, plugins, modules and other resources. @@ -65,7 +65,7 @@ Open a terminal window 4. CMake Get the latest version of the automatic build system from http://www.cmake.org. -Again it's up to you if you want the easily installable binary package or read +Again it's up to you if you want the easily installable binary package or read the documentation and compile by yourself. Please note that when using XCode >= 4.3 you need at least cmake 2.8.8. diff --git a/doc/INSTALL-Win32.txt b/doc/INSTALL-Win32.txt index 3ada9b15f..7929237c6 100644 --- a/doc/INSTALL-Win32.txt +++ b/doc/INSTALL-Win32.txt @@ -27,7 +27,7 @@ Prerequisites Differences in its network stack and the difficulty to retrieve packages of kvirc dependencies still working on win2000 make compiling kvirc an overkill job. - + - CMake from Kitware [Configuration tool; needed to compile KVIrc, mandatory] @@ -35,7 +35,7 @@ Prerequisites Download the tool from http://www.cmake.org. The package you want is called "Windows (Win32 Installer) cmake-<version>-win32-x86.exe" (version may vary). - You need at least version 2.6.4 to compile KVirc. Avoid version 2.8.0; use + You need at least version 2.6.4 to compile KVirc. Avoid version 2.8.0; use version 2.8.2 instead. Recent versions of the cmake installer will ask if you want to add cmake to @@ -58,7 +58,7 @@ Prerequisites [Compiler; needed to compile KVIrc, mandatory] If you installed the Qt SDK >= 4.6.0, you already have MinGW installed and - you can jump to the next requisite. Otherwise you need to install MinGW + you can jump to the next requisite. Otherwise you need to install MinGW manually: refer to http://www.mingw.org/wiki/InstallationHOWTOforMinGW Please note that you need to install gcc4 (gcc3 could work but is not supported). @@ -85,7 +85,7 @@ Prerequisites [Compression library; needed for many stuffs, mandatory] - MinGW offers a zlib package: You'll need to download from + MinGW offers a zlib package: You'll need to download from http://sourceforge.net/projects/mingw/ the packages: libz-1.2.3-1-mingw32-dll-1.tar.gz @@ -102,8 +102,8 @@ Prerequisites To compile KVIrc for your own use you can download a precompiled package from http://www.slproweb.com/products/Win32OpenSSL.html The package you want is called "Win32 OpenSSL v0.9.8l" (version number may - vary; there should be a notice like "Recommended for software developers" - in the package description). Any recent version should work; general rule: + vary; there should be a notice like "Recommended for software developers" + in the package description). Any recent version should work; general rule: more recent usually means more secure. Newer OpenSSL versions from www.slproweb.com need a specific version of @@ -134,8 +134,8 @@ Prerequisites at http://www.activestate.com/activepython/downloads/ . You want the "Free Community Edition" package. - Please note that we are currently supporting the 2.x version of python - (currently 2.6). Python3000 (aka python3k) is not backwards compatible + Please note that we are currently supporting the 2.x version of python + (currently 2.6). Python3000 (aka python3k) is not backwards compatible and supported by now. - GNU GetText for Win32 @@ -144,7 +144,7 @@ Prerequisites own language; required if you're building a redistributable package, otherwise optional] - We advice you to use the version you can find at + We advice you to use the version you can find at http://gnuwin32.sourceforge.net/packages/gettext.htm, follow the "Setup program" link. Install the package somewhere (like c:\gettext) and remember the path. @@ -153,15 +153,15 @@ Prerequisites [Tool; needed to tidy kvirc translation files, optional] - We advice you to use the version you can find at + We advice you to use the version you can find at http://gnuwin32.sourceforge.net/packages/sed.htm, follow the "Setup program" link. - + Install the package somewhere (like c:\sed) and remember the path. - Subversion cli for windows - [Versioning tool; needed for cmake to automatically set the correct + [Versioning tool; needed for cmake to automatically set the correct revision number in kvirc build; can be overridden (see below)] Any version will work; Recently the subversion guys went nuts and despite @@ -175,10 +175,10 @@ Prerequisites - Nullsoft scriptable install system (NSIS) - [Installer packages creator; needed if you want to create an installer + [Installer packages creator; needed if you want to create an installer package for kvirc] - Get it at http://nsis.sourceforge.net/Download ; the package you want + Get it at http://nsis.sourceforge.net/Download ; the package you want is called "nsis-2.46-setup.exe" (version numbers may vary). @@ -204,7 +204,7 @@ Further reccomended download if you plan to develop KVIrc: Compilation ------------------------------------------------------------------------------- -Download KVIrc sources from KVIrc's website, a mirror or using svn (see +Download KVIrc sources from KVIrc's website, a mirror or using svn (see instructions on KVIrc website about how to do that). From now on I'll assume that you have saved the sources in C:\KVIrc @@ -263,9 +263,9 @@ those dlls recognized and loaded automatically from your OS. If you want to create an installer package, you need to: -1) fill the binary directory (in our example: c:\KVIrc\build\release) with - all the files that cmake doesn't create: - - needed dlls: +1) fill the binary directory (in our example: c:\KVIrc\build\release) with + all the files that cmake doesn't create: + - needed dlls: - Qt: QtCore4, QtGui4 (mandatory); QtNetwork4, QtSvg4, QtWebkit4, QtXml, QtXmlPatterns (used in objects module); - Zlib: libz.dll (aka libz-1.dll, zlib.dll, ...); @@ -320,8 +320,8 @@ Common errors, pitfalls, .. ---------- C:/kvirctrunk/src/kvilib/system/kvi_time.h:0: Warning: No relevant classes found. No output generated. ---------- - In the compilation we call qt's moc to parse headers files and expand qt macros; - that warning simply means that moc found nothing to expand in that header file. We can fix this + In the compilation we call qt's moc to parse headers files and expand qt macros; + that warning simply means that moc found nothing to expand in that header file. We can fix this removing headers that doesn't need to be moc-ed from the lists in CMakeLists.txt. - * Windows Vista and 7 Users * If you have UAC enabled (default setting) and KVIrc is installed in the Program Files folder and you have opted to use the portable setting, then KVIrc's data files will be found in the VirtualStore folder, typically: C:\Users\[UserName]\AppData\Local\VirtualStore\Program Files\KVIrc\ If you plan on using the portable setting, it is recommended that you install KVIrc in a non UAC protected folder. diff --git a/doc/LICENSE-GPLV2 b/doc/LICENSE-GPLV2 index d511905c1..3912109b5 100644 --- a/doc/LICENSE-GPLV2 +++ b/doc/LICENSE-GPLV2 @@ -1,8 +1,8 @@ GNU GENERAL PUBLIC LICENSE Version 2, June 1991 - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. @@ -15,7 +15,7 @@ software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to +the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not @@ -55,7 +55,7 @@ patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. - + GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION @@ -110,7 +110,7 @@ above, provided that you also meet all of these conditions: License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) - + These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in @@ -168,7 +168,7 @@ access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. - + 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is @@ -225,7 +225,7 @@ impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. - + 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License @@ -278,7 +278,7 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS - + How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest @@ -303,9 +303,10 @@ the "copyright" line and a pointer to where the full notice is found. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + Also add information on how to contact you by electronic and paper mail. @@ -335,5 +336,5 @@ necessary. Here is a sample; alter the names: This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General +library. If this is what you want to do, use the GNU Library General Public License instead of this License. diff --git a/doc/LICENSE-GPLV3 b/doc/LICENSE-GPLV3 index 443254047..94a9ed024 100644 --- a/doc/LICENSE-GPLV3 +++ b/doc/LICENSE-GPLV3 @@ -1,12 +1,11 @@ - - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - Preamble + Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. @@ -69,7 +68,7 @@ patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. - TERMS AND CONDITIONS + TERMS AND CONDITIONS 0. Definitions. @@ -77,7 +76,7 @@ modification follow. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. - + "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. @@ -510,7 +509,7 @@ actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. - + If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties @@ -619,9 +618,9 @@ an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. - END OF TERMS AND CONDITIONS + END OF TERMS AND CONDITIONS - How to Apply These Terms to Your New Programs + How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it @@ -673,4 +672,3 @@ may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>. - diff --git a/doc/LICENSE-OPENSSL b/doc/LICENSE-OPENSSL index a2c4adcbe..e47d101f1 100644 --- a/doc/LICENSE-OPENSSL +++ b/doc/LICENSE-OPENSSL @@ -12,7 +12,7 @@ --------------- /* ==================================================================== - * Copyright (c) 1998-2008 The OpenSSL Project. All rights reserved. + * Copyright (c) 1998-2011 The OpenSSL Project. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/doc/README b/doc/README index dc56e387e..856421f34 100644 --- a/doc/README +++ b/doc/README @@ -21,7 +21,7 @@ More scripting power: - a new trayicon KVS class - added a default script manager to restore default scripts without overwriting custom user scripts - - lots of new functions: $file.time(), $insideAlias(), $log.export(), + - lots of new functions: $file.time(), $insideAlias(), $log.export(), $file.diskspace(), $isBot(), $gender(), $context.connectionStartTime, $context.lastMessageTime, $listtimers(), $window.isDocked, $aliasBody(), $file.readBytes(), $file.writeBytes(), window.savePropertiesAsDefault, diff --git a/doc/TODO-docs b/doc/TODO-docs index 22c578aaa..9e2651c89 100644 --- a/doc/TODO-docs +++ b/doc/TODO-docs @@ -208,7 +208,7 @@ ++KviTranslationEntry.cpp ++KviTranslationEntry.h ++KviTranslator.cpp -++KviTranslator.h +++KviTranslator.h ############## @@ -675,7 +675,7 @@ KviCustomToolBar.h KviDebugWindow.cpp KviDebugWindow.h - KviDockExtension.h + KviDockExtension.h KviDynamicToolTip.cpp KviDynamicToolTip.h KviFileDialog.cpp diff --git a/doc/addon.howto.txt b/doc/addon.howto.txt index adc927edb..2c83f227d 100644 --- a/doc/addon.howto.txt +++ b/doc/addon.howto.txt @@ -42,7 +42,7 @@ automatically invoke "/addon.install <filename>" on it. As stated above, the addons are usually shipped in a compressed archive. The /addon.install command will uncompress it to a temporary directory. -The uncompressed tree is substantially the same directory tree that you have +The uncompressed tree is substantially the same directory tree that you have to create in order to package your addon and it usually looks like this: name-version/ @@ -110,13 +110,13 @@ For example: # Register classes MyAddon::classes::register - + # Initialize events MyAddon::events::init - + # Load configuration MyAddon::config::load - + # Setup popups defpopup("MyAddon") { @@ -125,7 +125,7 @@ For example: ... } } - + # Set options option boolAutoAcceptDccSend 1 option boolShowMinimizedDebugWindow 1 @@ -161,7 +161,7 @@ subdirectory when no other language is found around... 4. THE INIT FILE -The smallest addon that you can write is the one that does nothing. +The smallest addon that you can write is the one that does nothing. addon.register("MyAddon", \ "1.0.0", \ @@ -193,7 +193,7 @@ The fourth parameter is a short description of the feature that the addon implem it can contain the $tr() function too. The fifth parameter is the minimal KVIrc version required to run the addon. The sixth parameter is the icon to show in the manager: it has to be 32x32 pixel big. -There are also some switches that can be used to fiddle a little bit more :) +There are also some switches that can be used to fiddle a little bit more :) 5. THE HELP AND CONFIGURATION CALLBACKS @@ -234,7 +234,7 @@ you've created. Be a clean coder :) 7. SOME EXAMPLES The code below is just an example of how to write a useful initalizazion of your own addon. -The name of the classes refer to the ones described above. +The name of the classes refer to the ones described above. # Register the classes alias(MyAddon::classes::register) @@ -246,7 +246,7 @@ The name of the classes refer to the ones described above. MyAddon::classes::gui::options, \ ... ) - + # Scan the array and register the classes for(%i=0; %i < $length(%classes[]); %i++) { @@ -257,7 +257,7 @@ The name of the classes refer to the ones described above. eval %classes[%i] } } - + # Initialize events alias(MyAddon::events::init) { @@ -274,7 +274,7 @@ The name of the classes refer to the ones described above. ... } } - + # Load configuration alias(MyAddon::config::load) { @@ -283,15 +283,15 @@ The name of the classes refer to the ones described above. { MyAddon::classes::register } - + # Set some variables %MyAddonConfig = $new(MyAddon::classes::ConfHandler) %MyAddonConfigPath = $file.localdir(config/scripts/MyAddon) - + # Open the configuration file and move to the section "general" %c = $config.open(%MyAddonConfigPath/MyAddon.kvc,"r") config.setsection %c general - + # Store the value of the key "Key" in the global variable %Key %Key = $config.read(%c,"Key",2) ... @@ -317,6 +317,6 @@ software!). It will be easier to do than it was to explain it :D Another great resource place is the IRC channel #KVIrc located on irc.freenode.org network. There you can find many people able to code and help you. -Have fun! :) +Have fun! :) Elvio Basello diff --git a/doc/hackers.guide.txt b/doc/hackers.guide.txt index 456f3708f..63873eecb 100644 --- a/doc/hackers.guide.txt +++ b/doc/hackers.guide.txt @@ -69,7 +69,7 @@ The source tree | | | |-- config A pkgconfig-like tool to get info about KVIrc paths | | -| `-- pydocparser A python script to create html user documentation; an +| `-- pydocparser A python script to create html user documentation; an | alternative to admin/gendoc.pl | |-- src The sources @@ -288,7 +288,7 @@ The source tree | | | `-- zzz_afterlastmodule A dummy module used by the compilation | process to execute last-minute cleanup -| +| | `-- win32build The directory for Windows builds @@ -912,7 +912,7 @@ following scheme (R means 'stable public release'): trunk: N.0.0--N.1.0--N.1.1--N.1.2--N.1.3--N.2.0--N.3.0--N.3.1--N.4.0--N.5.0 | | | branch: +--N.0.1--N.0.2--N.0.3--N.0.4 +--N.2.1--N.2.2 +--N.4.1-... - R R R + R R R - Official, semi-official and unofficial packages diff --git a/doc/translations.howto.txt b/doc/translations.howto.txt index e7e151ab8..16839f451 100644 --- a/doc/translations.howto.txt +++ b/doc/translations.howto.txt @@ -65,7 +65,7 @@ kvirc_it.po) files where xxx stands for your language code (found in step 2). If you jumped directly here from 2 then you need to find the existing *_xxx.po files in the kvirc/po subdirectories. If no such files exist for your locale, you probably missed to create them in -step 3. +step 3. You can translate *.po files using a simple text editor (that _have_ to support the UTF-8 encoding), but it's strongly advised that you use a translation software |
