diff options
Diffstat (limited to 'doc')
29 files changed, 646 insertions, 88 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index dc6bb770..27232392 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,12 +1,8 @@ -################################################# -# -# (C) 2012 Golubev Alexander -# fatzer2 (AT) gmail.com -# -# Improvements and feedback are welcome -# -# This file is released under GPL >= 2 -# -################################################# +add_subdirectory( man ) -tde_auto_add_subdirectories( ) +tde_conditional_add_subdirectory( BUILD_QUANTA quanta ) +tde_conditional_add_subdirectory( BUILD_KXSLDBG kxsldbg ) +tde_conditional_add_subdirectory( BUILD_KXSLDBG xsldbg ) +tde_conditional_add_subdirectory( BUILD_KOMMANDER kommander ) +tde_conditional_add_subdirectory( BUILD_KLINKSTATUS klinkstatus ) +tde_conditional_add_subdirectory( BUILD_KIMAGEMAPEDITOR kimagemapeditor ) diff --git a/doc/kimagemapeditor/CMakeLists.txt b/doc/kimagemapeditor/CMakeLists.txt new file mode 100644 index 00000000..cd7e12b9 --- /dev/null +++ b/doc/kimagemapeditor/CMakeLists.txt @@ -0,0 +1 @@ +tde_create_handbook( DESTINATION kimagemapeditor ) diff --git a/doc/klinkstatus/CMakeLists.txt b/doc/klinkstatus/CMakeLists.txt new file mode 100644 index 00000000..39be9f18 --- /dev/null +++ b/doc/klinkstatus/CMakeLists.txt @@ -0,0 +1 @@ +tde_create_handbook( DESTINATION klinkstatus ) diff --git a/doc/klinkstatus/index.docbook b/doc/klinkstatus/index.docbook index ff2a0cdb..3544d321 100644 --- a/doc/klinkstatus/index.docbook +++ b/doc/klinkstatus/index.docbook @@ -483,16 +483,3 @@ dicer-toaster daemon first, or &klinkstatus; won't work !</para> &documentation.index; </book> - -<!-- -Local Variables: -mode: sgml -sgml-minimize-attributes:nil -sgml-general-insert-case:lower -sgml-indent-step:0 -sgml-indent-data:nil -End: - -vim:tabstop=2:shiftwidth=2:expandtab ---> - diff --git a/doc/kommander/CMakeLists.txt b/doc/kommander/CMakeLists.txt new file mode 100644 index 00000000..fabb11a5 --- /dev/null +++ b/doc/kommander/CMakeLists.txt @@ -0,0 +1 @@ +tde_create_handbook( DESTINATION kommander ) diff --git a/doc/kommander/dcop.docbook b/doc/kommander/dcop.docbook index 1fd7c170..e13db5e6 100644 --- a/doc/kommander/dcop.docbook +++ b/doc/kommander/dcop.docbook @@ -30,7 +30,7 @@ This assumes you are inside a &kommander; file and have access to the special @p &kommander; evolved the much faster internal &DCOP; function. Using it from another application window (console &DCOP; is very slow) is more complicated because you must give lots of information, including a prototype of the call. The above call would become: (Note that @dcopid is actually internal to the dialog, but you could replace it with a valid process ID) </para> <screen> -@dcop(@dcopid, KommanderIf, <quote>enableWidget(QString, bool)</quote>, Widget, true) +@dcop(@dcopid, KommanderIf, <quote>enableWidget(TQString, bool)</quote>, Widget, true) </screen> <para> In the early &kommander; nesting &DCOP; calls inside script language structures (like <application>bash</application>) used console method calls. <emphasis>If you use internal &DCOP; all &kommander; specials will be executed first and then the script will be executed.</emphasis> Please read that again as it will cause you no end of grief with a <application>bash</application> loop using &kommander; specials. @@ -49,7 +49,7 @@ As you can see the new syntax is very easy, as well as consistent visually with <title>&DCOP; for Global Variables</title> <variablelist> <varlistentry> -<term>global(QString variableName)</term> +<term>global(TQString variableName)</term> <listitem> <para> Returns the value of the specified global variable. When a script is run from within a &kommander; window any (non-global) variables set in that script will cease to exist after the script completes and therfore will not be available to other script processes or in a new instance of the calling process. The global <quote>scope</quote> means the variable will exist for any process of the window until that window is closed. You may change these variables at any time with a new call to <function>@setGlobal</function>. @@ -57,10 +57,10 @@ Returns the value of the specified global variable. When a script is run from w </listitem> </varlistentry> <varlistentry> -<term>setGlobal(QString variableName, QString value)</term> +<term>setGlobal(TQString variableName, TQString value)</term> <listitem> <para> -Creates a variable that is global to the window process and assigns the value to it. This value can be retrieved with global(QString variableName) or set again. +Creates a variable that is global to the window process and assigns the value to it. This value can be retrieved with global(TQString variableName) or set again. </para> </listitem> </varlistentry> @@ -75,7 +75,7 @@ The following list is old and left here for reference purposes only. For a compl </para> <variablelist> <varlistentry> -<term>setText(QString text)</term> +<term>setText(TQString text)</term> <listitem> <para> This removes the text displayed in the widget and replaces it with the text supplied. @@ -99,7 +99,7 @@ Returns the text associated with the specified widget. This is not the same as </listitem> </varlistentry> <varlistentry> -<term>setAssociatedText(QString text)</term> +<term>setAssociatedText(TQString text)</term> <listitem> <para> This sets the &kommander; Text default string. This is typically set to <quote>@widgetText</quote> to display what is entered into the widget. It is unlikely you will have much need for this, but if you do it is there. Applies to all widgets that can contain data. @@ -113,7 +113,7 @@ This sets the &kommander; Text default string. This is typically set to <quote> <title>&DCOP; for ListBox and ComboBox Widgets</title> <variablelist> <varlistentry> -<term>addListItem(QString item, int index)</term> +<term>addListItem(TQString item, int index)</term> <listitem> <para> Adds an item to a ListBox widget at the specified index. List index starts at zero. To add to the end of the list use -1. @@ -129,7 +129,7 @@ This adds a list of strings all at once. The list should be delimited by <acron </listitem> </varlistentry> <varlistentry> -<term>addUniqueItem(QString item)</term> +<term>addUniqueItem(TQString item)</term> <listitem> <para> addUniqueItem will add an item to the end of the list only if it is unique. @@ -175,7 +175,7 @@ Set the current (or selected) item to the index specified. Applies to ListBox a <title>&DCOP; for CheckBox and RadioButton Widgets</title> <variablelist> <varlistentry> -<term>setChecked(QString widgetName, bool checked)</term> +<term>setChecked(TQString widgetName, bool checked)</term> <listitem> <para> Checks/unchecks CheckBox or RadioButton widgets. @@ -189,7 +189,7 @@ Checks/unchecks CheckBox or RadioButton widgets. <title>&DCOP; for TabWidget Widgets</title> <variablelist> <varlistentry> -<term>setCurrentTab(QString widgetName, int index)</term> +<term>setCurrentTab(TQString widgetName, int index)</term> <listitem> <para> Selected the tab by index for TabWidgets. Index starts at 0. diff --git a/doc/kommander/extending.docbook b/doc/kommander/extending.docbook index f4323828..8c5fce1c 100644 --- a/doc/kommander/extending.docbook +++ b/doc/kommander/extending.docbook @@ -61,33 +61,33 @@ dialog, we get something like this in the generated header file: class QShowEvent; class KomLineEdit : public KLineEdit, public KommanderWidget { - Q_OBJECT + TQ_OBJECT - TQ_PROPERTY(QString populationText READ populationText WRITE setPopulationText DESIGNABLE false) + TQ_PROPERTY(TQString populationText READ populationText WRITE setPopulationText DESIGNABLE false) TQ_PROPERTY(QStringList associations READ associatedText WRITE setAssociatedText DESIGNABLE false) TQ_PROPERTY(bool KommanderWidget READ isKommanderWidget) public: - KomLineEdit(QWidget *a_parent, const char *a_name); + KomLineEdit(TQWidget *a_parent, const char *a_name); ~KomLineEdit(); - virtual QString widgetText() const; + virtual TQString widgetText() const; virtual bool isKommanderWidget() const; virtual void setAssociatedText(const QStringList&); virtual QStringList associatedText() const; - virtual QString currentState() const; + virtual TQString currentState() const; - virtual QString populationText() const; - virtual void setPopulationText(const QString&); + virtual TQString populationText() const; + virtual void setPopulationText(const TQString&); public slots: - virtual void setWidgetText(const QString &); + virtual void setWidgetText(const TQString &); virtual void populate(); protected: void showEvent( QShowEvent *e ); signals: void widgetOpened(); - void widgetTextChanged(const QString &); + void widgetTextChanged(const TQString &); }; </screen> <para>Most of this is just template code that you don't need to worry about. @@ -99,7 +99,7 @@ widget we wish to integrate with &kommander;, and secondly from KommanderWidget. There are a few parts in the cpp file that are important to each particular widget. </para> <screen> -KomLineEdit::KomLineEdit(QWidget *a_parent, const char *a_name) +KomLineEdit::KomLineEdit(TQWidget *a_parent, const char *a_name) : KLineEdit(a_parent, a_name), KommanderWidget(this) { QStringList states; @@ -115,9 +115,9 @@ that had different kinds of states, such as a check box, you might set three states <emphasis>unchecked</emphasis>, <emphasis>semichecked</emphasis> and <emphasis>checked</emphasis> here. </para> <screen> -QString KomLineEdit::currentState() const +TQString KomLineEdit::currentState() const { - return QString("default"); + return TQString("default"); }</screen> <para>We set the states in the constructor above, and this just returns the current state of the widget. For our widget @@ -126,12 +126,12 @@ that checks what state your widget is currently in and return the appropriate string here. </para> <screen> -QString KomLineEdit::widgetText() const +TQString KomLineEdit::widgetText() const { return KLineEdit::text(); } -void KomLineEdit::setWidgetText(const QString &a_text) +void KomLineEdit::setWidgetText(const TQString &a_text) { KLineEdit::setText(a_text); emit widgetTextChanged(a_text); @@ -139,7 +139,7 @@ void KomLineEdit::setWidgetText(const QString &a_text) </screen> <para>These are the two most important methods, where the bulk of the functional code goes. -<emphasis>QString KomLineEdit::widgetText() const</emphasis> method returns the widget text of the +<emphasis>TQString KomLineEdit::widgetText() const</emphasis> method returns the widget text of the widget (the text that the <emphasis>@widgetText</emphasis> special is expanded to in text associations). For our widget, the widget text is simply the text inside the line edit, so we just return that. Similarly when setting the widget text, @@ -162,17 +162,17 @@ enum Functions { Function2, LastFunction }; -KomLineEdit::KomLineEdit(QWidget *a_parent, const char *a_name) +KomLineEdit::KomLineEdit(TQWidget *a_parent, const char *a_name) : KLineEdit(a_parent, a_name), KommanderWidget(this) { ... //code like described above KommanderPlugin::setDefaultGroup(Group::DCOP); - KommanderPlugin::registerFunction(Function1, "function1(QString widget, QString arg1, int arg2)", i18n("Call function1 with two arguments, second is optional."), 2, 3); - KommanderPlugin::registerFunction(function2, "function2(QString widget)", i18n("Get a QString as a result of function2."), 1); + KommanderPlugin::registerFunction(Function1, "function1(TQString widget, TQString arg1, int arg2)", i18n("Call function1 with two arguments, second is optional."), 2, 3); + KommanderPlugin::registerFunction(function2, "function2(TQString widget)", i18n("Get a TQString as a result of function2."), 1); } </screen> <para>This registers two functions: <emphasis>function1 and function2</emphasis>. The number assigned to the functions (here <emphasis>1160</emphasis> and <emphasis>1161</emphasis>) must be unique, not used in any other plugin or -inside &kommander;. <emphasis>function1</emphasis> takes two arguments, one is optional, <emphasis>function2</emphasis> takes no argument and returns a string. The <emphasis>QString widget</emphasis> argument in the signatures notes that this functions work on a widget, like: <emphasis>KomLineEdit.function1("foo", 1)</emphasis>. +inside &kommander;. <emphasis>function1</emphasis> takes two arguments, one is optional, <emphasis>function2</emphasis> takes no argument and returns a string. The <emphasis>TQString widget</emphasis> argument in the signatures notes that this functions work on a widget, like: <emphasis>KomLineEdit.function1("foo", 1)</emphasis>. </para> <para>To teach &kommander; that the widget supports these functions, add a method like this: </para> @@ -187,7 +187,7 @@ function. The function code should be handled inside the handleDCOP method: </para> <screen> -QString KomLineEdit::handleDCOP(int function, const QStringList& args) +TQString KomLineEdit::handleDCOP(int function, const QStringList& args) { switch (function) { @@ -203,7 +203,7 @@ QString KomLineEdit::handleDCOP(int function, const QStringList& args) default: return KommanderWidget::handleDCOP(function, args); } - return QString::null; + return TQString::null; } </screen> <para>There are cases when the widget should appear differently in the editor than in @@ -226,7 +226,7 @@ derive from QLabel, and use this in the constructor: functions, like in the <emphasis>execute</emphasis> function. Here is an example from the AboutDialog widget: </para> <screen> -QString AboutDialog::handleDCOP(int function, const QStringList& args) +TQString AboutDialog::handleDCOP(int function, const QStringList& args) { switch (function) { ... @@ -287,7 +287,7 @@ class MyKomPlugin : public KommanderPlugin { public: MyKomPlugin(); - virtual QWidget *create( const QString &className, QWidget *parent = 0, const char *name = 0 ); + virtual TQWidget *create( const TQString &className, TQWidget *parent = 0, const char *name = 0 ); }; </screen> <para> @@ -313,7 +313,7 @@ etc. Regarding the icon, the above example loads a medium sized icon called <emphasis>iconname</emphasis> from the standard &kde; icon location. </para> <screen> -QWidget *MyKomPlugin::create( const QString &className, QWidget *parent, const char *name ) +TQWidget *MyKomPlugin::create( const TQString &className, TQWidget *parent, const char *name ) { if( className == "KomLineEdit" ) return new KomLineEdit( parent, name ); @@ -410,8 +410,8 @@ You need to add to the <emphasis>editor/widgetfactory.cpp</emphasis> as well: ... #include "mywidget.h" ... -QWidget *WidgetFactory::createWidget( const QString &className, QWidget *parent, const char *name, bool init, - const QRect *r, Qt::Orientation orient ) +TQWidget *WidgetFactory::createWidget( const TQString &className, TQWidget *parent, const char *name, bool init, + const QRect *r, TQt::Orientation orient ) { ... else if (className == "MyWidgetName") diff --git a/doc/kommander/parser.docbook b/doc/kommander/parser.docbook index a008c431..a8bec882 100644 --- a/doc/kommander/parser.docbook +++ b/doc/kommander/parser.docbook @@ -307,8 +307,8 @@ And now you access those with <emphasis>_xcount</emphasis> and <emphasis>_xquote </para> <para> DCOP can be complex, which is why we recommend using the tools we develop to enable creating DCOP for remote &kommander; dialogs with something like a function browser. Here is an example DCOP call issued from a dialog opened from a parent &kommander; window. Since it knows who its parent is it can send information back while it is open and freely access all its parent's functionality with the exception of slots. Of course that can be done internally with a script which can be called externally, so in practice there is no limit to what can be done. -<screen>dcop("kmdr-executor-"+parentPid, "KommanderIf", "setText(QString,QString)", "StatusBar8", "Hello")</screen> -Let's look at this piece by piece. First of all we add <emphasis>parentPid</emphasis> to "kmdr-executor-" as we make no assumption a &kommander; window was the caller. You could use this with Quanta or KSpread or whatever. Next we are addressing <emphasis>KommanderIf</emphasis>, which is a <emphasis>nice</emphasis> interface for end users which has been cleaned up. We hope eventually as KDE moves from DCOP to DBUS on KDE4 that more applications adopt a nice interface for integration. The next parameter, <emphasis>"setText(QString,QString)"</emphasis> is important because it <emphasis>prototypes</emphasis> the parameters allowed. Otherwise &kommander; could not validate the call. So without a definition of the DCOP call being used you will get an error. The remaining parameters are of course what is being passed. We recommend you look at applications with <command>kdcop</command> to see how this works and practice dcop calls from the shell to get your syntax right. +<screen>dcop("kmdr-executor-"+parentPid, "KommanderIf", "setText(TQString,TQString)", "StatusBar8", "Hello")</screen> +Let's look at this piece by piece. First of all we add <emphasis>parentPid</emphasis> to "kmdr-executor-" as we make no assumption a &kommander; window was the caller. You could use this with Quanta or KSpread or whatever. Next we are addressing <emphasis>KommanderIf</emphasis>, which is a <emphasis>nice</emphasis> interface for end users which has been cleaned up. We hope eventually as KDE moves from DCOP to DBUS on KDE4 that more applications adopt a nice interface for integration. The next parameter, <emphasis>"setText(TQString,TQString)"</emphasis> is important because it <emphasis>prototypes</emphasis> the parameters allowed. Otherwise &kommander; could not validate the call. So without a definition of the DCOP call being used you will get an error. The remaining parameters are of course what is being passed. We recommend you look at applications with <command>kdcop</command> to see how this works and practice dcop calls from the shell to get your syntax right. </para> </sect2> </sect1> @@ -557,7 +557,7 @@ file with given <emphasis>key</emphasis>; if there is no such value <emphasis>de for best control. </para></listitem> <listitem> -<para><command>connect(<parameter>sender</parameter>, <parameter>signal</parameter>, <parameter>receiver</parameter>, <parameter>slot</parameter>)</command> - connect a widget signal to a widget slot. See the connection dialog and select similar widgets for possibilities. If for instance a signal looks like looks like <command>execute(const QString&)</command> that is exactly what must be in quotes there. +<para><command>connect(<parameter>sender</parameter>, <parameter>signal</parameter>, <parameter>receiver</parameter>, <parameter>slot</parameter>)</command> - connect a widget signal to a widget slot. See the connection dialog and select similar widgets for possibilities. If for instance a signal looks like looks like <command>execute(const TQString&)</command> that is exactly what must be in quotes there. </para></listitem> <listitem> <para><command>disconnect(<parameter>sender</parameter>, <parameter>signal</parameter>, <parameter>receiver</parameter>, <parameter>slot</parameter>)</command> - undo the connection as listed above. Again, exact syntax is essential. diff --git a/doc/kommander/tutorials.docbook b/doc/kommander/tutorials.docbook index 6071c60c..a9ccafa8 100644 --- a/doc/kommander/tutorials.docbook +++ b/doc/kommander/tutorials.docbook @@ -83,7 +83,7 @@ One of the very useful features inherited from Qt Designer was signals and slots <para> To access the connection tool you can open it by right clicking anywhere on the dialog and selecting it. Click the menu and you will see a list of connections made at the bottom. Above that are two lists of signals and slots and above them the respective sender and receiver are selected. An easy way to make connections is visually. Look at the toolbar or the Tools menu. There are three items grouped there. A pointer, signals and slot connections and the tab order or widgets. Selecting this sets connection mode for the curios. Click on your widget to send the signal and drag it to your widget to receive it in a slot. As you do this you will see a line and drop indications on the widget under the mouse. The StatusBar on the Editor will tell you what is being connected. </para> -<note><para>In version 1.3 there is a &kommander; function connect() which allows you to connect signals and slots on the fly. This is useful if you just used createWidget. Obviously you can't use the dialog for something &kommander; doesn't yet know exists. Unfortunately there are too many combinations to list so you have to type out signals and slots. <emphasis>These must be typed verbatim or they will fail.</emphasis> This is where the connection tool is handy again. Open it and select two widgets like the two you want to connect and read the connection information. if it says <command>execute(const QString&)</command> that is exactly what you must type.</para></note> +<note><para>In version 1.3 there is a &kommander; function connect() which allows you to connect signals and slots on the fly. This is useful if you just used createWidget. Obviously you can't use the dialog for something &kommander; doesn't yet know exists. Unfortunately there are too many combinations to list so you have to type out signals and slots. <emphasis>These must be typed verbatim or they will fail.</emphasis> This is where the connection tool is handy again. Open it and select two widgets like the two you want to connect and read the connection information. if it says <command>execute(const TQString&)</command> that is exactly what you must type.</para></note> </sect2> <sect2 id="slot-functions"> diff --git a/doc/kxsldbg/CMakeLists.txt b/doc/kxsldbg/CMakeLists.txt new file mode 100644 index 00000000..10326ba8 --- /dev/null +++ b/doc/kxsldbg/CMakeLists.txt @@ -0,0 +1 @@ +tde_create_handbook( DESTINATION kxsldbg ) diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt new file mode 100644 index 00000000..13caef20 --- /dev/null +++ b/doc/man/CMakeLists.txt @@ -0,0 +1,5 @@ +tde_conditional_add_subdirectory( BUILD_QUANTA quanta ) +tde_conditional_add_subdirectory( BUILD_KXSLDBG kxsldbg ) +tde_conditional_add_subdirectory( BUILD_KOMMANDER kommander ) +tde_conditional_add_subdirectory( BUILD_KLINKSTATUS klinkstatus ) +tde_conditional_add_subdirectory( BUILD_KIMAGEMAPEDITOR kimagemapeditor ) diff --git a/doc/man/kimagemapeditor/CMakeLists.txt b/doc/man/kimagemapeditor/CMakeLists.txt new file mode 100644 index 00000000..4088e36f --- /dev/null +++ b/doc/man/kimagemapeditor/CMakeLists.txt @@ -0,0 +1,5 @@ +install( + FILES kimagemapeditor.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kimagemapeditor/kimagemapeditor.1 b/doc/man/kimagemapeditor/kimagemapeditor.1 new file mode 100644 index 00000000..681db952 --- /dev/null +++ b/doc/man/kimagemapeditor/kimagemapeditor.1 @@ -0,0 +1,47 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KIMAGEMAPEDITOR 1 "October 19, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kimagemapeditor \- an HTML image map editor for TDE +.SH SYNOPSIS +.B kimagemapeditor +[ \fIgeneric-options\fP ] +[ \fB\-c, \-\-stdout\fP ] +[ \fIfile\fP ... ] +.SH DESCRIPTION +\fBKImageMapEditor\fP is a tool that allows you to edit image maps in +HTML files. As well as providing a standalone application, +KImageMapEditor makes itself available as a KPart for embedding into +larger applications. +.PP +The files passed on the command line may be either HTML files or image +files. +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +Below are the kimagemapeditor-specific options. +For a full summary of options, run \fIkimagemapeditor \-\-help\fP. +.TP +\fB\-c, \-\-stdout\fP +Write the resulting HTML code to standard output when exiting. +.SH SEE ALSO +.BR quanta (1). +.SH AUTHOR +KImageMapEditor was written by Jan Schafer <janschaefer@users.sourceforge.net>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/klinkstatus/CMakeLists.txt b/doc/man/klinkstatus/CMakeLists.txt new file mode 100644 index 00000000..e080e735 --- /dev/null +++ b/doc/man/klinkstatus/CMakeLists.txt @@ -0,0 +1,5 @@ +install( + FILES klinkstatus.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/klinkstatus/klinkstatus.1 b/doc/man/klinkstatus/klinkstatus.1 new file mode 100644 index 00000000..c1b2b61b --- /dev/null +++ b/doc/man/klinkstatus/klinkstatus.1 @@ -0,0 +1,52 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KLINKSTATUS 1 "October 19, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +klinkstatus \- a web link validity checker for TDE +.SH SYNOPSIS +.B klinkstatus +[ \fIgeneric-options\fP ] +[ \fIURL\fP ] +.SH DESCRIPTION +\fBKLinkStatus\fP is a web link validity checker for TDE. It allows you to +search internal and external links throughout your web site. Simply +point it to a single page and choose the depth to search. +.PP +You can also check local files, or files over ftp:, fish: or any other +KIO protocols. For performance, links can be checked simultaneously. +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +For a full summary of options, run \fIklinkstatus \-\-help\fP. +.SH SEE ALSO +.BR quanta (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/klinkstatus/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/klinkstatus/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdewebdev-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/klinkstatus/\fP. +.SH AUTHOR +KLinkStatus was written by Paulo Moura Guedes <moura@tdewebdev.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kommander/CMakeLists.txt b/doc/man/kommander/CMakeLists.txt new file mode 100644 index 00000000..669b104c --- /dev/null +++ b/doc/man/kommander/CMakeLists.txt @@ -0,0 +1,11 @@ +install( + FILES + kmdr2po.1 + kmdr-executor.1 + extractkmdr.1 + kmdr-editor.1 + kmdr-plugins.1 + + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kommander/extractkmdr.1 b/doc/man/kommander/extractkmdr.1 new file mode 100644 index 00000000..5dfad28d --- /dev/null +++ b/doc/man/kommander/extractkmdr.1 @@ -0,0 +1,53 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXTRACTKMDR 1 "March 25, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +extractkmdr \- extract message strings from Kommander dialogs +.SH SYNOPSIS +.B extractkmdr +[ \fB\-\-tag=\fP\fIname\fP ... ] +[ \fB\-\-context=\fP\fIname\fP ] +\fIfile\fP ... +.SH DESCRIPTION +\fBextractkmdr\fP finds all text tags and other message strings within the +given Kommander dialog (.kmdr) files. It then writes the corresponding +\fIi18n()\fP calls to standard output (usually redirected to rc.cpp) +so that xgettext can parse them. +.PP +To create a complete gettext message file (PO-file) from a Kommander +dialog, the +.BR kmdr2po (1) +utility is more convenient. +.PP +This utility is part of the TDE web development module. +.SH OPTIONS +.TP +\fB\-\-tag=\fP\fIname\fP +Extract also the contents of the tag \fIname\fP. +This option may be used multiple times +(e.g., \-\-tag=tag_one \-\-tag=tag_two). +.TP +\fB\-\-context=\fP\fIname\fP +Give all i18n() calls the given context: i18n("\fIname\fP", ...). +.SH SEE ALSO +.BR kmdr-editor (1), +.BR kmdr-executor (1), +.BR kmdr-plugins (1), +.BR kmdr2po (1). +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kommander/kmdr-editor.1 b/doc/man/kommander/kmdr-editor.1 new file mode 100644 index 00000000..5ecb637c --- /dev/null +++ b/doc/man/kommander/kmdr-editor.1 @@ -0,0 +1,70 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KMDR-EDITOR 1 "March 25, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kmdr-editor \- editor for the Kommander visual dialog building tool +.SH SYNOPSIS +.B kmdr-editor +[ \fIgeneric-options\fP ] +.SH DESCRIPTION +\fBKommander\fP is a visual dialog building tool whose +primary objective is to create +as much functionality as possible without using any scripting language. +.PP +More specifically, Kommander is a set of tools that allow you to create +dynamic GUI dialogs that generate, based on their state, a piece of text. +The piece of text can be a command line to a program, any piece of code, +business documents that contain a lot of repititious or templated text and so +on. The resulting generated text can then be executed as a command line +program (hence the name "Kommander"), written to a file, passed to a +script for extended processing, and literally anything else you can +think of. The best part of it all? You aren't required to write a single +line of code! +.PP +This editor (\fBkmdr-editor\fP) allows you to lay out your entire dialog +through a graphical +user interface. Once a dialog has been created by the editor, it is +saved as a file with extension \fI.kmdr\fP. The dialog that this XML file +represents can then be run instantly with the executor (\fBkmdr-executor\fP). +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +For a full summary of options, run \fIkmdr-editor \-\-help\fP. +.SH SEE ALSO +.BR extractkmdr (1), +.BR kmdr-executor (1), +.BR kmdr-plugins (1), +.BR kmdr2po (1), +.BR quanta (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kommander/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kommander/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdewebdev-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kommander/\fP. +.SH AUTHOR +Kommander was written by Marc Britton <consume@optusnet.com.au>, +Eric Laffoon <sequitur@kde.org>, Michal Rudolf <mrudolf@tdewebdev.org>, +Andras Mantia <amantia@kde.org> and Trolltech. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kommander/kmdr-executor.1 b/doc/man/kommander/kmdr-executor.1 new file mode 100644 index 00000000..cc197d69 --- /dev/null +++ b/doc/man/kommander/kmdr-executor.1 @@ -0,0 +1,87 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KMDR-EXECUTOR 1 "March 25, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kmdr-executor \- executor for the Kommander visual dialog building tool +.SH SYNOPSIS +.B kmdr-executor +[ \fIgeneric-options\fP ] +[ \fB\-c\fP \fIcatalog\fP ] +{ \fB\-\-stdin\fP | \fIfile\fP } +[ \fIarg\fP ... ] +.SH DESCRIPTION +\fBKommander\fP is a visual dialog building tool whose +primary objective is to create +as much functionality as possible without using any scripting language. +.PP +More specifically, Kommander is a set of tools that allow you to +create dynamic GUI dialogs +that generate, based on their state, a piece of text. The piece of text +can be a command line to a program, any piece of code, business +documents that contain a lot of repititious or templated text and so on. +The resulting generated text can then be executed as a command line +program (hence the name "Kommander"), written to a file, passed to a +script for extended processing, and literally anything else you can +think of. The best part of it all? You aren't required to write a single +line of code! +.PP +This executor (\fBkmdr-executor\fP) is used to run a dialog that has +been created by the +dialog editor (\fBkmdr-editor\fP). Either the dialog file (generally +a \fI.kmdr\fP file) should be passed on +the command-line, or else the option \-\-stdin should be passed and the +dialog description should be supplied as XML on standard input. +Additional arguments for the dialog itself may also be supplied. +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +Below are the kommander-specific options. +For a full summary of options, run \fIkmdr-editor \-\-help\fP. +.TP +\fB\-c\fP \fIcatalog\fP +Use the given catalog for translation. +.TP +\fB\-\-stdin\fP +Read the XML dialog description from standard input instead of passing +a \fI.kmdr\fP file on the command-line. +.TP +\fIarg\fP ... +Additional arguments to be passed on to the dialog itself. +.SH SEE ALSO +.BR extractkmdr (1), +.BR kmdr-editor (1), +.BR kmdr-plugins (1), +.BR kmdr2po (1), +.BR quanta (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kommander/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kommander/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdewebdev-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kommander/\fP. +.SH AUTHOR +Kommander was written by Marc Britton <consume@optusnet.com.au>, +Eric Laffoon <sequitur@kde.org>, Michal Rudolf <mrudolf@tdewebdev.org>, +Andras Mantia <amantia@kde.org> and Trolltech. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kommander/kmdr-plugins.1 b/doc/man/kommander/kmdr-plugins.1 new file mode 100644 index 00000000..5a8d222b --- /dev/null +++ b/doc/man/kommander/kmdr-plugins.1 @@ -0,0 +1,71 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KMDR-PLUGINS 1 "March 25, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kmdr-plugins \- plugin manager for the Kommander visual dialog building tool +.SH SYNOPSIS +.B kmdr-plugins +[ \fIgeneric-options\fP ] +.SH DESCRIPTION +\fBKommander\fP is a visual dialog building tool whose +primary objective is to create +as much functionality as possible without using any scripting language. +.PP +It is possible to extend Kommander by writing your own plugins. The +plugin manager +.B kmdr-plugins +is a simple user interface to Kommander's configuration file, and +can be used to select which external plugins Kommander should load. +Closing the plugin manager will automatically save any changes. +.PP +By loading a plugin, the custom widgets that it defines +will become available in Kommander's menus and toolbars, and these +custom widgets can be used in Kommander dialogs. +.PP +See +.BR kmdr-editor (1) +and +.BR kmdr-executor (1) +for a more detailed description of Kommander. +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +For a full summary of options, run \fIkmdr-plugins \-\-help\fP. +.SH SEE ALSO +.BR extractkmdr (1), +.BR kmdr-editor (1), +.BR kmdr-executor (1), +.BR kmdr2po (1), +.BR quanta (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kommander/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kommander/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdewebdev-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kommander/\fP. +.SH AUTHOR +Kommander was written by Marc Britton <consume@optusnet.com.au>, +Eric Laffoon <sequitur@kde.org>, Michal Rudolf <mrudolf@tdewebdev.org>, +Andras Mantia <amantia@kde.org> and Trolltech. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kommander/kmdr2po.1 b/doc/man/kommander/kmdr2po.1 new file mode 100644 index 00000000..4693644e --- /dev/null +++ b/doc/man/kommander/kmdr2po.1 @@ -0,0 +1,47 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KMDR2PO 1 "March 25, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kmdr2po \- create a PO-file from a Kommander dialog +.SH SYNOPSIS +.B kmdr2po +.I dialog +.SH DESCRIPTION +\fBkmdr2po\fP creates a gettext message file (PO-file) from the given +Kommander dialog (.kmdr) file. It does this by using +.BR extractkmdr (1) +to extract all text tags and other message strings, and then running +.BR xgettext (1) +to create the corresponding PO-file. +.PP +The final PO-file will be created in the current directory. Its name +will be derived from the dialog filename by replacing the suffix +\fI.kmdr\fP with \fI.po\fP. +.PP +This utility is part of the TDE web development module. +.SH WARNING +A temporary file named \fI_from_rc.cc\fP in the current directory +will be created and subsequently removed. +.SH SEE ALSO +.BR extractkmdr (1), +.BR kmdr-editor (1), +.BR kmdr-executor (1), +.BR kmdr-plugins (1), +.BR xgettext (1). +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kxsldbg/CMakeLists.txt b/doc/man/kxsldbg/CMakeLists.txt new file mode 100644 index 00000000..d701aad2 --- /dev/null +++ b/doc/man/kxsldbg/CMakeLists.txt @@ -0,0 +1,5 @@ +install( + FILES kxsldbg.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kxsldbg/kxsldbg.1 b/doc/man/kxsldbg/kxsldbg.1 new file mode 100644 index 00000000..11b551f6 --- /dev/null +++ b/doc/man/kxsldbg/kxsldbg.1 @@ -0,0 +1,54 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KXSLDBG 1 "October 19, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kxsldbg \- a graphical XSLT debugger for TDE +.SH SYNOPSIS +.B kxsldbg +[ \fIgeneric-options\fP ] +.SH DESCRIPTION +\fBKXSLDbg\fP is a graphical debugger for XSLT scripts. It provides +a graphical front-end to the text-based debugger +.BR xsldbg (1). +KXSLDbg can be run as a standalone application or as an embedded TDE part. +.PP +XSLT is an XML language for defining transformations of XML files from +XML to some other arbitrary format, such as XML, HTML, plain text, etc., +using standard XSLT stylesheets. +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +For a full summary of options, run \fIkxsldbg \-\-help\fP. +.SH SEE ALSO +.BR quanta (1), +.BR xsldbg (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kxsldbg/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kxsldbg/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdewebdev-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kxsldbg/\fP. +.SH AUTHOR +KXSLDbg was written by Keith Isdale <k_isdale@tpg.com.au>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/quanta/CMakeLists.txt b/doc/man/quanta/CMakeLists.txt new file mode 100644 index 00000000..7db459f7 --- /dev/null +++ b/doc/man/quanta/CMakeLists.txt @@ -0,0 +1,5 @@ +install( + FILES quanta.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/quanta/quanta.1 b/doc/man/quanta/quanta.1 new file mode 100644 index 00000000..5640297b --- /dev/null +++ b/doc/man/quanta/quanta.1 @@ -0,0 +1,71 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH QUANTA 1 "October 19, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +quanta \- a web development environment for TDE +.SH SYNOPSIS +.B quanta +[ \fIgeneric-options\fP ] [ \fB\-\-unique\fP ] +[ \fB\-\-nologo\fP ] [ \fIfile\fP ] +.SH DESCRIPTION +\fBQuanta Plus\fP is a web development environment for working with HTML +and associated languages. It strives to be neutral and transparent +to all markup languages, while supporting popular web-based scripting +languages, CSS and other emerging W3C recommendations. +.PP +Quanta Plus supports many external components, debuggers and other tools +for web development, several of which are shipped with the TDE web development +module. +.PP +Quanta Plus is not in any way affiliated with any commercial versions +of Quanta. The primary coders from the original team left the GPLed +version to produce a commercial product. +.PP +This application is part of the official TDE web development module. +.SH OPTIONS +Below are the quanta-specific options. For a full summary of options, +run \fIquanta \-\-help\fP. +.TP +\fB\-\-unique\fP +Run as a one-instance application. +.TP +\fB\-\-nologo\fP +Do not show the logo during startup. +.SH SEE ALSO +.BR kimagemapeditor (1), +.BR klinkstatus (1), +.BR kmdr-editor (1), +.BR kmdr-executor (1), +.BR kxsldbg (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/quanta/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/quanta/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdewebdev-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/quanta/\fP. +.SH AUTHOR +Quanta was written by Eric Laffoon <sequitur@kde.org>, Andras Mantia +<amantia@kde.org> and others including inactive authors +Dmitry Poplavsky <dima@kde.org> and Alexander Yakovlev <yshurik@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/quanta/CMakeLists.txt b/doc/quanta/CMakeLists.txt new file mode 100644 index 00000000..d6073c36 --- /dev/null +++ b/doc/quanta/CMakeLists.txt @@ -0,0 +1 @@ +tde_create_handbook( DESTINATION quanta ) diff --git a/doc/xsldbg/CMakeLists.txt b/doc/xsldbg/CMakeLists.txt new file mode 100644 index 00000000..812e1a36 --- /dev/null +++ b/doc/xsldbg/CMakeLists.txt @@ -0,0 +1,6 @@ +tde_create_handbook( DESTINATION xsldbg ) + +install( + FILES xsldbghelp.xml xsldbghelp.xsl + DESTINATION ${HTML_INSTALL_DIR}/en/xsldbg +) diff --git a/doc/xsldbg/index.docbook b/doc/xsldbg/index.docbook index 56e272b7..5e3be526 100644 --- a/doc/xsldbg/index.docbook +++ b/doc/xsldbg/index.docbook @@ -110,15 +110,3 @@ libxml installed which are available on a typical &kde; installation. &documentation.index; </book> - -<!-- -Local Variables: -mode: xml -sgml-minimize-attributes:nil -sgml-general-insert-case:lower -sgml-indent-step:0 -sgml-indent-data:nil -End: - -vim:tabstop=2:shiftwidth=2:expandtab ---> diff --git a/doc/xsldbg/xsldbghelp.xsl b/doc/xsldbg/xsldbghelp.xsl index 50e45ebd..c1587726 100644 --- a/doc/xsldbg/xsldbghelp.xsl +++ b/doc/xsldbg/xsldbghelp.xsl @@ -113,15 +113,3 @@ </xsl:template> </xsl:stylesheet> - - -<!-- initialization code for xemacs --> -<!-- -Local Variables: -mode: xsl -sgml-minimize-attributes:nil -sgml-general-insert-case:lower -sgml-indent-step:2 -sgml-indent-data:nil -End: ---> |