diff options
Diffstat (limited to 'doc/quanta')
57 files changed, 7804 insertions, 0 deletions
diff --git a/doc/quanta/Makefile.am b/doc/quanta/Makefile.am new file mode 100644 index 00000000..febd406e --- /dev/null +++ b/doc/quanta/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = $(package) +KDE_MANS = AUTO diff --git a/doc/quanta/adv-quanta.docbook b/doc/quanta/adv-quanta.docbook new file mode 100644 index 00000000..d3a142ac --- /dev/null +++ b/doc/quanta/adv-quanta.docbook @@ -0,0 +1,623 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<chapter id="advanced-quanta-3-2"> +<chapterinfo> +<title>Advanced Features</title> +<authorgroup> +<author> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> + +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</chapterinfo> + +<title>Advanced Features</title> + +<para> +This chapter outlines the advanced features of &quantaplus; and how to use +them. +</para> + +<sect1 id="xml-tools-3-2"> +<title>&XML; Tools</title> + +<para> +The 3.2 release of &quantaplus; brings with it many new &XML; tools and +features. The tools are unique in their integration within &quantaplus;. +All of these tools use <application>Kommander</application> as a front-end and +<application>libxml2</application> and <application>libxslt</application> +as a back-end. The combination of these makes for fast, efficient, +productive, and complete tools. +</para> + +<sect2 id="kde-db-3-2"> +<title>&kde; Documentation Tools</title> + +<para> +&quantaplus; supports &kde;'s two main documentation tools: +<command>meinproc</command> and <command>checkXML</command>. +</para> + +<sect3 id="meinproc-3-2"> +<title><command>meinproc</command></title> + +<para> +Anyone who has worked with &kde; documentation knows +<command>meinproc</command> and how superb it is. Well, take it up a notch +with a great graphical interface! No longer resort to a shell; just click +the icon that resembles a processor and you are done! +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Current Working Folder</guilabel></term> +<listitem> +<para> +This application expects an <filename>index.docbook</filename> +file to be present in a folder. If <filename>index.docbook</filename> +is in the current working folder, then simply leave <guilabel>Current Working +Folder</guilabel> checked. If it is not, then uncheck <guilabel>Current Working Folder</guilabel> +and enter the folder you wish to process in the <guilabel>Other Folder</guilabel> field. +</para> +</listitem> +</varlistentry> +</variablelist> + +<note> +<para> +Outputted files are placed in the same folder as the sources files. +All &HTML; files are removed each time +<command>meinproc</command> is ran. +</para> +</note> + +</sect3> + +<sect3 id="checkxml-3-2"> +<title><command>checkXML</command></title> + +<para> +Again, anyone who has worked with &kde; documentation knows this +helpful application. Again, &quantaplus; provides a great little graphical +front-end to this one. +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Current Working Folder</guilabel></term> +<listitem> +<para> +If the currently opened file is the <filename>index.docbook</filename> +file, then simply leave <guilabel>Current Working Folder</guilabel> checked. +If it is not, then uncheck <guilabel>Current Working Folder</guilabel> and +enter the folder of where <filename>index.docbook</filename> can be found. +</para> +</listitem> +</varlistentry> +</variablelist> + +<note> +<title>Output</title> +<para> +If there is output, then your file is invalid. Please correct the reported +errors and try again. +</para> +</note> +</sect3> +</sect2> + +<sect2 id="xmlval-3-2"> +<title>&XML; Validation</title> + +<para> +&quantaplus; has a great &XML; validation tool, which uses a +<command>xmllint</command> back-end. +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Current File</guilabel></term> +<listitem> +<para> +If the file to be validated is currently focused on in &quantaplus;, then +simply leave <guilabel>Current File</guilabel> checked. If it is not, then +uncheck <guilabel>Current File</guilabel> and select the file to be +validated from the Other File file selector. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Well-formed Checking</guilabel></term> +<listitem> +<para> +If you only wish to know only if the file is well-formed, click the +<guilabel>Well-formed Checking Only</guilabel> check box. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Definition &URI;</guilabel></term> +<listitem> +<para> +If you are using a &DTD; and it is specified within the &XML; file, then +select &DTD; (Internal) (default), else select &DTD; (External) and locate +the &DTD; with the Definition &URI; file selector. Both &W3C; &XML; +Schema and RelaxNG validation are required to be +externally defined via the <guilabel>Definition &URI;</guilabel> file selector. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="xsltproc-3-2"> +<title>&XSL; Processing</title> + +<para> +Yep, &quantaplus; has a &XSL; processing tool, too! This uses the +<command>xsltproc</command> tool provided with +<application>libxml2</application>. +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Current File</guilabel></term> +<listitem> +<para> +If the file to be processed is currently focused on in &quantaplus;, then +simply leave <guilabel>Current File</guilabel> checked. If it is not, +then uncheck <guilabel>Current File</guilabel> and select the file to be +processed from the <guilabel>Other File</guilabel> selector. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Stylesheet</term> +<listitem> +<para> +Select the &XSL; file that you wish to be used. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Output file name</guilabel></term> +<listitem> +<para> +Enter the name of the file that you want the resulting file to be called. +File is outputed to your home folder by default. +</para> +</listitem> +</varlistentry> +</variablelist> + +<note> +<para> +This application lacks flexibility. Sorry, we will do better next time. +</para> +</note> +</sect2> + +</sect1> + +<!-- <sect1 id="kfilereplace-3-2"> +<title>KFileReplace</title> + +<para> +KFileReplace is a terrific new addition to &quantaplus;. It allows one to +quickly replace strings over multiple files in only a few clicks of the +mouse. Imagine you have converted all your GIF images to PNG images +(hasn't everyone done this already?), only the extension has changed, and +you have the <img /> tag scattered throughout 50 XHTML files. Are you +going to do a Find & Replace on every file? Surely not when you can do +them all at the same time! This is only one of the many situations where +you will find KFileReplace a seriously helpful tool. This section will show +you how to use this wonderful feature. +</para> + +<sect2 id="using-kfr-3-2"> +<title>Using KFileReplace</title> + +<para> +With all these wonderful features KFileReplace has, surely you are +incredibly interested in how to use it! Well, make sure your swim suit +is on tight, because we are about to dive in! +</para> + +<sect3 id="start-kfr-3-2"> +<title>Starting KFileReplace</title> + +<para> +You will find KFileReplace in two places: &quantaplus;' main toolbar and the +menubar (Plugins -> KFileReplace). It is represented by this icon: +<inlinemediaobject> +<imageobject> +<imagedata fileref="kfr-icon.png" format="PNG" /> +</imageobject> +</inlinemediaobject>. +By executing it from either location, you will be presented with the New +Search & Replace Project dialog. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="kfr-new-dialog.png" format="PNG" /> +</imageobject> +<caption><para>KFileReplace's New Search & Replace Project dialog.</para></caption> +</mediaobject> + +</sect3> + +<sect3 id="replace-string-kfr-3-2"> +<title>Replacing Strings in Files Over Multiple Folders</title> + + +<para> +Your boss just gave word that: + +<orderedlist numeration="arabic"> +<listitem> +<para>all image formats will be PNG from now on;</para> +</listitem> +<listitem> +<para>all current images must be converted to PNG;</para> +</listitem> +<listitem> +<para>and it all needs to be done in one hour.</para> +</listitem> +</orderedlist> + +<quote>One hour!?!?</quote> you think to yourself. <quote>It'll take at +least 45 minutes to convert the images!</quote> Calm down. Convert +the images, load up your project, and fire up KFileReplace. Filter for +only the file types you want to change. Press the <inlinemediaobject> +<imageobject><imagedata format="PNG" fileref="" /></imageobject> +</inlinemediaobject> and for, say GIF images, .gif for the string to +replace and .png for the replacement string. +</para> + +</sect3> +</sect2> +</sect1> --> + +<sect1 id="kparts-3-2"> +<sect1info> +<title>Using Plugins</title> +<authorgroup> +<author> +<firstname>Mathieu</firstname> +<surname>Kooiman</surname> +<affiliation> +<address><email>quanta@map-is.nl</email></address> +</affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</sect1info> + +<title>Using Plugins</title> + +<sect2 id="what-is-a-plugin-3-2"> +<title>What is a Plugin?</title> + +<para> +&quantaplus; is able to load plugins, which are KParts. The +KPart framework is another very powerfull framework of &kde;. A KPart is a +relatively small, reusable container of functionality. It allows &kde; +developers to easily build on the work of other programmers. One +example of this is &quantaplus; itself. The editor &quantaplus; uses is +the &kate; KPart. The &kate; KPart already had a bunch of functionality that +&quantaplus; needed, like syntax highlighting. Integrating it into +&quantaplus; allowed the &quantaplus; developers to focus on what +&quantaplus; should be able to do, rather than facing the many problems +that developing a new editor KPart/component from scratch would bring. +</para> + +<para> +The plugins &quantaplus; loads might have nothing to do with &quantaplus; +itself. This makes it a very powerful plugin system. You can benefit from +extra functionality and need not to wait until someone integrates it into +&quantaplus;! The plugins can be loaded into a number of &GUI; elements. +More on this below. +</para> + +</sect2> + +<sect2 id="plugin-dialog-3-2"> +<title>Understanding the Edit Plugin Dialog</title> + +<para>To install a Plugin or KPart we will work from the +<menuchoice> +<guimenu>Plugins</guimenu> +<guimenuitem>Edit</guimenuitem> +</menuchoice> menu. This will bring up the following dialog: +</para> + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="plugin-edit.png" /> +</imageobject> +<caption><para>The Edit Plugin dialog.</para></caption> +</mediaobject> + +<para> +This dialog lets you manage all defined plugins and lets you add new ones. +We will describe each &GUI; element in here: + +<variablelist> +<varlistentry> +<term><guilabel>Search paths</guilabel></term> +<listitem> +<para> +Here you can fill in a search path. When adding a plugin without a +<guilabel>Location</guilabel>, &quantaplus; will search these paths to +find the plugin. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Add</guilabel></term> +<listitem> +<para> +This will bring up a dialog which allows you to add a new plugin. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Configure</guilabel></term> +<listitem> +<para> +This will allow you to change the settings of a particular plugin. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Remove</guilabel></term> +<listitem> +<para> +Removes the currently selected plugin. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Refresh</guilabel></term> +<listitem> +<para> +Refreshes the dialog's contents. +</para> +</listitem> +</varlistentry> +</variablelist> +</para> +<para>Read <xref linkend="configure-plugins" /> to learn more about plugins.</para> +</sect2> +</sect1> +<sect1 id="team-members"> + <title>Team Development</title> + <para>Often a project has more than one people working on it and there is some kind of hierarchical relationsship between them. &quantaplus; supports the notion of team members and they are configurable in the +<menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F7</keycap></keycombo> +</shortcut> +<guimenu>Project</guimenu> +<guimenuitem>Project Properties</guimenuitem> +</menuchoice> dialog. + </para> + <mediaobject> + <imageobject> + <imagedata format="PNG" fileref="team-editing.png" /> + </imageobject> + <caption><para>The team member editor dialog</para></caption> + </mediaobject> + <para> + The <guilabel>Name</guilabel>, <guilabel>Email</guilabel> entries are self explaining. <guilabel>Nickname</guilabel> is the nick of the user and acts as an unique identifier. + </para> + <para><guilabel>Role</guilabel> specifies the role of the member in the project and can be one of the following: +<itemizedlist> +<listitem><para> +<guilabel>Team leader</guilabel> +</para></listitem> +<listitem><para> +<guilabel>Subproject Leader</guilabel> +</para></listitem> +<listitem><para> +<guilabel>Task Leader</guilabel> +</para></listitem> +<listitem><para> +<guilabel>Simple Member</guilabel> +</para></listitem> +</itemizedlist> +</para> +<para><guilabel>Task</guilabel> is a description of the task assigned to this member.</para> +<para><guilabel>Subproject</guilabel>: you can select a list of subproject. Subprojects can be configured and created by pressing the <guilabel>Edit subprojects</guilabel> button. Each subproject has a user visible name and a location entry, the later specifying a relative path to a directory under the project tree. This means that a subproject is a directory under the main project. For example the main project can be the website of your company, while a subproject can be the website for the intranet, located under the <filename path="intranet">intranet</filename> folder in the project.</para> +<para>One member can have more than one role in the project, like both team leader and subproject leader.</para> +<para>The user should select who is himself from the list of the team members. This is possible by selecting a team member from the list and pressing the <guilabel>Set to Yourself</guilabel> button. The currently selected member (your identity) appears in bold after the <guilabel>You are:</guilabel> text.</para> +<para>Nicknames and setting yourself is important regarding messaging and annotations. See <xref linkend="annotations"/> to learn more about annotations.</para> +<para>Aside of keeping track of your team, there is one more benefit of setting up the team members: you can configure an event to inform the team leaders when some action happens. See <xref linkend="event-actions"/> about how to do it.</para> +</sect1> +<sect1 id="event-actions"> + <title>Event Actions</title> + <para>Event actions are actions executed when some event happens in the project. An example would be logging when the project was opened and closed, so it can be later reviewed how much one worked on it, or sending a mail when a file is saved, or adding the file to the CVS with the help of a script when the file is added to the project and the list could continue.</para> + <para>On the <guilabel>Event Configuration</guilabel> page of the + <menuchoice> + <shortcut> + <keycombo action="simul">&Shift;<keycap>F7</keycap></keycombo> + </shortcut> + <guimenu>Project</guimenu> + <guimenuitem>Project Properties</guimenuitem> + </menuchoice> dialog you can create, edit and delete the event actions. +</para> +<mediaobject> + <imageobject> + <imagedata format="PNG" fileref="event-editing.png" /> + </imageobject> + <caption><para>The event editor dialog</para></caption> +</mediaobject> +<para>The entries in the dialog are:</para> +<variablelist> +<varlistentry> +<term><guilabel>Event</guilabel></term> +<listitem><para>the action is executed when the event selected from the list happens. The event names are self explanatory.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Action</guilabel></term> +<listitem><para> +the type of the executed action. The possible choices are +</para> +<variablelist> +<varlistentry> +<term><guilabel>Non-script action</guilabel></term> +<listitem><para>an action that is not a user defined script action. See <xref linkend="user-actions" /> for user action. +</para> +<para><guilabel>Action name</guilabel> specifies the action to be executed when the event happens.</para> +</listitem> +</varlistentry> +<varlistentry> + <term><guilabel>Send email</guilabel></term> + <listitem><para>an email is sent when the action happens to the recipient selected in the <guilabel>Receiver</guilabel> list. The recipient can be a team or subproject leader. See <xref linkend="team-members" /> for defining such leaders. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term><guilabel>Log event</guilabel></term> + <listitem><para>the event is logged in a file. The arguments for this action are: + </para> + <variablelist> + <varlistentry> + <term><guilabel>Log file</guilabel></term> + <listitem><para>the filename with full path</para></listitem> + </varlistentry> + <varlistentry> + <term>Detail</term> + <listitem><para>How much information will the log contain</para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Behavior</guilabel></term> + <listitem><para>Whether to create/overwrite the existing log file or append the new logged event to it.</para></listitem> + </varlistentry> + </variablelist> + </listitem> +</varlistentry + > +<varlistentry> +<term><guilabel>Script action</guilabel></term> +<listitem><para>an user defined script action. See <xref linkend="user-actions" /> for user action. + </para> + <para><guilabel>Action name</guilabel> specifies the action to be executed when the event happens.</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> +</variablelist> +<para>The other entries depend on the <guilabel>Action</guilabel> type as they were described. +</para> +</sect1> + +<sect1 id="annotations"> +<title>Annotations</title> +<para>Annotations are special comments in the documents. They differ from regular comments by the following things: +<itemizedlist> +<listitem><para> +the information is collected by Quanta and shown in the <guilabel>Annotations</guilabel> toolview. +</para></listitem> +<listitem><para> +the information can be addressed to a team member +</para></listitem> +</itemizedlist> +</para> +<para>Entering annotations is simple. You can either use the <guilabel>Annotate</guilabel> entry from the editor context menu or enter the <emphasis>@annotation</emphasis> keyword in a comment area followed by the annotation text. +<example><title>Annotation example in XML</title><screen> +<!-- @annotation It is possible that this code is wrong. --></screen> +<screen> +<!-- @annotation + Multiline + annotation. +--></screen></example> +<example><title>Annotation example in PHP</title><screen> +/* @annotation +Use PHP comments when annotating a PHP area +*/</screen> + +</example> +</para> +<para>Annotations can be addressed for a specific member of your team. The syntax in this case is <emphasis>@annotation(nickname)</emphasis> or <emphasis>@annotation(role)</emphasis>, where <emphasis>nickname</emphasis> is the nickname of a team member, while <emphasis>role</emphasis> is a project role from the following items: +<itemizedlist> +<listitem><para> +team leader +</para></listitem> +<listitem><para> +task leader +</para></listitem> +<listitem><para> +subproject leader +</para></listitem> +</itemizedlist> +The task and subproject leaders should be followed by the corresponding task and subproject name, like it is shown in the below examples. +</para> +<para> +<example><title>Make a note to a team member with the nickname <emphasis>eric</emphasis></title> +<screen><-- @annotation(eric) Eric, please look at this. Andras --></screen> +</example> +<example><title>Inform the team leader</title> +<screen><-- @annotation(team leader) This is very important for the team --></screen> +</example> +<example><title>Inform the <emphasis>PHP</emphasis> subproject leader</title> +<screen>// @annotation(subproject leader:PHP) What do you think about it?</screen> +</example> +</para> +<para>Nicknames and role names are case insensitive, but spaces around brackets and the <emphasis>:</emphasis> make the annotation invalid.</para> +<para>More about team members, roles and nicknames can be found in <xref linkend="team-members"/>.</para> +<para> +The annotations found in the project can be inspected in the <guilabel>Annotations</guilabel> view. It consists of tree tabs: +<variablelist> +<varlistentry> +<term><guilabel>Current File</guilabel></term> +<listitem><para> +The annotation found in the current file.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>For You</guilabel></term> +<listitem><para> +Annotations in the project addressed for you. The entries are groupped per file. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>All Files</guilabel></term> +<listitem><para> +The annotations found in all the project files, groupe dy files +</para></listitem> +</varlistentry> +</variablelist> +The annotations are scanned on project and file load for external modifications. This way even is somebody adds an annotation outside of &quantaplus;, it will be recognized. As scanning can take some time, the information dialog about new annotations addressed for you might appear after some seconds of the project loading. +</para> +</sect1> +<!--<sect1 id="cvs-3-2"> +<title>Using CVS</title> + +<para> +&quantaplus; uses Cervisia for CVS. Explain its usage within &quantaplus;. +</para> +</sect1> --> + +&debugging-quanta; +</chapter> diff --git a/doc/quanta/attribute_tree.png b/doc/quanta/attribute_tree.png Binary files differnew file mode 100644 index 00000000..a823dc6c --- /dev/null +++ b/doc/quanta/attribute_tree.png diff --git a/doc/quanta/config-quanta.docbook b/doc/quanta/config-quanta.docbook new file mode 100644 index 00000000..4f8c9a1f --- /dev/null +++ b/doc/quanta/config-quanta.docbook @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<chapter id="quanta-configuring"> + <chapterinfo> + <title>Configuring &quantaplus;</title> + <authorgroup> + <author> + <firstname>András</firstname> + <surname>Mantia</surname> + <affiliation> + <address><email>amantia@kde.org</email></address> + </affiliation> + </author> + + <!-- TRANS:ROLES_OF_TRANSLATORS --> + + </authorgroup> + </chapterinfo> + + <title>Configuring &quantaplus;</title> + + <para> + This chapter describes how you can control the behavior of &quantaplus;. + </para> + <para> + The configuration dialogs are accessible from the <guilabel>Settings</guilabel> menu. Here we will discuss only few of them, the rest are not &quantaplus; specific and a short description can be found at <xref linkend="settings-menu-3-2" />. + </para> + + <sect1 id="configure-quanta"> + <title>Configuring Quanta</title> + <para>The configuration dialog can be invoked by using <menuchoice><guimenu>Settings</guimenu><guimenu>Configure Quanta...</guimenu></menuchoice>. The dialog has several pages, we will discuss them one by one. + </para> +<variablelist> +<varlistentry> +<term><guilabel>Tag Style</guilabel></term> +<listitem><para>You can change the behavior of &quantaplus; related to tags, including autocompletion. The entries are: +<itemizedlist> +<listitem><para><guilabel>Tag case:</guilabel> the case of the automatically inserted tags. <guilabel>Default Case</guilabel> means the tags will be inserted as they are described in the <link linkend="tagxml-3-2">tagXML</link> files.</para></listitem> +<listitem><para><guilabel>Attribute case:</guilabel> the case of the automatically inserted attributes. <guilabel>Default Case</guilabel> means the attributes will be inserted as they are described in the <link linkend="tagxml-3-2">tagXML</link> files.</para></listitem> +<listitem><para><guilabel>Attribute quotation:</guilabel> how to quote attributes inserted by &quantaplus;.</para></listitem> +<listitem><para><guilabel>Auto-close optional tags:</guilabel> if checked, tags for which closing tag is option will be automatically closed once the tag closing > is entered.</para></listitem> +<listitem><para><guilabel>Auto-close non-single and non-optional tags:</guilabel> same as before for the rest of tags, exception being the single tags.</para></listitem> +<listitem><para><guilabel>Use auto-completion:</guilabel> turn on/off the autocompletion of tags, attributes, functions, etc. +</para></listitem> +<listitem><para><guilabel>Update opening/closing tag automatically:</guilabel> if enabled, whenever you change the opening tag, the corresponding closing tag will be changed as well and vice-versa.</para></listitem> +<listitem><para><guilabel>Automatic replacement of the accented characters:</guilabel> if enabled the accented characters will be replaced with their codes as you type.</para></listitem> +</itemizedlist> +</para> +</listitem> + +</varlistentry> + +<varlistentry> +<term><guilabel>Environment</guilabel></term> +<listitem><para>A page to control the environment and some default settings. +</para> +<itemizedlist> +<listitem><para><guilabel>Mimetypes:</guilabel> mimetypes used to recognize different kind of files. Use the <guilabel>Reset to Default</guilabel> button to fill in the entries with the default settings.</para></listitem> +<listitem><para><guilabel>Default character encoding:</guilabel> the encoding of the newly created files, or files loaded in other way than <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice> (where you can override the encoding). This setting is overridden by the same setting in the <guilabel>Project Properties</guilabel> if a project is loaded.</para></listitem> +<listitem><para><guilabel>Default DTD:</guilabel> the DTD used for newly created files, or files whose DTD was not recognized. This setting is overridden by the same setting in the <guilabel>Project Properties</guilabel> if a project is loaded.</para></listitem> +<listitem><para><guilabel>Create backups:</guilabel> &quantaplus; will create backup files periodically, so in case of power failure or crash, on the next startup the document can be restored from this backup. This is not the same as the backup created on file save. Even for not-yet saved documents there is a backup created.</para></listitem> +<listitem><para><guilabel>Startup Options:</guilabel> self explanatory setting which control what will happen on startup.</para></listitem> + +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>User Interface</guilabel></term> +<listitem><para>Here you can control the look and feel of &quantaplus;. +</para> +<para>The preview and the documentation can appear in the editor area or in a separate toolview, in which case it's possible to look at the documentation/preview and the source as well.</para> +<para>It's also possible to configure the look of the toolview and document tabs.</para> +<para><guilabel>Reset window layout to the default on the next startup</guilabel> is useful when you have messed up the user interface by changing the MDI modes and docking/undocking the toolviews. It is the same as the <command>--resetlayout</command> command line switch.</para> +<para>This is the place also to control the behavior of the file trees.</para> +<para>The <guilabel>Warning Messages</guilabel> section is useful to enable or disable the warning messages that can be dismissed by checking the <guilabel>Do not show again</guilabel> box in them.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>VPL View</guilabel></term> +<listitem><para>The place to change the &VPL; behavior. You can enable the showing of an icon in place of scripts as well as configure the synchronization of the VPL and source view when the splitted mode is activated. See <xref linkend="view-menu-3-2"/> to learn how to activate the different modes. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Parser</guilabel></term> +<listitem><para>Here you can fine-tune the parser and the structure tree, which is the visual representation of the parser nodes in the document.</para> +<para>In the <guilabel>Clicks on Structure Tree Items</guilabel> it is possible to change the actions assigned to mouse buttons when you click on the structure tree.</para> +<para>In the <guilabel>Structure Tree Look & Feel</guilabel> it is possible to configure what kind of nodes are visible in the tree, how often is the tree updated while editing and on an update how deeply should be the structure tree automatically opened. Empty nodes are the white-space text nodes, while empty groups are groups for whom there was no element found in the current document.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Abbreviations</guilabel></term> +<listitem><para> +The place to define abbreviations (some kind of templates), that can be expanded to bigger text while editing. Abbreviations are organized in groups, each group can be valid for more than one &DTEP;. This means you can have a group valid for PHP where the "ifclause" abbreviation template means something else than in a group valid for JavaScript.</para></listitem> +</varlistentry> + +</variablelist> + + </sect1> + +<sect1 id="configure-actions"> +<title>Configuring Actions</title> +<para>User defineable action creation and editing is described in <xref linkend="user-actions"/>.</para> +</sect1> + +<sect1 id="configure-plugins"> + <title>Configuring Plugins</title> + <para>Here you can manage your plugins. Plugins are KPart applications written by third parties that can be reused in any KPart aware application, the most known being &konqueror;. When creating a plugin you must specify the: + <itemizedlist> + <listitem><para><guilabel>Name:</guilabel> the user visible name</para></listitem> + <listitem><para><guilabel>Output window:</guilabel> plugins can appear in a tab of the editor area or in a separate toolview at the bottom</para></listitem> + <listitem><para><guilabel>Location:</guilabel> the path to the plugin, if it is not located in the standard locations, like <filename class="directory">$<envar>KDEDIR</envar>/lib</filename> .</para></listitem> + <listitem><para><guilabel>File name:</guilabel> the relative path and the filename to the plugin's libtool file, like <filename class="libraryfile">kde3/libcervisiapart.la</filename></para></listitem> + <listitem><para><guilabel>Input:</guilabel> the plugin will get this information on startup, so it can open the <guilabel>Current File</guilabel>, the folder of the current file (<guilabel>Current File Path</guilabel>) or the <guilabel>Project Folder</guilabel>.</para></listitem> + <listitem><para><guilabel>Read only part:</guilabel> check if the plugin refuses to load. Read-only KParts usually refuse to load without this option checked.</para></listitem> + <listitem><para><guilabel>Validate plugin:</guilabel> if checked, &quantaplus; will test if the entered information is correct or not. Uncheck if the plugin is not yet available, but you will install later, so you can close the dialog.</para></listitem> +</itemizedlist> + </para> + <para>See <xref linkend="plugins-menu-3-2" /> and <xref linkend="kparts-3-2" /> for information about using the plugins.</para> +</sect1> +</chapter> diff --git a/doc/quanta/contents2.png b/doc/quanta/contents2.png Binary files differnew file mode 100644 index 00000000..e2a44eca --- /dev/null +++ b/doc/quanta/contents2.png diff --git a/doc/quanta/credits-license.docbook b/doc/quanta/credits-license.docbook new file mode 100644 index 00000000..65f44e5a --- /dev/null +++ b/doc/quanta/credits-license.docbook @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<chapter id="credits-license-3-2"> +<chapterinfo> +<title>Credits and License</title> +<authorgroup> +<author> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</chapterinfo> + +<title>Credits and License</title> + +<note> +<para> +Sorry to anyone I missed or if I mis-spelt your name! +</para> +</note> + +<para> +Much thanks to everyone who has spent the time to contribute! +</para> + +<variablelist> +<title>The &quantaplus; Development Team:</title> + +<varlistentry> +<term>Bergia, Andrea</term> +<listitem><para>Original &CSS; editor.</para></listitem> +</varlistentry> +<varlistentry> +<term>Britton, Marc</term> +<listitem><para><application>Kommander</application>, various features, and bug fixes.</para></listitem> +</varlistentry> +<varlistentry> +<term>Colton, Matthew</term> +<listitem><para>Splash screen for many versions</para></listitem> +</varlistentry> +<varlistentry> +<term>Deschildre, Nicolas</term> +<listitem><para><application>Visual Page Layout</application> & undo/redo system</para></listitem> +</varlistentry> +<varlistentry> +<term>Dmitrienko, Dmitri</term> +<listitem><para>&PHP;4 debugger</para></listitem> +</varlistentry> +<varlistentry> +<term>Gulmini, Luciano</term> +<listitem><para><application>Frame Wizard</application></para></listitem> +</varlistentry> +<varlistentry> +<term>Hanley, Jason P.</term> +<listitem><para>Various fixes, foundational code for &DTD; parsing, and other &DTD; related work</para></listitem> +</varlistentry> +<varlistentry> +<term>Hindsgaul, Claus</term> +<listitem><para>Danish translation</para></listitem> +</varlistentry> +<varlistentry> +<term>Hornbaker, Christopher</term> +<listitem><para>The Anal &XML; Guy & Documentation</para></listitem> +</varlistentry> +<varlistentry> +<term>Isdale, Keith</term> +<listitem><para>&XSL; 1.0 &DTEP;, <application>&kxsl;</application></para></listitem> +</varlistentry> +<varlistentry> +<term>Kooiman, Mathieu</term> +<listitem><para>Documentation, bug fixes, and &PHP; debugger framework.</para></listitem> +</varlistentry> +<varlistentry> +<term>Laffoon, Eric</term> +<listitem><para>Project Manager and web site admin.</para></listitem> +</varlistentry> +<varlistentry> +<term>Mantia, András</term> +<listitem><para>Core Developer</para></listitem> +</varlistentry> +<varlistentry> +<term>Moore, Richard</term> +<listitem><para>Coding, original TagXML docs, and more</para></listitem> +</varlistentry> +<varlistentry> +<term>Mous, Fabrice</term> +<listitem><para>Documentation</para></listitem> +</varlistentry> +<varlistentry> +<term>Nickel, Robert C.</term> +<listitem><para>Documentation</para></listitem> +</varlistentry> +<varlistentry> +<term>Pibil, Ted</term> +<listitem><para>Addition and maintainence of &DTD;s</para></listitem> +</varlistentry> +<varlistentry> +<term>Poplavsky, Dmitry</term> +<listitem><para>ex-Core Developer — left for commercial version</para></listitem> +</varlistentry> +<varlistentry> +<term>Vilches, George</term> +<listitem><para>Tree-based upload dialog</para></listitem> +</varlistentry> +<varlistentry> +<term>Yakovlev, Alexander</term> +<listitem><para>ex-Core Developer — left for commercial version</para></listitem> +</varlistentry> +<!-- +<varlistentry> +<term>Firstname Surname</term> +<listitem><para>Function</para></listitem> +</varlistentry> +--> + +</variablelist> + +<variablelist> +<title>Special Thanks To:</title> + +<varlistentry> +<term>xmlsoft.org</term> +<listitem><para>The writers of <application>libxml2</application> and <application>libxslt</application>.</para></listitem> +</varlistentry> +<!-- +<varlistentry> +<term>Name</term> +<listitem><para>Function</para></listitem> +</varlistentry> +--> + +</variablelist> + +<para> +&quantaplus; <trademark class="copyright" /> 2000, 2001, 2002, 2003 &quantaplus; Development Team. +</para> + +<para> +&quantaplus; User Manual <trademark class="copyright" /> 2002, 2003 &quantaplus; Development Team. +</para> + +&underFDL; +&underGPL; +</chapter> diff --git a/doc/quanta/debugging-quanta.docbook b/doc/quanta/debugging-quanta.docbook new file mode 100644 index 00000000..88ad9bc1 --- /dev/null +++ b/doc/quanta/debugging-quanta.docbook @@ -0,0 +1,400 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<sect1 id="debugging-3-2"> +<sect1info> +<title>Debugging in &quantaplus;</title> +<authorgroup> +<author> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +</author> + +<author> +<firstname>Linus</firstname> +<surname>McCabe</surname> +<affiliation> +<address><email>Linus@McCabe.nu</email></address> +</affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</sect1info> + +<title>Debugging in &quantaplus;</title> + +<sect2 id="php-debugging-3-2"> +<title>Using the &PHP; Debugger</title> + +<para> +With &quantaplus; version 3.3, the debugger handling was reimplemented. +The support for the now obsolete &PHP; (3) builtin debugger and was dropped, +as was the support for the dbg debugger. Instead, a general debug plugin system +was developed, to allow different plugin implementations. +</para> +<para> +Currently only one plugin is available which adds support to use &gubed; with +&quantaplus;. +</para> +<para> +To use a debugger for your project, open the project settings and chose a suitable +debugger plugin. To alter debugger specific settings, press the 'Options' button +next to the debugger plugin drop down. +</para> + +<sect3 id="php-debuggin-3-2-general"> +<title>General usage</title> +<para> +Once a project has a debugger activated, a few additional items will appear in the +&quantaplus; user interface: +</para> + +<variablelist> +<varlistentry> +<term>Debugger menu</term> +<listitem> +<para> +A new menu will appear where you can reach most of the debugger functionality. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Debugger toolbar</term> +<listitem> +<para> +A toolbar with access to the most common debugging commands. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Variables toolview</term> +<listitem> +<para> +A toolview where the contents of watched variables is showed. Appears in the left dock by default. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Breakpoints toolview</term> +<listitem> +<para> +A toolview where all the breakpoints, line and conditional, are listed. Appears in the bottom dock by default. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Debug Output toolview</term> +<listitem> +<para> +A toolview where the output (as in HTML) of the debugger is shown. Appears in the bottom dock by default. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<para> +Depending on what the debugger plugin supports, all or a subset of the following functionality will be available. +</para> + + + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Session</guimenuitem> +<guimenuitem>Start Session</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +This action is used to connect to the debugger if that is required, or tell the plugin to start listening for debug requests. +This action is triggered by default when a project using a debugger is opened, so usually you don't need to care about it. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Session</guimenuitem> +<guimenuitem>End Session</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +The opposite of +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Session</guimenuitem> +<guimenuitem>Start Session</guimenuitem> +</menuchoice>. Closes a connection to the debugger or stops listening for requests. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Execution</guimenuitem> +<guimenuitem>Send HTTP Request</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Sends a HTTP request to the server to initiate a debug request. Using this action is equivalent to +using a browser to look at the current document. The output of the request ends up in the Debug +Output dock. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Execution</guimenuitem> +<guimenuitem>Pause</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Pauses a running script +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Execution</guimenuitem> +<guimenuitem>Run</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Tells the debugger to start executing the script and send information about watched variables and current +line of execution as it goes along. If this is done while a script is paused, execution will proceed. If it's done +before a debug request is initiated, the script will start running as soon as the request is initiated. +</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Execution</guimenuitem> +<guimenuitem>Leap</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Tells the debugger to start executing the script without sending information about watched variables and current +line of execution. If this is done while a script is paused, execution will proceed. If it's done +before a debug request is initiated, the script will start leaping as soon as the request is initiated. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Execution</guimenuitem> +<guimenuitem>Step</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Tells the debugger to execute the next instruction in the script, without stepping into functions or inclusions. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Execution</guimenuitem> +<guimenuitem>Step Into</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Tells the debugger to execute the next instruction in the script, stepping into functions or inclusions if possible. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Execution</guimenuitem> +<guimenuitem>Step Out</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Tells the debugger to execute until it escapes the current function. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Execution</guimenuitem> +<guimenuitem>Skip</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Tells the debugger to skip the next instruction and proceed to the next one as if the current one didn't exist. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Execution</guimenuitem> +<guimenuitem>Kill</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Tells the debugger to kill the currently running script. +</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Breakpoints</guimenuitem> +<guimenuitem>Break when...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Opens a dialog where you can specify conditional breakpoints. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Breakpoints</guimenuitem> +<guimenuitem>Toggle breakpoint</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggles a line breakpoint at the line of the cursor in the current line +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Breakpoints</guimenuitem> +<guimenuitem>Clear breakpoints</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Clears all the breakpoints. +</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Variables</guimenuitem> +<guimenuitem>Watch variable</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Opens a dialog where you can enter a variable or expression you wish to watch. The value of the watch will appear +in the variables tool view. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Debug</guimenu> +<guimenuitem>Variables</guimenuitem> +<guimenuitem>Set value of variable</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Opens a dialog where you can enter a variable and a new value for it. +</para> +</listitem> +</varlistentry> + + + +</variablelist> + + + +</sect3> +</sect2> + +<sect2 id="kxsldbg-debugging-3-2"> +<title>Using &kxsl;, the &XSL; Debugger</title> + +<para> +&kxsl; is the creation of Keith Isdale, as is this section of the +documentation. &kxsl; is a &kde; front-end and a KPart to +<command>xsldbg</command>, which you can find at +http://xsldbg.sf.net along with many other works by +Keith. +</para> + +<para> +To start &kxsl;, select +<menuchoice> +<guimenu>Plugins</guimenu> +<guimenuitem>&kxsl;</guimenuitem> +</menuchoice>. +</para> + +<para> +Please refer to the &kxsl; documentation for further information +regarding its usage. +</para> +</sect2> +</sect1> diff --git a/doc/quanta/doc-view1.png b/doc/quanta/doc-view1.png Binary files differnew file mode 100644 index 00000000..e6a405ff --- /dev/null +++ b/doc/quanta/doc-view1.png diff --git a/doc/quanta/dtd-conversion.png b/doc/quanta/dtd-conversion.png Binary files differnew file mode 100644 index 00000000..c0213063 --- /dev/null +++ b/doc/quanta/dtd-conversion.png diff --git a/doc/quanta/dtep_doc_img15.png b/doc/quanta/dtep_doc_img15.png Binary files differnew file mode 100644 index 00000000..0f7e31a1 --- /dev/null +++ b/doc/quanta/dtep_doc_img15.png diff --git a/doc/quanta/dtep_doc_img18.png b/doc/quanta/dtep_doc_img18.png Binary files differnew file mode 100644 index 00000000..078801bd --- /dev/null +++ b/doc/quanta/dtep_doc_img18.png diff --git a/doc/quanta/dtep_doc_img21.png b/doc/quanta/dtep_doc_img21.png Binary files differnew file mode 100644 index 00000000..f5d922bb --- /dev/null +++ b/doc/quanta/dtep_doc_img21.png diff --git a/doc/quanta/dtep_doc_img22.png b/doc/quanta/dtep_doc_img22.png Binary files differnew file mode 100644 index 00000000..8871bdd8 --- /dev/null +++ b/doc/quanta/dtep_doc_img22.png diff --git a/doc/quanta/dtep_doc_img23.png b/doc/quanta/dtep_doc_img23.png Binary files differnew file mode 100644 index 00000000..62e965c1 --- /dev/null +++ b/doc/quanta/dtep_doc_img23.png diff --git a/doc/quanta/dtep_doc_img24.png b/doc/quanta/dtep_doc_img24.png Binary files differnew file mode 100644 index 00000000..1fc30841 --- /dev/null +++ b/doc/quanta/dtep_doc_img24.png diff --git a/doc/quanta/dtep_doc_img25.png b/doc/quanta/dtep_doc_img25.png Binary files differnew file mode 100644 index 00000000..bac85056 --- /dev/null +++ b/doc/quanta/dtep_doc_img25.png diff --git a/doc/quanta/dtep_doc_img7.png b/doc/quanta/dtep_doc_img7.png Binary files differnew file mode 100644 index 00000000..a47ea1dc --- /dev/null +++ b/doc/quanta/dtep_doc_img7.png diff --git a/doc/quanta/dtep_doc_img8.png b/doc/quanta/dtep_doc_img8.png Binary files differnew file mode 100644 index 00000000..6ade4fe2 --- /dev/null +++ b/doc/quanta/dtep_doc_img8.png diff --git a/doc/quanta/edit-upload-profile.png b/doc/quanta/edit-upload-profile.png Binary files differnew file mode 100644 index 00000000..c9ea5c23 --- /dev/null +++ b/doc/quanta/edit-upload-profile.png diff --git a/doc/quanta/event-editing.png b/doc/quanta/event-editing.png Binary files differnew file mode 100644 index 00000000..2f0205dc --- /dev/null +++ b/doc/quanta/event-editing.png diff --git a/doc/quanta/exec.png b/doc/quanta/exec.png Binary files differnew file mode 100644 index 00000000..c6c1c8c3 --- /dev/null +++ b/doc/quanta/exec.png diff --git a/doc/quanta/extending-quanta.docbook b/doc/quanta/extending-quanta.docbook new file mode 100644 index 00000000..6dd0629e --- /dev/null +++ b/doc/quanta/extending-quanta.docbook @@ -0,0 +1,1789 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<chapter id="extending-quanta-3-2"> +<chapterinfo> +<title>Extending &quantaplus;</title> +<authorgroup> +<author> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +</author> +<author> +<firstname>András</firstname> +<surname>Mantia</surname> +<affiliation> +<address><email>amantia@kde.org</email></address> +</affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</chapterinfo> + +<title>Extending &quantaplus;</title> + +<para> +This chapter describes how to customize &quantaplus; to your particular +needs and how you can help &quantaplus; become better. +</para> + +<!--<sect1 id="kommander-3-2"> +<title>Using Kommander With &quantaplus;</title> + +<para> +Kommander, by Marc Britton. +</para> +</sect1> --> + +<sect1 id="dtep-intro-3-2"> +<title>Document Type Editing Package (&DTEP;)</title> + +<para> +Document Type Editing Packages (&DTEP;s) are used in &quantaplus; to add +support for markup, scripting languages, and &CSS;. They allow +&quantaplus; to provide features like auto-completion and node trees. +Their simplicity and flexibility are what make &quantaplus; a fast, +developer friendly &IDE; for web developers. They are what make &quantaplus; +an easy-to-use, productive environment. +</para> + +<para> +&DTEP;s come in two flavors, Family 1, which are markups, and Family 2, +which are scripting and &CSS;. &DTEP;s are made up of two parts, the Tag +Folder and the Toolbars. Tag Folders are composed of two types of files, +the &descriptionrc; and TagXML files, which carry the extension .tag. +Toolbars are the handy, icon-oriented tabs of buttons (above the editing +window) which place text into a document faster than the user can type. +</para> + +<para> + &DTEP;s can be created manually (see below), <link linkend="download-resources">downloaded</link> or automatically created from an existing DTD. See <xref linkend="converting-dtd" /> for details about the conversion. +</para> + +<para> +This document describes how to make TagXML files, the &descriptionrc;, and +toolbars. In short, a &DTEP;. +</para> + +<para> +TagXML files (.tag) define both the attributes specific to a tag and the +layout and contents of the properties dialog &quantaplus; shows for the tag. +The &descriptionrc; file provides rules and information on the &DTEP; +itself. Toolbars provide a quick means for adding tags into a document +without worry of mis-spellings and such. +</para> + +<sect2 id="dtep-packaging-3-2"> +<title>Packaging</title> + +<para> +Tag Folders are just that, folders. They are composed only of the +&descriptionrc; and TagXML files. Tag Folders carry the name of the mark-up +language and version, if applicable. (For example, html-4.01-strict) +</para> +</sect2> + +<sect2 id="tagxml-3-2"> +<title>TagXML</title> + +<para> +The table below lists the elements defined in TagXML and declares whether +they are required or not. While not all are required, it is recommended +that you use as many as you can so that other users can have a better +experience and more information to work with. +</para> + +<informaltable> +<tgroup cols="3"> +<thead> +<row> +<entry>Element</entry> +<entry>Default Usage</entry> +<entry>Case Usage</entry> +</row> +</thead> +<tbody> +<row> +<entry>TAGS</entry> +<entry>required</entry> +<entry>always</entry> +</row> +<row> +<entry>tag</entry> +<entry>required</entry> +<entry>always</entry> +</row> +<row> +<entry>label</entry> +<entry>optional</entry> +<entry>required to create a properties dialog</entry> +</row> +<row> +<entry>attr</entry> +<entry>optional</entry> +<entry>required to define an attribute</entry> +</row> +<row> +<entry>tooltip</entry> +<entry>optional</entry> +<entry>required to have the properties dialog display a tooltip</entry> +</row> +<row> +<entry>whatsthis</entry> +<entry>optional</entry> +<entry>required to have the properties dialog display a <quote>What's This +</quote></entry> +</row> +<row> +<entry>list</entry> +<entry>optional</entry> +<entry>required when an attr is of the type <quote>list</quote></entry> +</row> +<row> +<entry>item</entry> +<entry>optional</entry> +<entry>required when <list> is used</entry> +</row> +<row> +<entry>textlocation</entry> +<entry>optional</entry> +<entry>always</entry> +</row> +<row> +<entry>location</entry> +<entry>optional</entry> +<entry>required when label is used</entry> +</row> +<row> +<entry>text</entry> +<entry>optional</entry> +<entry>required when label is used</entry> +</row> +<row> +<entry>children</entry> +<entry>optional</entry> +<entry>list of tags that can appear within the tag being defined</entry> +</row> +<row> +<entry>child</entry> +<entry>required</entry> +<entry>a children entry</entry> +</row> +<row> +<entry>stoppingtags</entry> +<entry>optional</entry> +<entry>list of tags that tell another tag to end</entry> +</row> +<row> +<entry>stoppingtag</entry> +<entry>required</entry> +<entry>a stoppingtags entry</entry> +</row> +</tbody> +</tgroup> +</informaltable> + + +<sect3 id="dtep-element-descriptions-3-2"> +<title>TagXML Element Descriptions</title> + +<para> +The following sections will describe, in detail, each element. Everything +from where they can go to what goes in them is layed out in an +easy-to-follow manner. +</para> + +<sect4 id="TAGS-3-2"> +<title>TAGS</title> + +<para> +This is the root element of a TagXML document. It may appear in a document +only once. It can contain the definition of multiple tags. This is an +element-only type element. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry> +<entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry><emphasis>NONE</emphasis></entry> +<entry>tag</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="tag-3-2"> +<title>tag</title> + +<para> +Wrapper for tag being defined. This is an element-only type element. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry> +<entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>TAGS</entry> +<entry>label, attr, stoppingtags</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<informaltable> +<tgroup cols="6"> +<thead> +<row> +<entry>Attribute</entry><entry>Type</entry><entry>Values</entry> +<entry>Default</entry><entry>Use</entry><entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>name</entry><entry>string</entry><entry></entry><entry></entry> +<entry>required</entry><entry>Specifies the name of the tag being defined.</entry> +</row> +<row> +<entry>single</entry><entry>boolean</entry><entry></entry><entry></entry> +<entry>optional</entry><entry>Specifies whether or not the tag requires a +closing tag </(tagname)>.</entry> +</row> +<row> +<entry>type</entry><entry>string</entry><entry></entry><entry>xmltag</entry> +<entry>optional</entry><entry>Specifies the type of tag being defined.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>xmltag</entry><entry></entry> +<entry></entry><entry>Type of tag is XML-based. (Family 1 only.)</entry> +</row> +<row> + <entry></entry><entry></entry><entry>entity</entry><entry></entry> + <entry></entry><entry>The tag describes an entity. (Family 1 only.)</entry> +</row> +<row> +<entry></entry><entry></entry><entry>property</entry><entry></entry> +<entry></entry><entry>Type of tag is &CSS; related. (Family 2 only.)</entry> +</row> +<row> +<entry></entry><entry></entry><entry>function</entry><entry></entry> +<entry></entry><entry>Type of tag is a script function. When used, +<attr> becomes arguments of the function. (Family 2 only.)</entry> +</row> +<row> +<entry></entry><entry></entry><entry>class</entry><entry></entry> +<entry></entry><entry>Type of tag is a script class. (Family 2 only.)</entry> +</row> +<row> +<entry></entry><entry></entry><entry>method</entry><entry></entry> +<entry></entry><entry>Type of tag is a class method. (Family 2 only.)</entry> +</row> +<row> +<entry>returnType</entry><entry>string</entry><entry></entry><entry>void +</entry> +<entry>optional</entry><entry>Specifies the return type of tag being +defined. (Family 2 only.)</entry> +</row> +<row> +<entry></entry><entry></entry><entry>void</entry><entry></entry> +<entry></entry><entry>Type of tag returns void.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>int</entry><entry></entry> +<entry></entry><entry>Type of tag returns int.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>float</entry><entry></entry> +<entry></entry><entry>Type of tag returns float.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>long</entry><entry></entry> +<entry></entry><entry>Type of tag returns long.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>string</entry><entry></entry> +<entry></entry><entry>Type of tag returns string.</entry> +</row> +<row> + <entry>version</entry><entry>string</entry><entry></entry><entry></entry> + <entry>optional</entry><entry>Specifies the version of the language for which this tag is valid</entry> +</row> +<row> + <entry>extends</entry><entry>string</entry><entry></entry><entry></entry> + <entry>optional</entry><entry>Valid only if the type of the tag is "class". The name of the base class for this class. (Family 2 only.)</entry> +</row> +<row> + <entry>class</entry><entry>string</entry><entry></entry><entry></entry> + <entry>optional</entry><entry>Valid only if the type is "method". Specifies the name of the class to where this method belongs. (Family 2 only.)</entry> +</row> +<row> + <entry>common</entry><entry>boolean</entry><entry></entry><entry></entry> + <entry>optional</entry><entry>if "yes", the tag specifies a common attribute group and the attributes inside this tag can be attached to any other tag. (Family 1 only.)</entry> +</row> +<row> + <entry>comment</entry><entry>string</entry><entry></entry><entry></entry> + <entry>optional</entry><entry>the comment string appears near the tag name in the completion box</entry> +</row></tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="label-3-2"> +<title>label</title> + +<para> +Place a label in the dialog. The text is specified by the <text> tag. +This is an element-only type element. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry> +<entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>tag</entry> +<entry>text, location</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="attr-3-2"> +<title>attr</title> + +<para> +Defines an attribute of the tag. This element occurs once for each +attribute. It defines the name and type of attribute. It also contains +additional tags that specify how this attribute should be displayed, et cetera. +This is an element-only type element. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry> +<entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>tag</entry> +<entry>location, list, tooltip, whatsthis, textlocation</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<informaltable> +<tgroup cols="6"> +<thead> +<row> +<entry>Attribute</entry><entry>Type</entry><entry>Values</entry> +<entry>Default</entry><entry>Use</entry><entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>name</entry><entry>string</entry><entry></entry><entry></entry> +<entry>required</entry><entry>Specifies the name of the attribute being +defined.</entry> +</row> +<row> +<entry>type</entry><entry>string</entry><entry></entry><entry>input</entry> +<entry>required</entry><entry>Specifies the type of the attribute being +defined.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>input</entry><entry></entry> +<entry></entry><entry>Field supports free text entries (text field).</entry> +</row> +<row> +<entry></entry><entry></entry><entry>check</entry><entry></entry> +<entry></entry><entry>Field value is boolean (check box).</entry> +</row> +<row> +<entry></entry><entry></entry><entry>color</entry><entry></entry> +<entry></entry><entry>Field value is a color.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>url</entry><entry></entry> +<entry></entry><entry>Field value is a &URL;. (Local file to refer to.)</entry> +</row> +<row> +<entry></entry><entry></entry><entry>list</entry><entry></entry> +<entry></entry><entry>Field value is an item from a specified list.</entry> +</row> +<row> +<entry>status</entry><entry>string</entry><entry></entry><entry>optional</entry> +<entry>required</entry><entry>Specifies whether or not the argument is +required. (Family 2 only.)</entry> +</row> +<row> +<entry></entry><entry></entry><entry>optional</entry><entry></entry> +<entry></entry><entry>Argument is optional.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>required</entry><entry></entry> +<entry></entry><entry>Argument is required.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>implied</entry><entry></entry> +<entry></entry><entry>Argument is implied.</entry> +</row> +<row> + <entry>source</entry><entry>string</entry><entry></entry><entry></entry> + <entry>optional</entry><entry>Specifies the sources used to fill the entry for the attribute in the tag editor dialog and the attribute tree</entry> +</row> +<row> + <entry></entry><entry></entry><entry>selection</entry><entry></entry> + <entry></entry><entry>The selected text is used as source</entry> +</row> +<row> + <entry></entry><entry></entry><entry>dcop</entry><entry></entry> + <entry></entry><entry>The result of a dcop method is used as source</entry> +</row> +<row> + <entry>interface</entry><entry>string</entry><entry></entry><entry></entry> + <entry>optional</entry><entry>Requires source="dcop". The dcop interface from inside &quantaplus; used to get the source data.</entry> +</row> +<row> + <entry>method</entry><entry>string</entry><entry></entry><entry></entry> + <entry>optional</entry><entry>Requires source="dcop" and an interface name. The dcop method name from inside &quantaplus; used to get the source data.</entry> +</row> +<row> + <entry>arguments</entry><entry>string</entry><entry></entry><entry></entry> + <entry>optional</entry><entry>Requires source="dcop", an interface and a method name. The arguments passed to the method. It can be empty or "%tagname%", meaning the current tags name.</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="tooltip-3-2"> +<title>tooltip</title> + +<para> +Defines the tooltip for a field in the dialog. This element is text-only. +</para> + +<note> +<para> +Currently only plain text is supported (you cannot use any markup). +</para> +</note> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry> +<entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>attr</entry> +<entry><emphasis>NONE</emphasis></entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="whatsthis-3-2"> +<title>whatsthis</title> + +<para> +Defines the 'What's This' help for a field in the dialog. This element is +text-only. +</para> + +<note> +<para> +Currently only plain text is supported (you cannot use any markup). +</para> +</note> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry> +<entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>attr</entry> +<entry><emphasis>NONE</emphasis></entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="list-3-2"> +<title>list</title> + +<para> +A container tag that groups together the items in a list. It may appear +only once for each attribute description. This is an element-only type +element. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry> +<entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>attr</entry> +<entry>item</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="item-3-2"> +<title>item</title> + +<para> +Defines an item in a list. This element is text-only. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry> +<entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>list</entry> +<entry><emphasis>NONE</emphasis></entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="textlocation-3-2"> +<title>textlocation</title> + +<para> +Specifies the position of a tag's attribute text within a dialog. This tag +can only occur once for each attribute in the dialog (&ie; one for each +<attr> tag). This element is empty. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry> +<entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>attr</entry> +<entry><emphasis>NONE</emphasis></entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<informaltable> +<tgroup cols="4"> +<thead> +<row> +<entry>Attribute</entry><entry>Type</entry> +<entry>Use</entry><entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>row</entry><entry>nonNegativeInteger</entry> +<entry>required</entry><entry>Specifies the row in the dialog layout of a +field or label.</entry> +</row> +<row> +<entry>col</entry><entry>nonNegativeInteger</entry> +<entry>required</entry><entry>Specifies the column in the dialog layout of +a field or label.</entry> +</row> +<row> +<entry>rowspan</entry><entry>nonNegativeInteger</entry> +<entry>optional</entry><entry>Specifies the number of rows a field should +span.</entry> +</row> +<row> +<entry>colspan</entry><entry>nonNegativeInteger</entry> +<entry>optional</entry><entry>Specifies the number of columns a field +should span.</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="location-3-2"> +<title>location</title> + +<para> +Specifies the position and size of a field in the dialog. This tag should +occur once for each field in the dialog (&ie; one for each <attr> and +<label> tag). This element is empty. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry><entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>label, attr</entry><entry><emphasis>NONE</emphasis></entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<informaltable> +<tgroup cols="4"> +<thead> +<row> +<entry>Attribute</entry><entry>Type</entry> +<entry>Use</entry><entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>row</entry><entry>nonNegativeInteger</entry> +<entry>required</entry><entry>Specifies the row in the dialog layout of a +field or label.</entry> +</row> +<row> +<entry>col</entry><entry>nonNegativeInteger</entry> +<entry>required</entry><entry>Specifies the column in the dialog layout of +a field or label.</entry> +</row> +<row> +<entry>rowspan</entry><entry>nonNegativeInteger</entry> +<entry>optional</entry><entry>Specifies the number of rows a field should +span.</entry> +</row> +<row> +<entry>colspan</entry><entry>nonNegativeInteger</entry> +<entry>optional</entry><entry>Specifies the number of columns a field +should span.</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="text-3-2"> +<title>text</title> + +<para> +Define the text for a label or check box. This element is text-only. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry><entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>label, attr</entry><entry><emphasis>NONE</emphasis></entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="children-3-2"> +<title>children</title> + +<para> +Defines a list of elements that can appear within the tag being specified. +This element is an element-only type element. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry><entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>tag</entry><entry>child</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="child-3-2"> +<title>child</title> + +<para> +Defines a child tag. This element is empty. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry><entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>children</entry><entry><emphasis>NONE</emphasis></entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<informaltable> +<tgroup cols="4"> +<thead> +<row> +<entry>Attribute</entry><entry>Type</entry><entry>Values</entry> +<entry>Use</entry><entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>name</entry><entry>string</entry><entry></entry> +<entry>required</entry><entry>Specifies a tag that can appear within the a +certain tag.</entry> +</row> +<row> +<entry>usage</entry><entry>string</entry><entry></entry> +<entry>optional</entry><entry>Specifies the relation with the parent.</entry> +</row> +<row> +<entry></entry><entry></entry><entry>required</entry> +<entry></entry><entry>The parent must have at least one child with this name.</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="stoppingtags-3-2"> +<title>stoppingtags</title> + +<para> +Defines a list of elements that force a tag to end. This element is an +element-only type element. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry><entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>tag</entry><entry>stoppingtag</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> + +<sect4 id="stoppingtag-3-2"> +<title>stoppingtag</title> + +<para> +Defines a stopping tag. This element is empty. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Parent(s)</entry><entry>Children</entry> +</row> +</thead> +<tbody> +<row> +<entry>stoppingtags</entry><entry><emphasis>NONE</emphasis></entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<informaltable> +<tgroup cols="4"> +<thead> +<row> +<entry>Attribute</entry><entry>Type</entry> +<entry>Use</entry><entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>name</entry><entry>string</entry> +<entry>required</entry><entry>Specifies which tags force the ending of +another tag.</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</sect4> +</sect3> + +<sect3 id="tagxml-usage-3-2"> +<title>TagXML Usage</title> + +<para> +All TagXML files must begin with the &XML; declaration: <?xml +version="1.0" encoding="UTF-8"?> and must be properly nested and closed. +</para> + +<important> +<para> +White space does not adversely affect anything, but watch out for & and +< characters. These should likely be replaced with an &amp; and +&lt;, respectively, in elements such as <tooltip>, <whatsthis>, +and <text>. Not doing so will not cause a crash, but you will have +chunks of your work disappear if you do not. +</para> +</important> +</sect3> + +<sect3 id="tagxml-validation-3-2"> +<title>TagXML Validation</title> + +<para> +To validate your TagXML files, simply click the <quote>Tools</quote> +pop-up dialog at the top of &quantaplus; and select <quote>Validate +TagXML.</quote> A dialog will present itself and you need only to follow +the simple directions. +</para> + +<note> +<para> +This feature is currently not present. Currently validation occurs when +the TagXML files are loaded into &quantaplus;. +</para> +</note> +</sect3> + +<sect3 id="tagxml-examples-3-2"> +<title>TagXML Examples</title> + +<sect4 id="family-one-3-2"> +<title>Family 1</title> + +<para> +The following will show you a valid Family 1 TagXML file. This file +happens to describe &W3C; &XML; Schema's <schema> element. The file name +for this TagXML file would be schema.tag. Simple, eh? +</para> + +<informalexample> +<literallayout> +<markup> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE TAGS> +<TAGS> + <tag name="schema"> + <label> + <text>id</text> + <location col="0" row="0"/> + </label> + <attr name="id" type="input"> + <tooltip>A unique ID for the element.</tooltip> + <whatsthis>A unique ID for the element.</whatsthis> + <location col="1" row="0"/> + </attr> + + <label> + <text>version</text> + <location col="0" row="1"/> + </label> + <attr name="version" type="input"> + <tooltip>Version of the schema.</tooltip> + <whatsthis>Version of the schema.</whatsthis> + <location col="1" row="1"/> + </attr> + + <label> + <text>targetNamespace</text> + <location col="0" row="2"/> + </label> + <attr name="targetNamespace" type="input"> + <tooltip>&URI; reference of the namespace of this schema.</tooltip> + <whatsthis>&URI; reference of the namespace of this schema.</whatsthis> + <location col="1" row="2"/> + </attr> + + <label> + <text>xmlns</text> + <location col="0" row="3"/> + </label> + <attr name="xmlns" type="input"> + <tooltip>&URI; reference for one or more namespaces for use in this schema. + If no prefix is used, then components of that namespace may be used unqualified.</tooltip> + <whatsthis>&URI; reference for one or more namespaces for use in this schema. + If no prefix is used, then components of that namespace may be used unqualified.</whatsthis> + <location col="1" row="3"/> + </attr> + + <label> + <text>attributeFormDefault</text> + <location col="0" row="4"/> + </label> + <attr name="attributeFormDefault" type="list"> + <items> + <item>qualified</item> + <item>unqualified</item> + </items> + <tooltip>Default form for all attributes within this schema.</tooltip> + <whatsthis>Default form for all attributes within this schema.</whatsthis> + <location col="1" row="4"/> + </attr> + + <label> + <text>elementFormDefault</text> + <location col="0" row="5"/> + </label> + <attr name="elementFormDefault" type="list"> + <items> + <item>qualified</item> + <item>unqualified</item> + </items> + <tooltip>Default form for all elements within this schema.</tooltip> + <whatsthis>Default form for all elements within this schema.</whatsthis> + <location col="1" row="5"/> + </attr> + + <label> + <text>blockDefault</text> + <location col="0" row="6"/> + </label> + <attr name="blockDefault" type="input"> + <location col="1" row="6"/> + </attr> + + <label> + <text>finalDefault</text> + <location col="0" row="7"/> + </label> + <attr name="finalDefault" type="input"> + <location col="1" row="7"/> + </attr> + </tag> +</TAGS> +</markup> +</literallayout> +</informalexample> +</sect4> + +<sect4 id="family-two-3-2"> +<title>Family 2</title> + +<para> +The following will show you a valid Family 2 TagXML file. This file +happens to describe &PHP;'s overload function. The file name for this +TagXML file would be overload.tag. +</para> + +<informalexample> +<literallayout> +<markup> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE tags> +<tags> + <tag name="overload" type="function" returnType="void"> +<attr name="class_name" type="string" status="optional"/> + </tag> +</tags> +</markup> +</literallayout> +</informalexample> +</sect4> +</sect3> +</sect2> + +<sect2 id="descriptionrc-3-2"> +<title>&descriptionrc;</title> + +<para> +The &descriptionrc; file is, also, quite simple and there is an editor for it accessible from <menuchoice><guimenu>DTD</guimenu><guimenuitem>Edit DTD Settings</guimenuitem></menuchoice>. This will edit the &descriptionrc; for a &DTEP; you can select from a list. In order to +edit the &descriptionrc; for a newly created &DTEP; you should create a simple &descriptionrc; with the following entries: +</para> +<para> + <informalexample> + <literallayout> + <markup> + [General] + Version = Use 1 for &quantaplus; version <=3.1.2 and 2 for any version greater. + Name = DTD definition string. (-//&W3C;//DTD HTML 4.01 Transitional//EN) + NickName = The beautified name of the DTD. (HTML 4.01 Transitional). If not defined, Name is + used as NickName. + </markup> + </literallayout> + </informalexample> +</para> +<para>Once you have created it at put aside of the tag files, load the newly created &DTEP; with <menuchoice><guimenu>DTD</guimenu><guimenuitem>Load DTD Package (DTEP)</guimenuitem></menuchoice> and after it is loaded you can proceed with editing the settings of the &DTEP;. Check the tooltips and the whatsthis text of the entries in the editor dialog to understand the meaning of each entry. Alternatively you can read the <filename>quanta/data/dtep/dtd-description.txt</filename> from the source tarball containing a description about the format. +</para> +</sect2> +</sect1> + +<sect1 id="user-actions"> +<title>User Defined Actions</title> +<para> +Actions are very common in every application. You meed them often when you use any application. Clicking on a toolbar icon, selecting a menu item or using a shortcut usually executes an action. In &quantaplus; actions are taken to the next level. Instead of hardcoded actions (that are created by the application +programmer at the source code level) it is possible for the ordinary user to create and modify actions and by this way adding +new functionality to &quantaplus;. These are the user defined actions, and many of the standard &quantaplus; actions are user defined (and user modifiable) actions as well. +</para> +<para>There are three types of user definable actions: +<itemizedlist> +<listitem><para><link linkend="text-actions">Text actions</link></para></listitem> +<listitem><para><link linkend="tag-actions">Tag actions</link></para></listitem> +<listitem><para><link linkend="script-actions">Script actions</link></para></listitem> +</itemizedlist> +</para> +<sect2 id="creating-actions"> +<title>Creating actions</title> +<para> + You can create an action by going to +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Actions</guimenuitem> +</menuchoice> +. Click on <guibutton>New Action</guibutton> and you will face a similar dialog: +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img7.png" format="PNG" /> +</imageobject> +</mediaobject> +<variablelist> +<varlistentry> +<term><guilabel>Type</guilabel></term> +<listitem><para>Specifies the action's type (<link linkend="text-actions">Text</link>, <link linkend="tag-actions">Tag</link>, <link linkend="script-actions">Script</link>).</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Text</guilabel></term> +<listitem><para>The user visible name of the action.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>The button near the <guilabel>Text</guilabel> label</term> +<listitem><para>The icon assigned to this action. Click on it in order to change the current icon.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Tool tip</guilabel></term> +<listitem><para>Short description of what the action does.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Shortcut</guilabel></term> +<listitem><para>The shortcut assigned to this action. Click on <guilabel>Custom</guilabel> or the button near <guilabel>Custom</guilabel> to assign a shortcut; click on <guilabel>None</guilabel> to remove the currently assigned shortcut.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Container toolbars</guilabel></term> +<listitem><para>The user defined toolbars where this action appears. See <xref linkend="creating-toolbars-3-2"/>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Detailed Settings</guilabel></term> +<listitem><para>Specific settings for the different type of actions. See below. +</para></listitem> +</varlistentry> +</variablelist> +</para> +</sect2> +<sect2 id="text-actions"> +<title>Text actions</title> +<para> +<mediaobject><imageobject> +<imagedata fileref="text-action.png" format="PNG" /> +</imageobject></mediaobject> + The simplest actions. You can enter some text in the <guilabel>Detailed Settings</guilabel> area and whenever the action is executed this text will be inserted in your document + at the current cursor position. See the below example. +</para> +</sect2> +<sect2 id="tag-actions"> +<title>Tag actions</title> +<para> + Useful to insert XML tags, but of course you can use them for other purposes as well. +<mediaobject><imageobject> +<imagedata fileref="tag-actions.png" format="PNG" /> +</imageobject></mediaobject> +<variablelist> +<varlistentry> +<term><guilabel><tag></guilabel></term> +<listitem><para>The name of the tag.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel></tag></guilabel></term> +<listitem><para>If checked when the action is executed this text will be inserted as a closing tag. If there is a selected area in the document before you execute the action, the <tag> will be inserted before the selected area and the </tag> after.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Run "Edit tag" dialog if available</guilabel></term> +<listitem><para>If checked and there is a tagXML file for this tag, a tag editing dialog will be shown prior of inserting the tag inside the document, so you can fine-tune the tag attributes.</para></listitem> +</varlistentry> +</variablelist> +The <tag> and </tag> will be inserted as you've typed there. The <, > or the / sign won't be automatically appended. +</para> +</sect2> +<sect2 id="script-actions"> +<title>Script actions</title> +<para> +<mediaobject><imageobject> +<imagedata fileref="script-action.png" format="PNG" /> +</imageobject></mediaobject> + The most powerful action type. With the help of this action you +can run external applications (usually scripts, but it's +not limited to scripts), which can alter your document or use your document (or part of your document) as input. Examples from &quantaplus; itself are the <guibutton>Quick Start</guibutton> dialog, the various <guilabel>View In...</guilabel> actions for the (X)HTML DTEPs. +</para> +<para> +First you have to enter the name of your script with the interpreter as well. Example: +<command>sh /home/myHome/myScript.sh</command>. +</para> +<para> +Although you can use full paths, the recommended way is to use the <command>%scriptdir</command> variable in the command line, like <command>sh %scriptdir/myScript.sh</command>. This way &quantaplus; will try to locate your script in the following places: +<itemizedlist> +<listitem><para>global script folder: <filename><envar>$KDEDIR</envar>/share/apps/quanta/scripts</filename></para></listitem> +<listitem><para>local script folder: <filename><envar>$KDEHOME</envar>/share/apps/quanta/scripts</filename></para></listitem> +<listitem><para>your path: <envar>$PATH</envar></para></listitem> +</itemizedlist> +There are other special variables that you can use in the command line: +<itemizedlist> +<listitem><para><command>%f</command>: will be replaced with the URL of the current document. In case of local documents, file:/ will be stripped from the document.</para></listitem> +<listitem><para><command>%input</command>: will be replaced with the selected input. See below.</para></listitem> +<listitem><para><command>%projectbase</command>: will be replaced with the URL of the current project. It is empty if no project is loaded.</para></listitem> +<listitem><para><command>%pid</command>: will be replaced with the PID of the running &quantaplus; process. If &quantaplus; is running in unique mode, the "unique " text will be prepended to the PID number. Useful when you use DCOP to control &quantaplus; from the external script.</para></listitem> +<listitem><para><command>%userarguments</command>: useful in case of events. This entry will be replaced by the event properties in the following order: <variablelist> +<varlistentry> +<term>First argument</term> +<listitem><para>The unique id of the script</para></listitem> +</varlistentry> +<varlistentry> +<term>Second argument</term> +<listitem><para>the event name</para></listitem> +</varlistentry> +<varlistentry> +<term>Third argument</term> +<listitem><para>the parameters for the event, usually the file name of the current document or the path to the project file.</para></listitem> +</varlistentry> +</variablelist> + </para></listitem> +</itemizedlist> +</para> +<para> +Aside of the above methods the script can receive input from &quantaplus; on the standard input. In the <guilabel>Input</guilabel> combobox you can select what to send to the standard input. Choices are: +<itemizedlist> +<listitem><para><guilabel>None</guilabel>: nothing is sent to the script.</para></listitem> +<listitem><para><guilabel>Current document</guilabel>: the whole document is sent to the script.</para></listitem> +<listitem><para><guilabel>Selected text</guilabel>: the selected area of the document is sent to the script. Using the <command>%input</command> variable usually makes sense only when using this setting.</para></listitem> +</itemizedlist> +</para> +<para> +Similar to the <guilabel>Input</guilabel> you can catch the output of the executed application. There are two kind of outputs: +<itemizedlist> +<listitem><para>normal output, printed to the standard output;</para> +</listitem> +<listitem><para>error messages, printed to the standard error.</para> +</listitem> +</itemizedlist> +You can specify what should happen with the text printed to the standard output. This can be done by modifying the value of the <guilabel>Output</guilabel> combobox: +<itemizedlist> +<listitem><para><guilabel>None</guilabel>: the output of the application is ignored.</para></listitem> +<listitem><para><guilabel>Insert in cursor position</guilabel>: the output will be inserted in the current document and the cursor position.</para></listitem> +<listitem><para><guilabel>Replace selection</guilabel>: the selected area of the document will be replaced with the output.</para></listitem> +<listitem><para><guilabel>Replace selection</guilabel>: the selected area of the document will be replaced with the output.</para></listitem> +<listitem><para><guilabel>Create a new document</guilabel>: a new document will be created and will contain all the output of the script.</para></listitem> +<listitem><para><guilabel>Replace current document</guilabel>: the entire document will be replaced with the output.</para></listitem> +<listitem><para><guilabel>Message window</guilabel>: the output will appear in the <guilabel>Messages</guilabel> toolview.</para></listitem> +</itemizedlist> +</para> +<para>The choices for the standard error output (<guilabel>Error</guilabel>) are the same as for the normal output.</para> +</sect2> +</sect1> + +<sect1 id="creating-toolbars-3-2"> +<title>Creating Toolbars</title> + +<para> +The following will show you how to create toolbars for a &DTEP;. Toolbars +are graphical elements that are assigned to actions. Actions, in +&quantaplus;, are the basis for nearly all the extensions that +&quantaplus; has and will acquire in the future. The same mechanism that +defines an action in &quantaplus; also enables auto-completion and tag +dialogs. With actions, the limit of what you can do is virtually +limitless. For means of an example, we will use <ulink +url="http://tidy.sf.net">&HTML; tidy</ulink> on our web pages. +</para> + +<sect2 id="from-scratch-to-complete-3-2"> +<title>From Scratch to Complete</title> + +<para> +To begin, you will need to create a user toolbar. Select +<menuchoice> +<guimenu>Toolbars</guimenu> +<guimenuitem>Add User Toolbar</guimenuitem> +</menuchoice>. +</para> + +<para> +If there are many tags for the markup language, it is recommended that you +split up the tags into logical groups. You will need to create a new user +toolbar for each group. In this case, there are not many, so we will be +making one toolbar and naming it with the name of the markup. +</para> + +<para> +Once all your toolbars are created, you must add and configure the +actions. To do this, select +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Actions</guimenuitem> +</menuchoice> +<emphasis> +</emphasis>. +</para> + +<para> +The parts of this window are pretty straight forward. Press the +<guibutton>New action</guibutton> button at the bottom of the window to +enter the editing mode. +</para> + +<para> +Fill in all of the necessary fields and add the tag to the appropriate +toolbar(s). +</para> + +<para> +Complete the rest and, if the tag has attributes and you always plan to +use them, check the <guilabel>Run "Edit tag" dialog if available +</guilabel> box so that you will be prompted every time the action is used. +</para> + +<para> +You should now have something much like the following. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img7.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +Press the <guibutton>Apply</guibutton> button and you will see the action +added to the toolbar(s) you have selected. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img8.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +Egad! That's an awful icon. How will yourself and others remember that +icon goes with that action? Let's replace it before trouble arises. +</para> + +<para> +To create an icon that more accurately describes that action, we will be +using &kiconedit;. Select it from the &kmenu;, <menuchoice> +<guisubmenu>Graphics</guisubmenu> +<guisubmenu>More Programs</guisubmenu> +</menuchoice> (or where ever your distribution placed it). +</para> + +<para> +&kiconedit; defaults to the size 32x32 pixels, but we need 22x22. To +change this, select +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Resize</guimenuitem> +</menuchoice>. +</para> + +<para> +Keep in mind that you are creating an icon that will assist in helping not +only yourself to remember which action does what, but also other users of +the &DTEP;. +</para> + +<para> +Since the tag I am creating the icon for is called <quote>start,</quote> +I have decided to create a <quote>Start sign.</quote> Using the color green +(green often interpreted as <quote>go,</quote> <quote>start,</quote> or +<quote>proceed</quote>) will, or, at least, should, convey a message +to the user that clicking this action will place the <start> tag in the +current document. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img15.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +Now that I am finished with the creation of the icon, I will save it. +</para> + +<para> +Once you are done with creating the icon(s), you must associate the icon +with the action. To do this, open +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Actions</guimenuitem> +</menuchoice> again (in &quantaplus;) and select the action you made +the icon for. Beside the <guilabel>Text</guilabel> field, you will see a +button, click it. +</para> + +<para> +Select <guilabel>Other Icons</guilabel> and then click the <guibutton> +Browse</guibutton> button. +</para> + +<para> +Goto the folder in which you saved the icon, select the icon, and click +<guibutton>OK</guibutton>. +</para> + +<para> +Press the <guibutton>Apply</guibutton> button and either continue to do the +same with the other tags, if any, or click <guibutton>OK</guibutton> to +finish. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img18.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +Let us say you would like to add some common &quantaplus; functions to your +toolbar or maybe you think the toolbar would be better off organized in a +different manner with some separators to group the actions. Open the +<guilabel>Configure Toolbars</guilabel> dialog by going +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars</guimenuitem> +</menuchoice>. Make sure your toolbar is selected. +</para> + +<para> +I will be choosing the separator (top of the left column) for my toolbar. +Once you have selected the item you wish to add to your toolbar, press the +right arrow button. This will add it to your toolbar. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img21.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +I think I would like a quick way to access the <guilabel>Konqueror +Preview</guilabel>. I will select it and add it to the toolbar. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img22.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +Note how the separator helps in grouping. Someone new to my toolbar might +have thought that the &konqueror; button was like or the opposite of the +start button. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img23.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +Apply your changes and, when you are done, press <guibutton>OK</guibutton> +to finish. +</para> + +<para> +Ah, look at the fantastic new toolbar! Much more handy now. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img24.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +Remember to test your toolbar, by clicking all the buttons, so that you +know the output is correct. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="dtep_doc_img25.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +Now to save the toolbar, we will select +<menuchoice> +<guimenu>Toolbars</guimenu> +<guisubmenu>Save Toolbars</guisubmenu> +<guimenuitem>Save as Local Toolbar</guimenuitem> +</menuchoice>. +</para> + +<para> +Save it to the correct folder. Since NeXML does not exist, I will just +have it to the top-level folder, but your toolbar(s) should be saved to +the correct folder. Make sure to adjust your &descriptionrc; to have it +load your toolbar(s) when a new file of that type is created. +</para> +</sect2> +</sect1> + + +<sect1 id="creating-quanta-docs-3-2"> +<sect1info> +<title>Creating Your Own Documentation</title> +<authorgroup> +<author> +<firstname>Robert</firstname> +<surname>Nickel</surname> +<affiliation> +<address><email>robert@artnickel.com</email></address> +</affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</sect1info> + +<title>Creating Your Own Documentation</title> + +<para> +Probably the most notable additions to &quantaplus; for the general user +will be the addition of documentation for the markup or scripting language +that you like best. To that end, this chapter will explain how I create +the &PHP; documentation tree for my personal use. +</para> + +<para> +Before starting on creating your own documentation, you may wish to check +out the <ulink url="http://quanta.sf.net/main1.php?contfile=resource"> +&quantaplus; repository</ulink> to see if someone else has already done +this set. +</para> + +<para> +There are two parts to this process. First, you must obtain the existing +documentation for the markup/scripting/&etc; language that you are after. +Second, you have to create the <filename>docrc</filename> file. The first +is up to you, the second is what we will cover here. +</para> + +<para> +The general form of the docrc file is as follows: +</para> + +<informalexample> +<literallayout> +#KDE Config File +[Tree] +Doc dir=<replaceable>path, relative to this file, of the documentation html files</replaceable> ⪚ php42/ +#top level elements +Top Element=<replaceable>Your description for these documentation</replaceable> ⪚ &PHP; 4.2 documentation + +Section 1=Section1.html +Section 2=#Sec2.1,#Sec2.2,#Sec2.3 +Sec2.1=Sec2.1.html +Sec2.2=Sec2.2.html +Sec2.3=Sec2.3.html +... + +[Context] +ContextList=func1,func2,tag1,tag2,tag3 +func1=func1.html +func2=func2.html +tag1=tag1.html +tag2=tag2.html +tag3=tag3.html +</literallayout> +</informalexample> + +<para> +The <filename>docrc</filename> is broken down into two sections: Tree and +Context. +</para> + +<para> +The Tree section defines the presentation aspect of the documentation in +the documentation tab. For example, you will see that in the &PHP; +documentation you have something akin to this: +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="doc-view1.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +Relating this to the above, my &PHP; <filename>docrc</filename> looks like +this: +</para> + +<informalexample> +<literallayout> +#KDE Config File + +[Tree] + +Doc dir=php42/ + +#top level elements +Top Element=PHP 4.2 documentation + +PHP 4.2 documentation=Table of Contents,#Getting Started,#Language Reference + +Table of Contents=index.html + +Getting Started=Introduction, ... +Introduction=introduction.html +... + +Language Reference=Basic syntax, ... +Basic syntax=language.basic-syntax.html +... + +</literallayout> +</informalexample> + +<para> +Notice the <literal>#</literal> in front of <quote>Getting Started</quote> +and <quote>Language Reference</quote>. This indicates that these are sub +containers in the tree and have content of their own. I do not believe that +there is a set limit to the depth here (other than that driven by sanity) +— use your judgment. +</para> + +<para> +For the Table of Contents, you will notice that it is referenced directly to +a file (and consequently shows up at the bottom of the tree view — +folders first!). +</para> + +<important> +<para> +Spaces do not adversely affect anything, but watch out for & and < +characters. These should likely be replaced by &amp; and &lt; +respectively in all of the &XML; based &quantaplus; resource files. +</para> +</important> + +<para> +The Context section is the section of the docrc file that is used to +facilitate context sensitive help. For example, you are writing a &PHP; +script and you would like to see the documentation for the +<function>mysql_fetch_array</function> function. You simply highlight the +function and then press <keycombo action="simul">&Ctrl;<keycap>H</keycap> +</keycombo> for context help. The documentation on +<function>mysql_fetch_array</function> will immediately display. There are +only two entry types here: the ContextList and the file association lines. +</para> + +<variablelist> +<varlistentry> +<term>ContextList</term> +<listitem> +<para> +Really simple, this is just a comma separated list of the context items +you wish to have available (for &PHP;, these are the functions for &PHP;). +</para> +</listitem> +</varlistentry> +<varlistentry> +<term>File association lines</term> +<listitem> +<para> +These are of the form context item=html doc page. ⪚ +acos=function.acos.html +</para> +</listitem> +</varlistentry> +</variablelist> + +<para> +A pared down version of my <filename>docrc</filename> Context section is +as follows: +</para> + +<informalexample> +<literallayout> +#Keywords for context help +[Context] +ContextList=abs,acos,acosh,addcslashes,addslashes,... + +abs=function.abs.html +acos=function.acos.html +acosh=function.acosh.html +addcslashes=function.addcslashes.html +addslashes=function.addslashes.html +... +</literallayout> +</informalexample> + +<para> +Now you can just save your <filename>docrc</filename> file, save it in +<filename class="directory">$<envar>HOME</envar>/.kde/share/apps/quanta/doc</filename> +or <filename +class="directory">$<envar>KDEDIR</envar>/share/apps/quanta/doc</filename> +for local or global use respectively. Then create a folder (the one +specified in your <filename>docrc</filename> file) in the same folder +as your <filename>docrc</filename> file and copy your &HTML; pages in +there. +</para> + +<para> +You will need to restart &quantaplus; to see your documentation. +</para> + +<para> +Once you are sure that they are good and worth sharing, send the <filename> +docrc</filename> file along with a description of any pertinent +information on what documentation you used to the +<ulink url="http://quanta.sf.net/main1.php?contfile=resource">&quantaplus; +repository</ulink> for use by the &quantaplus; community. You will not get +rich, but you will feel great knowing that you contributed to the best web +development platform around. +</para> + +</sect1> + +<sect1 id="sharing-resources"> + <title>Sharing Resources</title> + <para>With &quantaplus; you are not alone. It is possible to share the various resources (DTEP packages, toolbars with actions, scripts, templates) with others. There are two ways to do it: + </para> + <variablelist> + <varlistentry> + <term>Sending in Email</term> + <listitem><para>The resources can be sent in email to your friends, partners or to whomever you want. You will see the <guilabel>Send in Email</guilabel> menu entries in various places, like <menuchoice><guimenu>DTD</guimenu><guimenuitem>Send DTD Package (DTEP) in Email</guimenuitem></menuchoice>, <menuchoice><guimenu>Toolbars</guimenu><guimenuitem>Send Toolbar in Email</guimenuitem></menuchoice>, in the context menu of the files and folders in the <guilabel>Templates</guilabel> and <guilabel>Scripts</guilabel> tree. + </para></listitem> + </varlistentry> + <varlistentry> + <term>Uploading to the main server</term> + <listitem><para>The resources can be uploaded to our main repository, from where all other &quantaplus; users can download them. The submissions are reviewed and made available only if our team considers correct and useful will be published. In order to make a valid submission it is suggested to sign the resources, thus you need a GPG/PGP key. This information is used to verify the origin of the resources both by our team and by the downloaders.</para> + <para>About getting the resources from the main server see <xref linkend="download-resources" />.</para> + <para>When uploading you will be asked to enter the passphrase for your secret GPG key (the passphrase will not be stored), or in the case of having more secret keys, you will be able to pick up the one you want to use. In the <guilabel>Share Hot New Stuff</guilabel> dialog fill the input fields (the <guilabel>Preview URL</guilabel> may remain empty) and start the upload by clicking <guilabel>OK</guilabel>.</para> + <para> + The upload can be initiated from + <menuchoice><guimenu>DTD</guimenu><guimenuitem>Upload DTD Package (DTEP)</guimenuitem></menuchoice>, <menuchoice><guimenu>Toolbars</guimenu><guimenuitem>Upload Toolbar</guimenuitem></menuchoice>, in the context menu of the files and folders in the <guilabel>Templates</guilabel> and <guilabel>Scripts</guilabel> tree. + </para> + </listitem> + </varlistentry> +</variablelist> +</sect1> +<sect1 id="download-resources"> +<title>Getting Resources</title> +<para>It is possible to upgrade your &quantaplus; without getting a new version, by getting new resources like DTEP packages, toolbars with actions, templates, scripts and documentation. One possibility is that you got the resources in email or have downloaded from a web server, in which cases you usually need to manually install them. In lucky case you also got an install script when you have downloaded the resources. But &quantaplus; has a dedicated server holding resources that were either not included in the main distribution because of their sizes or infrequent usage, or they were contributed later by users, and these resources are automatically installed. Do download such resources use the various <guilabel>Download</guilabel> menu entries. You can find them at <menuchoice><guimenu>DTD</guimenu><guimenuitem>Download DTD Package (DTEP)</guimenuitem></menuchoice>, <menuchoice><guimenu>Toolbars</guimenu><guimenuitem>Download Toolbar</guimenuitem></menuchoice>, in the context menu of an empty area or toplevel item in the <guilabel>Templates</guilabel>, <guilabel>Scripts</guilabel> and <guilabel>Documentation</guilabel> trees. +</para> +<para> +After a resource was downloaded, but before it is installed, &quantaplus; verifies if the resource is valid, by checking the integrity and the signature. In case of problems it warns you and you can decide if you want to continue or not. Please read the warning dialogs carefully. In the case when the integrity is correct and the resource is correctly signed, you will still get an information dialog, so you can see who created the resource. +</para> +<para> + <caution><para>Be sure that you install resources, especially toolbars and scripts, only from trusted sources!</para></caution> +</para> +</sect1> + +<sect1 id="converting-dtd"> + <title>Converting a DTD to a &DTEP;</title> + <para>It is possible to work on XML languages currently not supported by &quantaplus; by creating a DTEP package. But the creation can be time consuming, as you may need to write hundreds of tag files in <link linkend="tagxml-3-2">tagXML</link> format. Of course, there is a nicer way to go, by converting the DTD automatically into a DTEP package. + </para> + <para>The conversion can be started from the <menuchoice><guimenu>DTD</guimenu><guimenuitem>Load & Convert DTD</guimenuitem></menuchoice> menu. Select the <filename>.dtd</filename> file which defines the DTD you want to use, and after that you will see the following dialog: + <mediaobject> + <imageobject> + <imagedata fileref="dtd-conversion.png" format="PNG" /> + </imageobject> + </mediaobject> + </para> +<para>The entries are:</para> +<itemizedlist> + <listitem><para><guilabel>Target directory name:</guilabel>the newly created &DTEP; will go under this name to the <filename><envar>$KDEHOME</envar>/share/apps/quanta/dtep</filename> folder. + </para> + </listitem> + <listitem><para><guilabel>Name:</guilabel>the name (definition string) of the DTD</para></listitem> + <listitem><para><guilabel>Nickname:</guilabel> the user visible name of the &DTEP;</para></listitem> + <listitem><para><guilabel>!DOCTYPE definition line:</guilabel> + the string that should appear in the !DOCTYPE tag, like + HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"</para></listitem> + <listitem><para><guilabel>DTD URL:</guilabel> the URL pointing to the DTD file</para></listitem> + <listitem><para><guilabel>Default extension:</guilabel> the extension usually used for files that were written in this DTD</para></listitem> + <listitem><para><guilabel>Case-sensitive tags and attributes:</guilabel> self explaining, usually true for XML language variants</para></listitem> + <listitem><para><guilabel>Fine-tune the DTEP after conversion:</guilabel> if checked, after the conversion is done, &quantaplus; will bring up the &descriptionrc; editor, so you can fine tune the newly created &DTEP;. It is recommended to leave this options checked.</para></listitem> +</itemizedlist> + +</sect1> +</chapter> diff --git a/doc/quanta/ftab.png b/doc/quanta/ftab.png Binary files differnew file mode 100644 index 00000000..b179f808 --- /dev/null +++ b/doc/quanta/ftab.png diff --git a/doc/quanta/fundamentals.docbook b/doc/quanta/fundamentals.docbook new file mode 100644 index 00000000..ccd293d5 --- /dev/null +++ b/doc/quanta/fundamentals.docbook @@ -0,0 +1,429 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<chapter id="fundamentals-3-2"> +<chapterinfo> +<title>The Fundamentals of &quantaplus;</title> +<authorgroup> +<author> +<firstname>Robert</firstname> +<surname>Nickel</surname> +<affiliation> +<address><email>robert@artnickel.com</email></address> +</affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Fabrice</firstname> +<surname>Mous</surname> +<affiliation> +<address><email>fabrice@kde.nl</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</chapterinfo> + +<title>The Fundamentals of &quantaplus;</title> + +<para> +Within &quantaplus; there are several key concepts. To understand and +take advantage of &quantaplus;, you must first learn these concepts, the +fundamentals. This chapter will explain and show you these concepts, without +which &quantaplus; would be primitive. +</para> + +<sect1 id="quanta-workspaces-3-2"> +<title>The Workspace</title> + +<para> +&quantaplus; divides the workspace into three scopes: Global, Local, and +Project. These distinctions affect various components in &quantaplus;. +</para> + +<variablelist> +<varlistentry> +<term>Global</term> +<listitem> +<para> +Global items are available to anyone that uses &quantaplus;. From toolbars +to actions, everything marked as global is stored in the common +&quantaplus; folder structure. This has the effect of allowing a group +of admins to save certain toolbars, actions, and templates in the global +tree, which can then be used to keep a multi-user installation of +&quantaplus; common to everyone on the system. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Local</term> +<listitem> +<para> +Local items make up a single user's personal collection of web development +resources. These items are made up of a user's templates and toolbars. +Local items are stored in a user's home folder. This makes all of the +user's Local items available for personal use at instance. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Project</term> +<listitem> +<para> +Project items are are only available to a particular project. These can +be anything from a &CSS; template to a toolbar with custom actions +which perform a special task on a project's files. Simply put, this is +the most limited scope. All of the items saved in the project workspace +will be saved in the project's folder tree, allowing you to share your +specialized tools and templates with whomever else you share your +project with. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="mdi-interface-3-2"> +<title>The Multi-Document Interface</title> + +<para><mediaobject> +<imageobject> +<imagedata fileref="quantamdi.png" format="PNG" /> +</imageobject> +<caption><para>&quantaplus; editing the document you are now reading.</para></caption> +</mediaobject> +</para> + + +<para> +&quantaplus;' &MDI; is broken down into various parts: the editor window, +the quick info trees, informational tabs and the toolbars. Please see <xref linkend="editor-3-2" />, +<xref linkend="qit-3-2" />, <xref linkend="information-3-2" />, and <xref linkend="toolbars-3-2" /> for more +information on these parts. +</para> + +<sect2 id="editor-3-2"> +<title>The Editor Window</title> + +<para> +<mediaobject> +<imageobject> +<imagedata fileref="quantamdi-editor.png" format="PNG" /> +</imageobject> +<caption><para>&quantaplus;' editor window.</para></caption> +</mediaobject> +</para> + +<para> +&quantaplus;' editor window allows for multiple files to be opened at the +same time. When just one file is open, the document fills the entire +editor window. As soon as a second document is opened, a small amount of +space is taken from the bottom of the editor window to allow for tabs to +be displayed with the filenames and a status icon. The above picture shows +a <guiicon>floppy</guiicon> icon beside the filename, indicating that the +file has been modified and should be saved.</para> +<para>You can right click on the tabs with the mouse to get a context menu with entries related to the current document, like closing the current, other or all tabs; switching to other tabs; reloading, deleting or uploading the document; switching to a bookmarked line ; performing CVS operations on the current document.</para> +<para>Right clicking in the editor area will give you another context menu related to the edited document content, like basic editing actions (cut/copy/paste), editing the tag under the cursor, selecting the area covered by the tag under the cursor, getting context help about the word under the cursor or open a file if the string under the cursor points to a file.</para> + + +<para> +At the top of the editor window is the editor toolbar set. Currently, +&quantaplus; defaults to &HTML; 4.01 Transitional, which has a default set +of toolbars that are loaded. As &quantaplus; progresses, the toolbars will +be updated to meet the needs of users and to make use of newer features. +</para> + +<para> +Toolbar usage is pretty straight forward. If you want to insert a basic +tag, like <p>, into your document, then you can click on the icon that +represents the tag. Now you can insert your data for the tag you have just +inserted. If you wish to insert a tag that requires certain attributes +(like an anchor), then you will get a dialog box with the various fields for +you to fill in. + +<mediaobject> +<imageobject> +<imagedata fileref="taginputex.png" format="PNG" /> +</imageobject> +<caption><para>The anchor (<a>) dialog.</para></caption> +</mediaobject> +</para> +</sect2> + +<sect2 id="qit-3-2"> +<title>The Toolviews</title> + +<mediaobject> +<imageobject> +<imagedata fileref="quantamdi-treeview.png" format="PNG" /> +</imageobject> +<caption><para>The Toolviews.</para></caption> +</mediaobject> + +<para> +The Toolviews or Quick Info Trees (&QIT;) allow you to navigate, open, and gather +information in &quantaplus;. Its tabbed format presents you with the Files, Project, +Templates, Document Structure, Scripts, Attribute, and Documentation Trees. +</para> + +<variablelist id="qit-parts"> +<title>&QIT; Explained</title> + +<varlistentry> +<term> +Files Tree +<inlinemediaobject> +<imageobject> +<imagedata fileref="ftab.png" format="PNG" /> +</imageobject> +</inlinemediaobject> +</term> +<listitem> +<para> +This is where you can browse your entire file system. You are presented +with two top-level roots of the file system. The first is your home folder +and the second is the filesystem root folder - /. Use these to find existing +files on your machine that you would like to edit or add to an active +project. Right mouse button clicking on a file in this view gives you several +options for managing the selected file and, also, allows you to insert the +file into an active project, if any, or toggle the view between tree and list. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Project Tree +<inlinemediaobject> +<imageobject> +<imagedata fileref="ptab.png" format="PNG" /> +</imageobject> +</inlinemediaobject> +</term> +<listitem> +<para> +<link linkend="quanta-projects-3-2">Project management</link> is one of the +many powerful tools that &quantaplus; offers. This tab displays all files +within your project and allows you to manage the files within the project +through the use of &RMB; clicking. Actions, such as add, remove, upload, +or delete files entirely from the disk, can be performed through this menu. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Templates Tree +<inlinemediaobject> +<imageobject> +<imagedata fileref="ttab.png" format="PNG" /> +</imageobject> +</inlinemediaobject> +</term> +<listitem> +<para> +Another feature of &quantaplus; is templates. Templates can be anything +you would like. Images, code snippets, an entire web page, et cetera. It +is entirely up to you. +</para> + +<para> +Templates are sorted into three categories, which are based on their scope +and the context they are being used. These scopes are carried over from +&quantaplus;' workspace. Global templates are usable all times, local +templates are usable to the current user, and project templates +are usable only within their specified project. More on templates can be +found in <xref linkend="templates-3-2" />. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Scripts Tree +<inlinemediaobject> +<imageobject> +<imagedata fileref="exec.png" format="PNG" /> +</imageobject> +</inlinemediaobject> +</term> +<listitem> +<para> +Here you will find information about the various scripts available for use +by you. The Global, Local, and Project concept allows here as well. By +&LMB; clicking the entries, you gain access to all the available +information about the script. And &RMB; clicking allows you to perform a +few actions, such as running the script, editing the script, and mailing +the script, for example. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Document Structure Tree +<inlinemediaobject> +<imageobject> +<imagedata fileref="view_sidetree.png" format="PNG" /> +</imageobject> +</inlinemediaobject> +</term> +<listitem> +<para> +This tab displays the parser's internal representation of your document. +By &LMB; clicking on an element, your cursor will taken to the element's +position in the document. By &RMB; clicking on an element, you are +presented with a number of actions that deal with navigating and updating +the tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Attribute Tree +<inlinemediaobject> +<imageobject> +<imagedata fileref="tag_misc.png" format="PNG" /> +</imageobject> +</inlinemediaobject> +</term> +<listitem> +<para> +This tree appears below all the other &QIT;s. Within it you can quickly +edit attributes and namespaces. The content-focused entry system +allows you to modify all the available attributes with little more than a +few clicks of the mouse. +<mediaobject> +<imageobject> +<imagedata fileref="attribute_tree.png" format="PNG" /> +</imageobject> +<caption><para>Attribute Tree</para></caption> +</mediaobject> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Documentation Tree +<inlinemediaobject> +<imageobject> +<imagedata fileref="contents2.png" format="PNG" /> +</imageobject> +</inlinemediaobject> +</term> +<listitem> +<para> +Here you can find complete documentation on web technologies to aid your +development. You can download pre-packaged documentation for &quantaplus; +at <ulink url="http://quanta.sourceforge.net/docs.html">&quantaplus;' +documentation site</ulink>, you can <link +linkend="creating-quanta-docs-3-2">create your own documentation</link>, +and, by adding a folder named "doc" to a project, you can add, edit, +and view project-specific documentation. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="information-3-2"> +<title>The Informational Tabs</title> + +<mediaobject> +<imageobject> +<imagedata fileref="info_tab.png" format="PNG" /> +</imageobject> +<caption><para>&quantaplus;' Informational Tabs.</para></caption> +</mediaobject> + +<para> +By default &quantaplus; has two tabs located at the bottom of the window +from which useful information can be obtained. These are the Messages +window and the Problems window. +</para> +<variablelist> +<varlistentry> +<term> +Messages Window Tab +<inlinemediaobject> +<imageobject> +<imagedata fileref="" format="PNG" /> +</imageobject> +</inlinemediaobject> +</term> +<listitem> +<para> +This tab displays information from any scripts run in quanta. +For example, the DTD being used for the current document +and any changes to the DTD are displayed. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +Problems Tab +<inlinemediaobject> +<imageobject> +<imagedata fileref="" format="PNG" /> +</imageobject> +</inlinemediaobject> +</term> +<listitem> +<para> +This tab shows any errors in the markup of the current document. +&quantaplus; scripts which are executed will also print error +messages (if present) in this tab. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="toolbars-3-2"> +<title>The Toolbars</title> + +<mediaobject> +<imageobject> +<imagedata fileref="toolbars.png" format="PNG" /> +</imageobject> +<caption><para>&quantaplus;' &HTML; toolbars.</para></caption> +</mediaobject> + +<para> +&quantaplus;' toolbars have been extended greatly and are easy to +understand. You click on the button and you get an associated action from +that button. The beautiful part about toolbars is that you can define your +own actions graphically within &quantaplus;. +</para> + +<para> +Managing toolbars in &quantaplus; is easy. By selecting the <guimenu> +Toolbars</guimenu> menu, you have the options to load, save, add, remove, and +email toolbars. When you choose to load a toolbar, you may choose from one +of the three <link linkend="quanta-workspaces-3-2">workspaces</link> in +&quantaplus;. When saving a newly created toolbar, you can save it in the +local scope or within a project's scope. If you would like to make a new +toolbar available in the global scope, ask your admin to place it in +&quantaplus;' global toolbar folder. +</para> + +<para> +Another feature of &quantaplus; is the ability to email your toolbars. +&quantaplus; sends the toolbar as a gzipped tar archive through &kmail;. +If you receive a toolbar in email, then you can save (and load) it into +&quantaplus; like any other toolbar! +</para> +</sect2> +</sect1> +</chapter> diff --git a/doc/quanta/glossary.docbook b/doc/quanta/glossary.docbook new file mode 100644 index 00000000..30e83c3d --- /dev/null +++ b/doc/quanta/glossary.docbook @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<glossary id="quanta-glossary-3-2"> + +<glossaryinfo> +<authorgroup> +<author> +<firstname>Keith</firstname> +<surname>Isdale</surname> +<affiliation> +<address><email>k_isdale@tpg.com.au</email></address> +</affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</glossaryinfo> + +<glossdiv> +<title>Keywords</title> +<glossentry id="xsldbg-glosref"> +<glossterm>xsldbg</glossterm> +<glossdef> +<para>See <ulink url="http://xsldbg.sourceforge.net"></ulink></para> +</glossdef> +</glossentry> +<glossentry> +<glossterm>XPath</glossterm> +<glossdef> +<para>A valid expression that defines what data is required. See +<ulink url="http://www.w3.org">&W3C; web site</ulink> +</para> +</glossdef> +</glossentry> +<glossentry> +<glossterm>QName</glossterm> +<glossdef> +<para>A fully qualified name. For example <emphasis>xsl:myvariable</emphasis>. See <ulink url="http://www.w3.org">&W3C; web site</ulink> +</para> +</glossdef> +</glossentry> +</glossdiv> +</glossary> diff --git a/doc/quanta/index.docbook b/doc/quanta/index.docbook new file mode 100644 index 00000000..32d92c53 --- /dev/null +++ b/doc/quanta/index.docbook @@ -0,0 +1,183 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY package "kdewebdev"> + <!ENTITY advanced-quanta SYSTEM "adv-quanta.docbook"> + <!ENTITY config-quanta SYSTEM "config-quanta.docbook"> + <!ENTITY credits-license SYSTEM "credits-license.docbook"> + <!ENTITY debugging-quanta SYSTEM "debugging-quanta.docbook"> + <!ENTITY extending-quanta SYSTEM "extending-quanta.docbook"> + <!ENTITY fundamentals SYSTEM "fundamentals.docbook"> + <!ENTITY glossary SYSTEM "glossary.docbook"> + <!ENTITY installation SYSTEM "installation.docbook"> + <!ENTITY introduction SYSTEM "introduction.docbook"> + <!ENTITY q-and-a SYSTEM "q-and-a.docbook"> + <!ENTITY quanta-menus SYSTEM "quanta-menus.docbook"> + <!ENTITY quanta-projects SYSTEM "quanta-projects.docbook"> + <!ENTITY working-with-quanta SYSTEM "working-with-quanta.docbook"> + <!ENTITY CGI "<acronym>CGI</acronym>"> + <!ENTITY DTD "<acronym>DTD</acronym>"> + <!ENTITY DTEP "<acronym>DTEP</acronym>"> + <!ENTITY HTML "<acronym>HTML</acronym>"> + <!ENTITY IDE "<acronym>IDE</acronym>"> + <!ENTITY PHP "<acronym>PHP</acronym>"> + <!ENTITY PDF "<acronym>PDF</acronym>"> + <!ENTITY SGML "<acronym>SGML</acronym>"> + <!ENTITY XSD "<acronym>XSD</acronym>"> + <!ENTITY W3C '<trademark class="registered">W3C</trademark>'> + <!ENTITY QIT "<acronym>QIT</acronym>"> + <!ENTITY MDI "<acronym>MDI</acronym>"> + <!ENTITY gubed "<application>Gubed PHP Debugger</application>"> + <!ENTITY kxsl "<application>KXsldbg</application>"> + <!ENTITY VPL "<acronym>VPL</acronym>"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> + <!ENTITY descriptionrc '<link linkend="descriptionrc-3-2">description.rc</link>'> +]> + +<book lang="&language;"> +<title>&quantaplus; User Manual</title> + +<bookinfo> + +<authorgroup> + +<author> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +</author> + +<author> +<firstname>Fabrice</firstname> +<surname>Mous</surname> +<affiliation> +<address><email>fabrice@kde.nl</email></address> +</affiliation> +</author> + +<author> +<firstname>Robert</firstname> +<surname>Nickel</surname> +<affiliation> +<address><email>robert@artnickel.com</email></address> +</affiliation> +</author> + +<author> +<firstname>András</firstname> +<surname>Mantia</surname> +<affiliation> +<address><email>amantia@kde.org</email></address> +</affiliation> +</author> + +<othercredit role="developer"> +<firstname>Eric</firstname> +<surname>Laffoon</surname> +<affiliation> +<address><email>sequitur@kde.org</email></address> +</affiliation> +<contrib>Developer</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>András</firstname> +<surname>Mantia</surname> +<affiliation> +<address><email>amantia@kde.org</email></address> +</affiliation> +<contrib>Developer</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Dmitry</firstname> +<surname>Poplavsky</surname> +<affiliation> +<address><email>dima@kde.org</email></address> +</affiliation> +<contrib>Developer up to 2.0</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Alexander</firstname> +<surname>Yackovlev</surname> +<affiliation> +<address><email>yshurik@kde.org</email></address> +</affiliation> +<contrib>Developer up to 2.0</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>2002</year><year>2003</year><year>2004</year><year>2005</year> +<holder>&quantaplus; Development Team</holder> +</copyright> + +<legalnotice> +<para> +&FDLNotice; +</para> +</legalnotice> + +<date>2005-08-24</date> +<releaseinfo>3.4.90</releaseinfo> + +<abstract> +<para> +&quantaplus; is a Web &IDE; that strives to be neutral and +transparent to all markup languages, while supporting popular +web-based scripting languages, &CSS;, and other emerging &W3C; +recommendations. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Quanta</keyword> +<keyword>text</keyword> +<keyword>editor</keyword> +<keyword>Web</keyword> +<keyword>programmer</keyword> +<keyword>programming</keyword> +<keyword>development</keyword> +<keyword>Kommander</keyword> +<keyword>xsldbg</keyword> +<keyword>libxslt</keyword> +<keyword>debugger</keyword> +<keyword>projects</keyword> +<keyword>SGML</keyword> +<keyword>JSS</keyword> +<keyword>DTD</keyword> +<keyword>XML</keyword> +<keyword>XSD</keyword> +<keyword>W3C</keyword> +<keyword>CSS</keyword> +<keyword>Schema</keyword> +<keyword>DocBook</keyword> +<keyword>HTML</keyword> +<keyword>XHTML</keyword> +<keyword>CGI</keyword> +<keyword>PHP</keyword> +<keyword>Java</keyword> +<keyword>JavaScript</keyword> +<keyword>ColdFusion</keyword> +</keywordset> +</bookinfo> +&introduction; +&fundamentals; +&working-with-quanta; +<!-- &config-quanta; --> +&quanta-menus; +&config-quanta; +&advanced-quanta; +&extending-quanta; +&q-and-a; +&credits-license; +&installation; +&glossary; +</book> diff --git a/doc/quanta/info_tab.png b/doc/quanta/info_tab.png Binary files differnew file mode 100644 index 00000000..b1cdc3f2 --- /dev/null +++ b/doc/quanta/info_tab.png diff --git a/doc/quanta/installation.docbook b/doc/quanta/installation.docbook new file mode 100644 index 00000000..a89a6b2c --- /dev/null +++ b/doc/quanta/installation.docbook @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<appendix id="installation-3-2"> +<title>Installation</title> + +<sect1 id="acquiring-qunata-3-2"> +<title>Acquiring &quantaplus;</title> + +&install.intro.documentation; +</sect1> + +<sect1 id="source-code-building-3-2"> +<title>Building the Source</title> + +&install.compile.documentation; + +<sect2 id="source-code-building-considerations-3-2"> +<title>Considerations When Building</title> + +<para> +It is reasonable that you would want to customize the location of +the &quantaplus; files on your system. To this end, +<command>autoconf</command> has a number of options +that can be passed to the <command>configure</command> +script to control this setup. To get a complete listing of these +options, type <command>./configure</command> +<option> --help</option>. These are straight forward and will +not be covered here. +</para> + +<para> +If you are having trouble with &quantaplus; running properly, you +should check your path to ensure that the &kde; 3 +<filename class="directory">bin</filename> folder is in there. +Also, be sure that you do not have any older versions of &kde; laying +about that appear in <envar>PATH</envar> before your &kde; 3 +<filename class="directory">bin</filename> folder. The same +holds true for &Qt;. +</para> + +</sect2> +</sect1> +</appendix> diff --git a/doc/quanta/introduction.docbook b/doc/quanta/introduction.docbook new file mode 100644 index 00000000..b4be671c --- /dev/null +++ b/doc/quanta/introduction.docbook @@ -0,0 +1,134 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<chapter id="introduction-3-2"> +<chapterinfo> +<title>What is &quantaplus;?</title> +<authorgroup> +<author> +<firstname>Eric</firstname> +<surname>Laffoon</surname> +<affiliation> +<address><email>sequitur@kde.org</email></address> +</affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Fabrice</firstname> +<surname>Mous</surname> +<affiliation> +<address><email>fabrice@kde.nl</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</chapterinfo> + +<title>What is &quantaplus;?</title> + +<blockquote> +<attribution> +Eric Laffoon at http://quanta.sourceforge.net +</attribution> + +<para> +&quantaplus; is a web development tool for the K Desktop Environment. +&quantaplus; is designed for quick web development and is rapidly becoming +a mature editor with a number of great features. +</para> +<para> +Our objective remains to create the very best web development tool +anywhere. We realize that we will need many more people active to +accomplish this, so we are in the process of developing enhancements geared +toward making it easy for web developers to customize, extend, and enhance +&quantaplus;. Then we will be asking you, the web developers, to contribute +your feature enhancements. We will organize these so that &quantaplus; web +developers can find just the resources, extensions and custom plug-ins +they need to be the most kick butt developers ever. +</para> +</blockquote> + +<sect1 id="quanta-intro-3-2"> +<sect1info> +<title>&quantaplus;: Where It Was And Where It Is Going</title> +<authorgroup> +<author> +<firstname>Robert</firstname> +<surname>Nickel</surname> +<affiliation> +<address><email>robert@artnickel.com</email></address> +</affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Fabrice</firstname> +<surname>Mous</surname> +<affiliation> +<address><email>fabrice@kde.nl</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</sect1info> + +<title>&quantaplus;: Where It Was And Where It Is Going</title> + +<para> +While striving to become the best &HTML; editor, the developers of +&quantaplus; began to think about a rather intriguing idea: <quote>What if +&quantaplus; was a generic, extensible, markup language editor?</quote> +Well, that would only make it the greatest Web Development Environment +for &kde;! So it was done. +</para> + +<para> +No longer bound to &HTML;, &quantaplus; is now well on its way to becoming +an all-purpose Web Development Environment. Essentially, if you can define +it in &XML;, then &quantaplus; should be able to serve as an &IDE; for it. +</para> + +<para> +Now, with the above said, it must be noted that &quantaplus; is an +outgrowth of the outstanding efforts that have been put forth by the +entire &kde; development community. &quantaplus;, in celebration of open +source, uses the idea of <quote>Why write something somebody already +wrote?</quote> Thanks to &kde;'s framework, not only is this possible, but +it also allows users and developers to extend &quantaplus; to match their +unique needs. +</para> + +<para> +&quantaplus; provides web developers with an intuitive and powerful +multiple document interface (&MDI;). It can dramatically increase your +productivity. Through the use of custom actions, scripting, and toolbars, +you can automate almost any task. With the use of <application> +Kommander</application>, you can extend &quantaplus; in a manner in which +you never have to remember scripting command syntax again. (More about this +can be found in <xref linkend="extending-quanta-3-2" />.) +</para> +</sect1> + +</chapter> diff --git a/doc/quanta/kfr-icon.png b/doc/quanta/kfr-icon.png Binary files differnew file mode 100644 index 00000000..4ba2dcdf --- /dev/null +++ b/doc/quanta/kfr-icon.png diff --git a/doc/quanta/kfr-new-dialog.png b/doc/quanta/kfr-new-dialog.png Binary files differnew file mode 100644 index 00000000..8b483dcb --- /dev/null +++ b/doc/quanta/kfr-new-dialog.png diff --git a/doc/quanta/man-quanta.1.docbook b/doc/quanta/man-quanta.1.docbook new file mode 100644 index 00000000..bb493fac --- /dev/null +++ b/doc/quanta/man-quanta.1.docbook @@ -0,0 +1,95 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<author><personname><firstname>Ben</firstname><surname>Burton</surname></personname><email>bab@debian.org</email></author> +<date>April 8, 2003</date> +</refentryinfo> + +<refmeta> +<refentrytitle><command>quanta</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>quanta</command></refname> +<refpurpose>A &kde; based web development environment</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>quanta</command> + +<group><option>--unique</option></group> +<group><option>--nologo</option></group> +<group><option>--resetlayout</option></group> +<group><option><replaceable>filename</replaceable></option></group> +<group><option>KDE Generic Options</option></group> +<group><option>Qt Generic Options</option></group> + +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para>&quanta; Plus is a web development environment for HTML and +associate languages. It is designed for quick web development and is +rapidly becoming a mature editor with a number of great +features. &quanta; already has a good deal of PHP support in it +including the ability to run a debugger.</para> + +<para>&quanta; Plus is not in any way affiliated with any commercial +versions of &quanta;. The primary coders from the original team left +the GPL'd version to produce a commercial product.</para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<title>Application Options</title> +<varlistentry> +<term><option>--unique</option></term> +<listitem><para>Run as a one-instance application</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>--nologo</option></term> +<listitem><para>Do not show the logo during startup</para></listitem> +</varlistentry> + +<varlistentry> + <term><option>--resetlayout</option></term> + <listitem><para>Reset the layout of the user interface to the default</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> + +<para>More detailed user documentation is available from <ulink +url="help:/quanta">help:/quanta</ulink> (either enter this +<acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/quanta</parameter></userinput>).</para> + +<para>There is also further information available at <ulink url="http://sourceforge.net/projects/quanta/">http://sourceforge.net/projects/quanta/</ulink></para> +</refsect1> + +<refsect1> +<title>Authors</title> + +<para>&quanta; is currently written and maintained by Eric Laffoon <email>sequitur@kde.org</email> and Andras Mantia <email>amantia@kde.org</email>.</para> + +<para>This manual page was prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname><email>bab@debian.org</email> </para> + +</refsect1> + +</refentry> diff --git a/doc/quanta/plugin-edit.png b/doc/quanta/plugin-edit.png Binary files differnew file mode 100644 index 00000000..1dc8824e --- /dev/null +++ b/doc/quanta/plugin-edit.png diff --git a/doc/quanta/project-1.png b/doc/quanta/project-1.png Binary files differnew file mode 100644 index 00000000..8c86b8fb --- /dev/null +++ b/doc/quanta/project-1.png diff --git a/doc/quanta/project-properties.png b/doc/quanta/project-properties.png Binary files differnew file mode 100644 index 00000000..241af897 --- /dev/null +++ b/doc/quanta/project-properties.png diff --git a/doc/quanta/project-tree-view-dir-rmb-menu.png b/doc/quanta/project-tree-view-dir-rmb-menu.png Binary files differnew file mode 100644 index 00000000..a89b43fc --- /dev/null +++ b/doc/quanta/project-tree-view-dir-rmb-menu.png diff --git a/doc/quanta/project-tree-view-file-rmb-menu.png b/doc/quanta/project-tree-view-file-rmb-menu.png Binary files differnew file mode 100644 index 00000000..c587e02a --- /dev/null +++ b/doc/quanta/project-tree-view-file-rmb-menu.png diff --git a/doc/quanta/project-upload-dialog.png b/doc/quanta/project-upload-dialog.png Binary files differnew file mode 100644 index 00000000..2c641d5a --- /dev/null +++ b/doc/quanta/project-upload-dialog.png diff --git a/doc/quanta/ptab.png b/doc/quanta/ptab.png Binary files differnew file mode 100644 index 00000000..977f1dd9 --- /dev/null +++ b/doc/quanta/ptab.png diff --git a/doc/quanta/q-and-a.docbook b/doc/quanta/q-and-a.docbook new file mode 100644 index 00000000..020d4580 --- /dev/null +++ b/doc/quanta/q-and-a.docbook @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<chapter id="faq-3-2"> +<chapterinfo> +<title>Questions and Answers</title> +<authorgroup> +<author> +<firstname>Eric</firstname> +<surname>Laffoon</surname> +<affiliation> +<address><email>sequitur@kde.org</email></address> +</affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</chapterinfo> + +<title>Questions and Answers</title> + +<qandaset> +<qandaentry> +<question> +<para> +How can I help &quantaplus; development? +</para> +</question> +<answer> +<para> +We would be remiss not to point out that &quantaplus; is being built by +volunteers. Many people feel they cannot contribute to the open +source cause for one reason or another. Probably the greatest being a +feeling they do not have the skills. &quantaplus; has been developed in a +manner that allows both non-programmers and programmers help extend +&quantaplus;. There is also the issue of documentation. Software, be it +proprietary or Free/open source, is only as good as its documentation. +We are sure there is a place in &quantaplus; where your time will be most +beneficial. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +Where is &quantaplus; going from here? +</para> +</question> +<answer> +<para> +We have released &quantaplus; 3.4 and are now in preparation for the next major +release. The targeted 4.0 release is a partial rewrite of Quanta to use the +features ofered by the KDevelop framework. +Our objective remains to create the very best web development +environment. We realize that we will need many more people actively developing +&quantaplus; to accomplish this, so we are in the process of developing +enhancements geared toward making it easy for web developers to +customize, extend, and enhance &quantaplus;. Much of this has been +accomplished with the 3.4 release. Soon will be asking you, the web +developers, to contribute your feature enhancements. We will organize +these so that &quantaplus; web developers can find just the resources, +extensions, and custom plug-ins they need to be the most reliable, +professional developers ever! +</para> +</answer> +</qandaentry> + +</qandaset> +</chapter> diff --git a/doc/quanta/quanta-menus.docbook b/doc/quanta/quanta-menus.docbook new file mode 100644 index 00000000..751f4591 --- /dev/null +++ b/doc/quanta/quanta-menus.docbook @@ -0,0 +1,2265 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<chapter id="quantas-menus-3-2"> +<chapterinfo> +<title>The Menubar</title> +<authorgroup> +<author> +<firstname>Robert</firstname> +<surname>Nickel</surname> +<affiliation> +<address><email>robert@artnickel.com</email></address> +</affiliation> +</author> +<author> + <firstname>András</firstname> + <surname>Mantia</surname> + <affiliation> + <address><email>amantia@kde.org</email></address> + </affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Fabrice</firstname> +<surname>Mous</surname> +<affiliation> +<address><email>fabrice@kde.nl</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</chapterinfo> + +<title>The Menubar</title> + +<para> +This chapter explains all the various functions that can be found in the +menubar. +</para> + +<sect1 id="file-menu-3-2"> +<title>The <guimenu>File</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Create a new, blank file. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Open...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Search the file system to open an existing file. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Open Recent</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Quick list of the last several files you've opened. This list will change +each time you open a file that is not on it, with the oldest being bumped +off first. +</para> +</listitem> + +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Save the active file's changes. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Save As...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Save the active file with another name. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Save as Template</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +This allows you to save code snippets and entire files as a template for +later use. See the section on <link linkend="templates-3-2">templates</link>. +If you try to save the selected text/file outside of the local/project +template dir, then you will receive an error. +</para> +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Save as Template</guisubmenu> +<guisubmenu>Save as Local Template...</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +Allows you to save a file as a template within the local scope. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Save as Template</guisubmenu> +<guisubmenu>Save as Project Template...</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +Allows you to save a file as a template within the project scope. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Save as Template</guisubmenu> +<guisubmenu>Save Selection to Local Template File...</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +Allows you to save the selected text (⪚ a code snippet) in a local +template file. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Save as Template</guisubmenu> +<guisubmenu>Save Selection to Project Template File...</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +Allows you to save the selected text (⪚ a code snippet) in a project +template file. +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save All...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Save all modified files in the editor. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>F5</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Reload</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Reloads the current focused document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Print...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +You can actually print out your documents. Uses the <application>kprinter +</application> interface. +</para> +</listitem> +</varlistentry> +<!-- Not shown any more +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Close</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Close the currently displayed file. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Close All</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Close all open files. Prompts you to save if any files have been modified. +</para> +</listitem> +</varlistentry> +--> +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Exit &quantaplus; +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="edit-menu-3-2"> +<title>The <guimenu>Edit</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Undo the last action performed. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Redo the last action undone. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Cut</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Cut the current block of text and place its contents on the clipboard. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Copy</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Copy the current block of text to the clipboard. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Paste</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Paste the contents of the clipboard at the current cursor position. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guisubmenu>Paste Special</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guisubmenu>Paste Special</guisubmenu> +<guimenuitem>Paste HTML Quoted</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Converts the clipboard text &HTML; special characters to &HTML; entities +before pasting into the text body, so they show up properly when viewed +and aren't picked up as tags by the client browser. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guisubmenu>Paste Special</guisubmenu> +<guimenuitem>Paste &URL; Encoded</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Converts the clipboard text into &URL; encoding, which is the correct way +to include special characters and spaces into &URL;s. Used primarily when +pasting a &URL; into an anchor tag. +</para> +</listitem> +</varlistentry> +</variablelist> +</para></listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Select All</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Select all of the text in the current document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Deselect</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Unselect all text in the current document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Block Selection Mode</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Turn on/off block highlighting. Allows you to select text blocks with your +keyboard without holding down the shift key. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycap>Insert</keycap> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Overwrite Mode</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Overrides the Insert key. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +String or regular expression pattern to find in the current document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycap>F3</keycap> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find Next</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Repeat the find downward in the document from the current location. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find Previous</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Repeat the find upward in the document from the current location. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Replace...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +String or regular expression replacement of text in the current file. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Go to Line...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Go directly to a specific line number. This is really helpful when your +&PHP; script is breaking unexpectedly! +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find in Files...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Find a string or expression in files in the selected folder. Sort of a +&GUI; <command>grep</command> or <command>sed</command> with some +predefined pattern spaces to help you out. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Expand Abbreviation</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> + Expands the abbreviations. Abbreviations can be defined in the <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure Quanta...</guimenuitem> + </menuchoice> dialog. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Apply Source Indentation</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> + Reformats the source code accroding to the same rules as the &VPL; part inserts the tags. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="view-menu-3-2"> +<title>The <guimenu>View</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu> +<guisubmenu>Tool Views</guisubmenu> +</menuchoice> +</term> +<listitem> +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu> +<guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Files</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the files tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu> +<guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Project</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the project tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Templates</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the template tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Scripts</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the scripts tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Document Structure</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the document structure tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Attribute Editor</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the attribute tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Documentation</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the documentation tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Messages</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the message window. This is the window where you see the +output of any scripting actions and the debugger. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Problems</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the <guilabel>Problem Reporter</guilabel> at the bottom +of the main &quantaplus; window. The <guilabel>Problem Reporter</guilabel> +activates when you switch to the <guilabel>Structure Tree</guilabel>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Annotations</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Shows the annotation view. Read the <xref linkend="annotations" /> for details. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Upload Profile:...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Shows the files on the server for an <link linkend="upload-profiles">upload profile</link>. +</para> +</listitem> +</varlistentry> + + +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F9</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Show Icon Border</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle display of the icon border to the left of the main editor window. +This bar allows for click toggling of bookmarks. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycap>F11</keycap> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Show Line Numbers</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggles the display of line numbers along the side of +the main editor window. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycap>F10</keycap> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Dynamic Word Wrap</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Toggle on and off reformatting of text to a specific +width as you type. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Alt;<keycap>F9</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Source Editor</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Switch to the source of a document to edit. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>F9</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>&VPL; Editor</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Switch to the <guilabel>&VPL; Editor</guilabel> to edit a document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycap>F9</keycap> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>&VPL; & Source Editors</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Switch to split screen mode to edit a document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycap>F6</keycap> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Preview</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Preview the current document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Alt;<keycap>Left Arrow</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Back</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Navigate back one step in the preview. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Alt;<keycap>Right Arrow</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Forward</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Navigate forward one step in the preview after having gone back in the +preview. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycap>F5</keycap> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Reload Preview</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Reload the preview from disk. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F12</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu><guisubmenu>External Preview</guisubmenu> +<guimenuitem>View with &konqueror;</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +View the current file with &konqueror;. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>F12</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu><guisubmenu>External Preview</guisubmenu> +<guimenuitem>View with Firefox;</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +View the current file with the Mozilla Firefox browser. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F12</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu><guisubmenu>External Preview</guisubmenu> +<guimenuitem>View with Mozilla</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +View the current file with <trademark class="registered">Mozilla</trademark>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F6</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu><guisubmenu>External Preview</guisubmenu> +<guimenuitem>View with &Netscape;</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +View the current file with &Netscape;. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Alt;<keycap>F6</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu><guisubmenu>External Preview</guisubmenu> +<guimenuitem>View with Opera</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +View the current file with <application>Opera</application>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>External Preview</guisubmenu> +<guimenuitem>View with Lynx</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +View the current file with <application>Lynx</application> (a text based +browser). +</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="bookmarks-menu-3-2"> + <title>The <guimenu>Bookmarks</guimenu> Menu</title> + + <variablelist> + <varlistentry> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo> + </shortcut> + <guimenu>Bookmarks</guimenu> + <guimenuitem>Set Bookmark</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Sets a bookmark at the current line location in the current file. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <menuchoice> + <guimenu>Bookmarks</guimenu> + <guimenuitem>Clear All Bookmarks</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Clears all set bookmarks in the current document. + </para> + </listitem> + </varlistentry> + </variablelist> + <para>If you have bookmarks in the current file, they will appear in the menu together with a <guilabel>Previous</guilabel> or <guilabel>Next</guilabel> item, depending on the position of the cursor in the document.</para> + <para>If you have bookmarks in other opened documents, they will appear in the menu grouped by the file name of the other documents.</para> +</sect1> + + +<sect1 id="project-menu-3-2"> +<title>The <guimenu>Project</guimenu> Menu</title> + +<para> +How to use projects in &quantaplus; is described in <xref +linkend="quanta-projects-3-2"/>. +</para> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>New Project...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Launch the project creation wizard. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Open Project...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Open an existing project file from disk. &quantaplus; projects are saved +with the .webprj extension. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guisubmenu>Open Recent Project</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +Gives you a list of your most recently used projects for quick access. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Close Project</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Close the current project. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Open Project View...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Open a <quote>View</quote>, a specific combination of open files that you +have previously saved. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Save Project View</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Save the current set of open files as a <quote>View</quote>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Save Project View As...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Save the current set of open files as a <quote>View</quote> under another +name. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Delete Project View</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Delete a <quote>View</quote>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Insert Files...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Presents a dialog that allows you to select files to add to your current +project. These files will then be copied into the project folder for +editing. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Insert Folder...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Insert a folder and all of its contents into the current project. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Rescan Project Folder...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Scan the project folder for any new files you may have there. This +allows you to copy graphics into your project folder or a subfolder +thereof and then add them to the project. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycap>F8</keycap> +</shortcut> +<guimenu>Project</guimenu> +<guimenuitem>Upload Project...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Upload the files in your project to the hosting server. The list of +available transports depends on the version of &kde; you are running and +whether or not you've downloaded extra KIO slaves. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F7</keycap></keycombo> +</shortcut> +<guimenu>Project</guimenu> +<guimenuitem>Project Properties</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Settings affecting the way &quantaplus; manages your project. See the +<link linkend="quanta-projects-3-2">&quantaplus; projects</link> section for +details. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="toolbars-menu-3-2"> +<title>The <guimenu>Toolbars</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guisubmenu>Load Toolbars</guisubmenu> +</menuchoice> +</term> +<listitem> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guisubmenu>Load Toolbars</guisubmenu> +<guimenuitem>Load Global Toolbar...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Loads a globally defined toolbar. These are kept in <filename +class="directory">$<envar>KDEDIR</envar>/share/apps/quanta/toolbars</filename> +by default. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guisubmenu>Load Toolbars</guisubmenu> +<guimenuitem>Load Local Toolbar...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Loads a locally defined toolbar. These are kept in <filename +class="directory">$<envar>HOME</envar>/.kde/share/apps/quanta/toolbars</filename> +by default. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guisubmenu>Load Toolbars</guisubmenu> +<guimenuitem>Load Project Toolbar</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Loads a project toolbar. These are kept in <filename +class="directory"><replaceable>ProjectDir</replaceable>/toolbars</filename> +and are only available in this menu if they have been assigned to this +project. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guisubmenu>Save Toolbars</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +Dialog for saving your toolbars. Allows you to pick the type of toolbar; +Local or Project. +</para> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guisubmenu>Save Toolbars</guisubmenu> +<guimenuitem>Save as Local Toolbar...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Save as a local toolbar to +<filename class="directory">$<envar>HOME</envar>/.kde/share/apps/quanta/toolbars</filename> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guisubmenu>Save Toolbars</guisubmenu> +<guimenuitem>Save as Project Toolbar...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Save as a project toolbar in +<filename class="directory"><replaceable>ProjectDir</replaceable>/toolbars</filename> +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guimenuitem>Add User Toolbar...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Brings up a dialog to create a new toolbar. This only creates the name. +Actions must be added from the +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Actions</guimenuitem> +</menuchoice> +menu item. Toolbars are saved via the +<menuchoice> +<guimenu>Toolbars</guimenu> +<guimenuitem>Save Toolbars</guimenuitem> +</menuchoice> +menu or on close unsaved toolbars will prompt for you to save. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guimenuitem>Remove User Toolbar...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Remove a toolbar from usage. This does not remove it from the disk. If +you've not saved the toolbar you are removing, you will be prompted to +save it. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guimenuitem>Rename User Toolbar..</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Allows you to rename a toolbar. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guimenuitem>Send Toolbar in E-Mail...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +This is a hook to email your custom toolbar to someone (maybe the +&quantaplus; team for inclusion in the next release!) for their use. It +spawns an email window and attaches your toolbar file to it automatically. +</para> +</listitem> +</varlistentry> + +<varlistentry> + <term> + <menuchoice> + <guimenu>Toolbars</guimenu> + <guimenuitem>Send Toolbar in Email...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This is allows you to upload a toolbar to the main resource server. See <xref linkend="sharing-resources" />. + </para> + </listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guimenuitem>Upload Toolbar...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> + This is allows you to upload toolbars to the main server, from where others can download it.See <xref linkend="sharing-resources" />. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term> +<menuchoice> +<guimenu>Toolbars</guimenu> +<guimenuitem>Download Toolbar...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> + This is allows you to download toolbars from the Internet.See <xref linkend="download-resources" />. +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="DTD-menu-3-2"> +<sect1info> +<title>The <guimenu>&DTD;</guimenu> Menu</title> +<authorgroup> +<author> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +</author> +</authorgroup> +</sect1info> + +<title>The <guimenu>&DTD;</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>&DTD;</guimenu> +<guimenuitem>Change the &DTD;...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Pops up a dialog box that allows you to change the current documents &DTD; +</para> +</listitem> +</varlistentry> +<varlistentry> + <term> + <menuchoice> + <guimenu>&DTD;</guimenu> + <guimenuitem>Edit &DTD; Settings...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Makes possible to change the &descriptionrc; configuration file for a &DTEP;. + </para> + </listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>&DTD;</guimenu> +<guimenuitem>Load & Convert &DTD;...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Load a &DTD; that you or someone else made and convert it to &quantaplus;' +native description format. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>&DTD;</guimenu> +<guimenuitem>Load &DTD; Entities...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Load/update the entities from a &DTD;. It is useful if you want to update the entities in a &DTEP; without regenerating the whole &DTEP;. +In case the &DTEP; is a global one and you do not have write permission to the global KDE directory, the entity loading will fail. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>&DTD;</guimenu> +<guimenuitem>Load &DTD; Package (&DTEP;)...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Load a your own &DTEP;. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>&DTD;</guimenu> +<guimenuitem>Send &DTD; Package (&DTEP;) in E-Mail...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Send your &DTEP; to a friend via &kmail;. +</para> +</listitem> +</varlistentry> + +<varlistentry> + <term> + <menuchoice> + <guimenu>&DTD;</guimenu> + <guimenuitem>Upload &DTD; Package (&DTEP;)...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This is allows you to upload a &DTEP;s. See <xref linkend="sharing-resources" />. + </para> + </listitem> +</varlistentry> +<varlistentry> +<term> +<menuchoice> +<guimenu>&DTD;</guimenu> +<guimenuitem>Download &DTD; Package (&DTEP;)...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> + This is allows you to download &DTEP;s from the Internet. See <xref linkend="download-resources" />. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="tags-menu-3-2"> +<title>The <guimenu>Tags</guimenu> Menu</title> + +<para> +This menu contains a list of the elements that are in the currently loaded +toolbars. If you have the Standard (&HTML;) toolbar loaded, the <guimenu> +Tags</guimenu> menu will contain a submenu <guisubmenu>Standard +</guisubmenu> which will contain the list of tags/actions on that toolbar. +</para> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo> +</shortcut> +<guimenu>Tags</guimenu> +<guimenuitem>Edit Current Tag...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Allows you to access the current markup tag settings dialog if one exists. +This entry is always present, followed by the &DTD; specific submenus. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tags</guimenu> +<guimenuitem>Select Current Tag Area</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +This highlights the current tag area. The tag area begins where the mouse +cursor is placed. +</para> +</listitem> +</varlistentry> +<varlistentry> + <term> + <menuchoice> + <guimenu>Tags</guimenu> + <guimenuitem>Smart Tag Insertion</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Activates/deactivates the smart insertion of tags. Currently it works only in (X)HTML DTDs. Smart insertion means that &quantaplus; will refuse to insert a tag using the toolbar if the tag cannot be present in the current location. + </para> + </listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="plugins-menu-3-2"> +<title>The <guimenu>Plugins</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Plugins</guimenu> +<guimenuitem><replaceable>Plugin</replaceable></guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +The <menuchoice><guimenu>Plugins</guimenu></menuchoice> menu lists the +available plugins under the above menu items. Clicking them will activate +them. Clicking an activated plugin will deactivate it. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + + +<sect1 id="tools-menu-3-2"> +<title>The <guimenu>Tools</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guisubmenu>Highlight Mode</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +Choose the syntax highlighting mode for the current file. The list of +available highlighting schemes varies depending on your version of &kate;. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guisubmenu>End of Line</guisubmenu> +</menuchoice> +</term> +<listitem> +<para> +Select the end of line encoding type. Useful if you have folks using other +&OS; platforms to develop on. Choose from +<guimenuitem>Unix</guimenuitem>, +<guimenuitem>Windows/DOS</guimenuitem> or +<guimenuitem>Macintosh</guimenuitem>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Indent</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Move the selected block of text one tab width to the right. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>I</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Unindent</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Move the selected block of text one tab width to the left. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Clean Indentation</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Removes all indentation. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Comment</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Comments selected text. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>D</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Uncomment</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Uncomments selected text. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Word Wrap Document</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Wrap the text in the current window to a predefined width. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Spelling...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Check the spelling in the current document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Document Properties</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Edit specific properties of a currently loaded document when using the +<guilabel>&VPL; Editor</guilabel>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Convert Tag & Attribute Case...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Convert all tags and/or attributes character cases to another. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Alt;&Ctrl;<keycap>T</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>HTML Tidy Syntax Checking</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Checks the syntax of the current document against the selected &DTD; using the external <filename>tidy</filename> application. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="window-menu-3-2"> + <title>The <guimenu>Window</guimenu> Menu</title> + <variablelist> + <varlistentry> + <term> + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Close</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Closes the current tab (document, plugin, preview or documentation). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Close All</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Closes all opened tabs. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>MDI Mode</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + On-the-fly switching between different UI modes. Due to some limitations in the KDE libraries, the switching might take time and cause ugly artifacts. The recommended modes to use + are <guilabel>IDEAl Mode</guilabel>, which is the default or + <guilabel>Tab Page Mode</guilabel>, which is the same mode that was present in &quantaplus; 3.2 and earlier versions. + </para> + </listitem> + </varlistentry> + </variablelist> + <para>Furthermore this menu contains an entry for every opened tab. By selecting such an entry, that selected tab will become the active one.</para> +</sect1> + +<sect1 id="settings-menu-3-2"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Toolbars</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Show or hide the non-user toolbars. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Show/Hide DTD Toolbar</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Toggle on and off the display of the &DTD; specific toolbar. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Show/Hide Statusbar</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Toggle on and off the display of the status bar at the bottom of the main + &quantaplus; window. + </para> + </listitem> + </varlistentry> +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Quanta...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Setup the <link linkend="configure-quanta">behavior</link> of &quantaplus;. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure Preview...</guimenuitem> + </menuchoice> +</term> +<listitem> + <para> + Setup the behavior of the integrated preview. <important><para>The changes made in the dialog have effects on every application using the KHTML part, including the &konqueror; web browser.</para></important> + </para> +</listitem> +</varlistentry> + + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Actions...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> + This is where you define the actions for use on toolbars. See <xref linkend="user-actions" />. +</para> +</listitem> +</varlistentry> + +<varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure Plugins...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This is where you can define and modify the plugins. + </para> + </listitem> +</varlistentry> + +<varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure Editor...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Setup the behavior of the editor window. See the documentation on &kate; + for details. + </para> + </listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Dialog that allows you to add/delete items to/from toolbars and change the +order the icons appear in. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Allows you to configure the many editor shortcuts available to +&quantaplus;. +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="help-menu-3-2"> +<title>The <guimenu>Help</guimenu> Menu</title> + +<para> +&quantaplus; contains a standard &kde; <guimenu>Help</guimenu> menu with +the addition of these items: +</para> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo> +</shortcut> +<guimenu>Help</guimenu> +<guimenuitem>Context Help</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +This should produce help based on the current pointer context. At the time +of this writing this feature is not implemented. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>Make A Donation</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +&quantaplus; is a high quality product that is freely available, and +freely licensed, but like any open source project, its developers can +always use help. If you would like to support &quantaplus; development in a +financial manner, you can find out how to here. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<para> +The standard &kde; help menu items are as follows: +</para> + +&help.menu.documentation; + +</sect1> +</chapter> diff --git a/doc/quanta/quanta-projects.docbook b/doc/quanta/quanta-projects.docbook new file mode 100644 index 00000000..06814ebb --- /dev/null +++ b/doc/quanta/quanta-projects.docbook @@ -0,0 +1,792 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<sect1 id="quanta-projects-3-2"> +<sect1info> +<title>Projects</title> +<authorgroup> +<author> +<firstname>Robert</firstname> +<surname>Nickel</surname> +<affiliation> +<address><email>robert@artnickel.com</email></address> +</affiliation> +</author> +<author> + <firstname>András</firstname> + <surname>Mantia</surname> + <affiliation> + <address><email>amantia@kde.org</email></address> + </affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Fabrice</firstname> +<surname>Mous</surname> +<affiliation> +<address><email>fabrice@kde.nl</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</sect1info> + +<title>Projects</title> + +<sect2 id="create-new-project-3-2"> +<title>New Projects</title> + +<para> +The &quantaplus; project wizard +(<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>New Project...</guimenuitem> +</menuchoice>) makes project creation an easy task. +</para> + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="project-1.png" /> +</imageobject> +<caption><para>The Project Wizard.</para></caption> +</mediaobject> + +<para> +The fields are pretty straight forward. It is best to fill them in from +top to bottom. Filling in a project name will autocomplete all the +folder structure for the rest of the project. All of the paths and +author information fields can be configured later on clicking +<menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F7</keycap></keycombo> +</shortcut> +<guimenu>Project</guimenu> +<guimenuitem>Project Properties</guimenuitem> +</menuchoice>. +</para> + +<variablelist> +<title>General Project Settings</title> +<varlistentry> +<term><guilabel>Name</guilabel></term> +<listitem> +<para> +Here you fill in the name for your project. For example, we will call ours +<quote><literal>foo</literal>.</quote> When you fill in +<guilabel>Name</guilabel>, <guilabel>File</guilabel> is filled out for +you automatically. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>File</guilabel></term> +<listitem> +<para> +This is the name of the &quantaplus; project file. By default, it is the +name of your project, but in lowercase letters and without spaces. It +uses the extension <literal role="extension">webprj</literal> (⪚ +<filename>foo.webprj</filename>). This file is stored in the root of the +project's Main Folder. +</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<varlistentry> +<term>Server Settings</term> +<listitem> +<variablelist> +<varlistentry> +<term><guilabel>Protocol</guilabel></term> +<listitem> +<para> +Here you select the protocol you will be using to access you project. If +your project is on the same machine that you are using Quanta Plus on, +then leave the value at Local. The list of protocols shown here is +dependant of your system setup. Available protocols include SSH, FTP, NFS, +SMB, WebDAV, and others. The protocol list is powered by &kde;'s +powerful KIOSlave architecture. This framework allows every &kde; +application to easily access remote information as if it is local to the +machine. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Host</guilabel></term> +<listitem> +<para> +Here you fill in the server address of the machine you want to access, +unless you are working through the Local protocol. Either a hostname +(hostname.example.com) or an IP address (127.0.0.1) can go here. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>User</guilabel></term> +<listitem> +<para> +User name for logging onto the remote machine. This is case-sensitive. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Password</guilabel></term> +<listitem> +<para> +Password for logging onto the remote machine. This is case-sensitive. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Port</guilabel></term> +<listitem> +<para> +Leave this field blank to use the default port for the protocol you are +using. You may need to change this depending on your server's +configuration. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + + +<variablelist> +<varlistentry> +<term>Directory Settings</term> +<listitem> +<variablelist> +<varlistentry> +<term><guilabel>Main directory</guilabel></term> +<listitem> +<para> +This is the root folder where all of the project files and folders +will be stored. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Templates directory</guilabel></term> +<listitem> +<para> +This is where the templates for this project will be stored. It is a relative path to the project and by default, +it points to +<filename class="directory">templates</filename>. +If you have a common set of files that you use for several +projects, then it may be useful to point this field to it, instead of to +the default. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Toolbars directory</guilabel></term> +<listitem> +<para> + This is where the toolbars for this project will be stored. It is a relative path to the project and by default, +it points to <filename>toolbars</filename>. +If you have a common set of toolbars +that you use for several projects, it may be useful to point this there +instead of the default. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + + +<variablelist> +<varlistentry> +<term>Project Sources</term> +<listitem> +<variablelist> +<varlistentry> +<term><guilabel>Add local or remote files</guilabel></term> +<listitem> +<para> +This allows you to get files from the local file system. You can choose +multiple files or entire folders. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Use wget to download files from site</guilabel></term> +<listitem> +<para> +This option is great if you have static web content that you wish to +download and modify. For server side scripting (⪚ &PHP;, Python, +&etc;.) you will have to get the files another way. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<title>Insert Files in Project</title> +<varlistentry> +<term><guilabel>Insert file from</guilabel></term> +<listitem> +<para> +Check this if you wish to include files found in the path of the Main +Folder. Leave unchecked when starting a project from scratch. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Filters</term> +<listitem> +<variablelist> +<varlistentry> +<term><guilabel>Insert only markup, script and image files</guilabel></term> +<listitem> +<para> +Choosing this option will only insert markup, script, and image files into +your project. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Insert files with the following mask</guilabel></term> +<listitem> +<para> +Choosing this option will display all files and folders within the +Main Folder and allow you to be more specific with your choices. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Included files</guilabel></term> +<listitem> +<para> +This displays a list of the files in the Main Folder. You can choose +the desired files for inclusion, by checking, or exclusion, by unchecking, +in your project. +</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<title>More Project Settings</title> +<varlistentry> +<term><guilabel>Author</guilabel></term> +<listitem> +<para> +Insert your name (or alias) here. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Email</guilabel></term> +<listitem> +<para> +The address where you would like email regarding this project to go. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Project Defaults</term> +<listitem> +<variablelist> +<varlistentry> +<term><guilabel>Default DTD</guilabel></term> +<listitem> +<para> +Choose the markup language you will be working with the most within this +project. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Default encoding</guilabel></term> +<listitem> +<para> +Choose the character encoding you wish the files in your project to be +opened and saved with. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Use preview prefix</guilabel></term> +<listitem> +<para> +Check this to use a prefix for your previews. This allows you to set the +path prefix to something other than your local file system. This is most +useful for pages that contain dynamic content and are dependent on server +processing (like &PHP;, <acronym>JSS</acronym>, Python, &etc;). Simply +type in the first portion of the address as it exists on that server and +the filepath at the end will be complete by &quantaplus;. For example, if +you have the domain <literal>bar.com</literal> and you are editing the +<filename>index.html</filename> page, you could edit it on your remote +machine (<systemitem>foo.bar.com</systemitem>), upload it to the server +and press <keycap>F6</keycap> to see the results from +<systemitem>www.bar.com</systemitem> instead of your local file system. +</para> +<variablelist> +<varlistentry> +<term><guilabel>Prefix</guilabel></term> +<listitem> +<para> +Enter the prefix you wish to use here. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Insert global templates</guilabel></term> +<listitem> +<para> +This makes a copy of the global templates in your projects folder tree. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Insert local templates</guilabel></term> +<listitem> +<para> +This makes a copy of the local templates in your projects folder tree. +</para> +</listitem> +</varlistentry> +</variablelist> + +<para> +The last screen of the new project wizard has 3 settings that can make +your life easier. These settings are available for change from the +<menuchoice> +<guimenu>Project</guimenu> +<guimenuitem>Project Properties</guimenuitem> +</menuchoice> +menu tree on the Upload Profiles Tab or with the keyboard shortcut +<keycombo action="simul">&Shift;<keycap>F7</keycap></keycombo>. +</para> + +</sect2> + +<sect2 id="configuring-projects-3-2"> +<title>Configuring Projects</title> +<para> + The project properties dialog looks like: + <mediaobject> + <imageobject> + <imagedata fileref="project-properties.png" format="PNG" /> + </imageobject> + <caption><para>The general options page</para></caption> + </mediaobject> +</para> + +<para> + Some of the items are the same as in the project wizard and are described in <xref linkend="create-new-project-3-2" />. The extra items are described below. +<variablelist> +<title>General Project Settings</title> +<varlistentry> +<term><guilabel>Exclude from project</guilabel></term> +<listitem> +<para> + A list of file names (wildcards can be used) that will be ignored when you do project related operations like <guimenuitem>Rescan Project Folder</guimenuitem>. +</para> +</listitem> +</varlistentry> +<varlistentry> + <term><guilabel>Exclude files listed in .cvsignore</guilabel></term> + <listitem> + <para> + A complementary option to the above one, also files listed in the .cvsignore file will be excluded from the project. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term><guilabel>Default view</guilabel></term> + <listitem> + <para> + The project view that will be loaded when the project is opened. + You can read more about project views in <xref linkend="project-views-3-2" />. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term><guilabel>Debugger</guilabel></term> + <listitem> + <para> + Select the debugger you want to use. Currently only Gubed is support. You can find more information about Gubed at <ulink url="http://gubed.sourceforge.net"></ulink>.The debugger plugin can be configured with the <guilabel>Options</guilabel> button. + read <xref linkend="debugging-3-2" /> to learn more about debugging. + </para> + </listitem> +</varlistentry> +<varlistentry> + <term><guilabel>Default view</guilabel></term> + <listitem> + <para> + The project view that will be loaded when the project is opened. + You can read more about project views in <xref linkend="project-views-3-2" />. + </para> + </listitem> +</varlistentry> +</variablelist> +</para> +<para>On the <guilabel>Upload Profiles</guilabel> page you can configure the upload profiles (see <xref linkend="upload-profiles" />), as well as enable the showing of a treeview with the content of the server for each profile by checking the <guilabel>Show a treeview for each profile</guilabel> checkbox. +</para> +<para> + On the <guilabel>Team Configuration</guilabel> page you can add, edit and remove members of the project as well as define a mailing list. Read <xref linkend="team-members" /> for details. +</para> +<para> + On the <guilabel>Event Configuration</guilabel> page you can <guilabel>Enable the event actions</guilabel>, add, modify and remove these actions. Event actions are executed when some predefined event occurs, like saving a file. See <xref linkend="event-actions" /> for details. +</para> +</sect2> + +<sect2 id="using-projects-3-2"> +<title>Using Projects</title> + +<sect3 id="project-files-3-2"> +<title>Project Files</title> + +<para> +By default &quantaplus; will open the last project accessed when launched. +This behavior is not currently configurable. +</para> + +<para> +To open another project, select <guimenuitem>Open Project...</guimenuitem> from the +<guimenu>Project</guimenu> menu or the <guiicon>Open Project</guiicon> +icon on the toolbar. The open project dialog will pop up and allow you to +choose the project you wish. Projects have a <literal +role="extension">webprj</literal> extension. +</para> + +<para> +When closing &quantaplus;, your project file will be saved automatically. +You will be asked to save any changes before exiting if &quantaplus; +detects any changed files. This same behavior occurs if you load a new +project. +</para> + +</sect3> + +<sect3 id="project-tree-view-3-2"> +<title>The Project Tree View</title> + +<para> +The project tree view gives you uncluttered access to the files in your +project. This is where you manage the files in the current project. +</para> + +<para>For files, a &RMB; click brings up the following menu:</para> + +<mediaobject> +<imageobject> +<imagedata fileref="project-tree-view-file-rmb-menu.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +These items are fairly self-explanatory and will be left to the reader +for exploration. +</para> + +<para> +Folders are similar but do not contain the <guimenuitem>Open</guimenuitem> +and <guimenuitem>Open With...</guimenuitem> &RMB; menu items: +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="project-tree-view-dir-rmb-menu.png" format="PNG" /> +</imageobject> +</mediaobject> + +<para> +These items are left to the reader for exploration as well. +</para> + +</sect3> + +<sect3 id="upload-project-3-2"> +<title>Uploading Projects</title> + +<para> +The Upload Project dialog: +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="project-upload-dialog.png" format="PNG" /> +</imageobject> +<caption><para>The Upload Project dialog.</para></caption> +</mediaobject> + +<variablelist> +<varlistentry> +<term><guilabel>Profile name</guilabel></term> +<listitem> +<para> +This is where different <link linkend="upload-profiles">profiles</link> can be chosen. The profile contains +information on where the uploaded files are to be placed. Read <xref linkend="upload-profiles" />. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guibutton>New</guibutton></term> +<listitem> +<para> +This button allows you to create new upload profiles. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Edit</guibutton></term> +<listitem> +<para> +This allows you to edit the currently selected upload profile. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Remove</guibutton></term> +<listitem> +<para> +This allows you to remove the current profile. If only +one profile is available the button is grayed out to prevent its +removal. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Keep passwords in memory</guilabel></term> +<listitem> +<para> +The password is stored in memory and is lost as soon as the program is closed. +This option is useful if frequent uploading of files is necessary and you do +not want to use the more insecure <quote>Store password on disc</quote> option. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>All</guibutton></term> +<listitem> +<para> +Select all files in your project for upload. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Modified</guibutton></term> +<listitem> +<para> +Select all modified files for upload. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>None</guibutton></term> +<listitem> +<para> +Unselects all files in the list. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Invert</guibutton></term> +<listitem> +<para> +Selects/Unselects all files in the list. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Expand All</guibutton></term> +<listitem> +<para> +Expands all folders. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Collapse All</guibutton></term> +<listitem> +<para> +Collaspes all folders. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Update All</guibutton></term> +<listitem> +<para> +Refreshes list. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Proceed</guibutton></term> +<listitem> +<para> +Start the upload +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Cancel</guibutton></term> +<listitem> +<para> +This will abort your transfer in progress or just exit out of the dialog +if you change your mind before starting the upload. +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect3> + +<sect3 id="upload-profiles"> +<title>Upload profiles</title> +<para> +With &quantaplus; you can define multiple upload profiles and, in this +way, upload your project (or parts of your project) to different servers. +When you edit or create a profile you will face the following dialog: +<mediaobject> +<imageobject> +<imagedata fileref="edit-upload-profile.png" format="PNG" /> +</imageobject> +</mediaobject> +</para> +<variablelist> +<varlistentry> +<term><guilabel>Profile name</guilabel></term> +<listitem> +<para>Enter the name you wish to give your profile here.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Host</guilabel></term> +<listitem> +<para> +This is the hostname of the server you are copying the files to. Either a +fully qualified domain name, or an IP address is needed. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Protocol</guilabel></term> +<listitem> +<para> +Transfer protocol to use for this upload. Depending on your version of +&kde; this list will vary. At the very least you should be able to choose +from &FTP;, file (&ie; local) and <acronym>NFS</acronym>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Port</guilabel></term> +<listitem> +<para> +Port for the transfer. Usually this will not need to be changed unless your +network administrator is hosting a service on a port other than its well +known port. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>User</guilabel></term> +<listitem> +<para> +Username to use for authentication. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Password</guilabel></term> +<listitem> +<para> +Password to use for authentication. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Store password on disc</guilabel></term> +<listitem> +<para> +Depending on your level of paranoia, this is a time saving feature, or a +danger. Use it at your discretion. The password is kept on disk as text in an obscured form, so it's not simple to read it, but anyone with programming knowledge can easily un-obscure it. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Path</guilabel></term> +<listitem> +<para> +This is the base path on the remote host that you will be copying files +to. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use as default profile</guilabel></term> +<listitem> +<para> +Allows you to mark the profile currently being viewed as the default. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect3> +</sect2> + +<sect2 id="project-views-3-2"> + <title>Project Views</title> + <para> + A project view is just a set of files and toolbars. You can have multiple views in a project, meaning that by simply changing the view you can load several files and toolbars which will replace the currently opened files and toolbars. + </para> + <para> + Views can be saved, opened, deleted using the <guimenu>Project</guimenu> menu or the <guilabel>Project Toolbar</guilabel>, accessible via <menuchoice><guimenu>Settings</guimenu><guisubmenu>Toolbars</guisubmenu><guimenuitem>Project Toolbar</guimenuitem></menuchoice>. + </para> + <para> + You can have a default view (loaded when the project is opened). See <xref linkend="configuring-projects-3-2" />. + </para> +</sect2> +</sect1> diff --git a/doc/quanta/quantamdi-editor.png b/doc/quanta/quantamdi-editor.png Binary files differnew file mode 100644 index 00000000..c20e92b0 --- /dev/null +++ b/doc/quanta/quantamdi-editor.png diff --git a/doc/quanta/quantamdi-treeview.png b/doc/quanta/quantamdi-treeview.png Binary files differnew file mode 100644 index 00000000..69f0a5c6 --- /dev/null +++ b/doc/quanta/quantamdi-treeview.png diff --git a/doc/quanta/quantamdi.png b/doc/quanta/quantamdi.png Binary files differnew file mode 100644 index 00000000..8c85833f --- /dev/null +++ b/doc/quanta/quantamdi.png diff --git a/doc/quanta/script-action.png b/doc/quanta/script-action.png Binary files differnew file mode 100644 index 00000000..6eaf85a6 --- /dev/null +++ b/doc/quanta/script-action.png diff --git a/doc/quanta/tag-actions.png b/doc/quanta/tag-actions.png Binary files differnew file mode 100644 index 00000000..3f5acd2a --- /dev/null +++ b/doc/quanta/tag-actions.png diff --git a/doc/quanta/tag_misc.png b/doc/quanta/tag_misc.png Binary files differnew file mode 100644 index 00000000..7ae77650 --- /dev/null +++ b/doc/quanta/tag_misc.png diff --git a/doc/quanta/taginputex.png b/doc/quanta/taginputex.png Binary files differnew file mode 100644 index 00000000..f2f8f87e --- /dev/null +++ b/doc/quanta/taginputex.png diff --git a/doc/quanta/team-editing.png b/doc/quanta/team-editing.png Binary files differnew file mode 100644 index 00000000..a81d2041 --- /dev/null +++ b/doc/quanta/team-editing.png diff --git a/doc/quanta/template-rmb.png b/doc/quanta/template-rmb.png Binary files differnew file mode 100644 index 00000000..ffa3b05f --- /dev/null +++ b/doc/quanta/template-rmb.png diff --git a/doc/quanta/text-action.png b/doc/quanta/text-action.png Binary files differnew file mode 100644 index 00000000..9372b95a --- /dev/null +++ b/doc/quanta/text-action.png diff --git a/doc/quanta/toolbars.png b/doc/quanta/toolbars.png Binary files differnew file mode 100644 index 00000000..0027e0fa --- /dev/null +++ b/doc/quanta/toolbars.png diff --git a/doc/quanta/ttab.png b/doc/quanta/ttab.png Binary files differnew file mode 100644 index 00000000..f6d5c08b --- /dev/null +++ b/doc/quanta/ttab.png diff --git a/doc/quanta/view_sidetree.png b/doc/quanta/view_sidetree.png Binary files differnew file mode 100644 index 00000000..ddf73f5f --- /dev/null +++ b/doc/quanta/view_sidetree.png diff --git a/doc/quanta/vplsourceview.png b/doc/quanta/vplsourceview.png Binary files differnew file mode 100644 index 00000000..ba6e3472 --- /dev/null +++ b/doc/quanta/vplsourceview.png diff --git a/doc/quanta/working-with-quanta.docbook b/doc/quanta/working-with-quanta.docbook new file mode 100644 index 00000000..4a0ca0b1 --- /dev/null +++ b/doc/quanta/working-with-quanta.docbook @@ -0,0 +1,650 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<chapter id="using-quanta-3-2"> +<chapterinfo> +<title>Working With...</title> +<authorgroup> +<author> +<firstname>Robert</firstname> +<surname>Nickel</surname> +<affiliation> +<address><email>robert@artnickel.com</email></address> +</affiliation> +</author> +<author> + <firstname>András</firstname> + <surname>Mantia</surname> + <affiliation> + <address><email>amantia@kde.org</email></address> + </affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Fabrice</firstname> +<surname>Mous</surname> +<affiliation> +<address><email>fabrice@kde.nl</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</chapterinfo> + +<title>Working With...</title> + +<para> +This chapter describes the parts of &quantaplus; that you will be +interacting with mostly. These not only make your more productive, but +they also allow you to customize &quantaplus; to your work-flow. +</para> + +<sect1 id="toolbars-howto-3-2"> +<title>Toolbars</title> + +<para> +As previously mentioned, toolbars in &quantaplus; are primarily managed +through the <guimenu>Toolbars</guimenu> menu. Usage and creation are +somewhat different. The creation of toolbars is discussed in a later +section entitled <quote><link linkend="creating-toolbars-3-2">Creating +Toolbars</link>.</quote> +</para> + +<para> +Using toolbars is quite simple. When you click on an icon for a desired +element or action, one of three possibilities occur: the element is +inserted (optionally with a closing element); an element dialog is +activated, allowing you to fill in the attributes in a dialog box; or, +lastly, an action is activated and does something nifty for your current +file or project. If you find yourself doing tedious and redundant typing +for a particular element, that is not in &quantaplus;, then you can add it. +See <xref linkend="dtep-intro-3-2" /> for more information. +</para> + +<para> +Configuring the toolbars and the elements on it can be done either by +using the context menu (right click on a toolbar), where you can +create a <guilabel>New Action</guilabel>, a <guilabel>New Toolbar</guilabel>, you can perform other actions like <guilabel>Remove Toolbar</guilabel>, <guilabel>Rename Toolbar</guilabel> or <guilabel>Configure Toolbars</guilabel>, which will get you the dialog where you can specify which actions should be visible on this or other toolbars. +</para> +<para> + By invoking the context menu on an action (icon) placed to a toolbar, aside of the above actions you will see the <guilabel>Remove Action</guilabel> and <guilabel>Edit Action</guilabel> entries, which speak for themselves. +</para> +<para> + The toolbars and the actions on them can be configured by using the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars...</guimenuitem></menuchoice> and <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Actions..</guimenuitem></menuchoice> menu entries. +</para> +<para> + About the user definable actions you can read in <xref linkend="user-actions" />. +</para> + +<para> +A tag dialog looks just like the following: + +<mediaobject> +<imageobject> +<imagedata fileref="taginputex.png" format="PNG" /> +</imageobject> +<caption><para>An example of a tag dialog.</para></caption> +</mediaobject> +</para> + +<para> +The above image is the dialog for the anchor tag. If you know &HTML;/&XHTML;, +then you should have noticed that all the attributes that you can use, in +an anchor element, are available. Notice the tabs above for +<guilabel>Main</guilabel>, <guilabel>Core and i18n</guilabel>, +<guilabel>Events</guilabel>, and <guilabel>Focus</guilabel>, they hold +all of the other attributes, according to their purpose, available to the +anchor element. All you need do is: fill in the blanks for the attributes +you want in your anchor, omit the attributes you do not want, and click OK. +You now have a well formed anchor set down at the current cursor position. +</para> +</sect1> + +&quanta-projects; + +<sect1 id="templates-3-2"> +<title>Templates</title> + +<para> +Templates are basically skeleton documents, code snippets and files to +link to. &quantaplus; uses templates fundamentally as a standard file +system with enhanced organization and interfacing. You can copy, move or +link any repository currently on your system into the templates tree. +Think of &quantaplus; templates as having roughly the limitations to your +imagination that your file system has. +</para> + +<para> +Templates exist in nested folders. There is no limit to how deep you +can nest them, however, within any given folder &quantaplus; expects a +consistent action for the base template type described below. Additionally +templates allow for pre and post text to be concatenated to non document +type templates. This facilitates tag creation. The next update after the +introduction is scheduled to add the ability to pass variables to the text +such as image size information to assist in tag creation. +</para> + +<para> +Our goal with templates is to extend them to include multi file +<quote>concept</quote> templates useful for things like placing an order or +creating an about section. Ideally this will be a tool for making your +work more productive and dynamic. An eventual goal is to have a structural +template design mode to deal with site layout and structure which you +could use to design and interactively update your sites. If you would like +to be involved, check out our +<ulink url="http://quanta.sourceforge.net/main1.php?contfile=needs">help +wanted</ulink> page. +</para> + +<important> +<para> +Some of the templates that ship with &quantaplus; have conditions for +their usage. Please read carefully the usage statement of conditions at +the top of each template before you use it. +</para> +</important> + +<sect2 id="template-types-3-2"> +<title>Template Types</title> + +<para> +There are various template types supported by &quantaplus;. +These are: +</para> +<para> +<simplelist> +<member>Binary templates</member> +<member>Document templates</member> +<member>Text snippets</member> +<member>Site templates</member> +</simplelist> + +Examples for these types are provided with &quantaplus;. +</para> +<variablelist> +<varlistentry> +<term>Binary templates</term> +<listitem> +<para> +Binaries are anything not identified purely in text. They can be any file, +except text, including images, &PDF;s, flash files, etc. Binary templates +are usually included in your document via links (&ie; images as +an <sgmltag class="starttag">img src=/src/url</sgmltag>). +Some examples can be found in the Templates tree under Global Templates. +Please see <xref linkend="qit-3-2" /> for more information on the +<guilabel>Templates</guilabel> tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Document templates</term> +<listitem> +<para> +Documents can be any type of text document. You can create new documents +based on these templates. Generally you would want to nest +more specific or diverse documents in subfolders. Here you can make a +basic framework for what you do and deliver it to your work in an +organized fashion and realize much better efficiency. Some examples +can be found in the Templates tree under Global Templates. +Please see <xref linkend="qit-3-2" /> for more information on the +<guilabel>Templates</guilabel> tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Text snippets</term> +<listitem> +<para> +This type of template is useful when you don't want to create a new +document based on a template, but want to insert the same text area +over and over in your documents. They can contain anything, starting +with a comment and ending with a complete menu handling JavaScript +method or perl script. Some examples can be found in the Templates +tree under Global Templates. +Please see <xref linkend="qit-3-2" /> for more information on the +<guilabel>Templates</guilabel> tree. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Site templates</term> +<listitem> +<para> +As the name says these templates are useful to build a whole site +from a template. They are a collection of various documents which +can be organized in a directory structure, everything gathered in +a compressed tar archive. As of writing there are no example site +templates in &quantaplus;. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="template-scope-3-2"> +<title>Template Scopes</title> + +<para> +Templates are accessible based upon their established +<link linkend="quanta-workspaces-3-2">workspace</link> in &quantaplus; +</para> + +</sect2> + +<sect2 id="creating-templates-3-2"> +<title>Creating Templates</title> + +<sect3 id="creating-document-templates"> +<title>Creating document templates</title> +<para> +Create a document structure that you love (&XML;, &HTML;, DocBook, &etc;.) +and click on +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Save as Template</guimenuitem> +<guimenuitem>Save as Local/Project Template</guimenuitem> +</menuchoice>. +</para> + +<para> +Once this is done, you will notice that (even if it is saved as a Project +template) the template does <emphasis>not</emphasis> show in the project +tab view. Look into the templates view to find your template under the +Project templates tab. +</para> +</sect3> +<sect3 id="creating-text-templayes"> +<title>Creating text snippets</title> +<para>Select some text in your document and click on +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Save as Template</guimenuitem> +<guimenuitem>Save Selection to Local/Project Template file</guimenuitem> +</menuchoice>. +Alternatively you can just use drag and drop to drag the selection to the <guilabel>Templates</guilabel> treeview. +</para> +</sect3> +<sect3 id="creating-binary-templates"> +<title>Creating binary templates</title> +<para>Creation of a binary template is simple: just copy the file +into a template folder. You can use standard file management +functions to do it, like drag and drop or copy and paste from +Konqueror or the <guilabel>Files Tree</guilabel>. +</para> +</sect3> +<sect3 id="creating-site-templates"> +<title>Creating site templates</title> +<para> +In the <guilabel>Files Tree</guilabel> or the <guilabel>Project Files</guilabel> +treeviews right click on a folder and select <guilabel>Create Site Template</guilabel>, +pick up a name for the template and save it. By default it will try +to save to the project template folder, but of course you can choose +to save it as a local or global template as well. +</para> +</sect3> +</sect2> + +<sect2 id="using-templates-with-projects-3-2"> +<title>Using Templates With Projects</title> + +<para> +Project templates allow you to be more tightly focused. You can create +headers, footers or go dynamic with &PHP; include files and link them. +Additionally there are some very cool things we took into consideration +when using templates in projects. +</para> + +<para> +When creating a project you can opt to copy to your local project, all the +existing global and user templates. Legacy project get default templating +abilities so nothing is lost You can choose where to locate your template +files so they can be in your server root and easy to upload or you can +make them secure to link to below server root which is a very cool trick. +When linking to a file not in the project templates you will be prompted +to copy the file to the project templates prior to linking. This will prevent +broken links on upload. You always have control where you place your +templates so you can choose to move them. However &quantaplus; does not +track this so you will need to change links. +</para> + +</sect2> + +<sect2 id="managing-templates-3-2"> +<title>Managing Templates</title> + +<para> +Template structure on the template tab is based on the files found in +<filename class="directory"> +$<envar>KDEDIR</envar>/share/apps/quanta/templates</filename> and +<filename class="directory"> +$<envar>HOME</envar>/.kde/share/apps/quanta/templates</filename>. Each of +these folders is specified as one of four types of container as explained <link linkend="template-types-3-2">above</link>. +</para> + +<para> +To set the behavior of each folder, &RMB; click in the template view on +the folder and choose <guimenuitem>Properties</guimenuitem>. The +following dialog will come up: + +<mediaobject> +<imageobject> +<imagedata fileref="template-rmb.png" format="PNG" /> +</imageobject> +<caption><para>Properties dialog.</para></caption> +</mediaobject> +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Type</guilabel></term> + +<listitem> +<para> +Drop down box with the three types discussed previously; files, text, +template. This box will be grayed out if you have the <guilabel>Inherit +parent attribute box</guilabel> checked. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Inherit parent attribute</guilabel> (<sgmltag +class="starttag">foo</sgmltag>)</term> +<listitem> +<para> +This is checked by default and is fine for all but the top level +folders in your templates tree. If the top level folder has this +checked, it will basically deactivate templates for that folder and all +that aren't explicitly set below it. If this is not a top level folder, +then the <sgmltag class="starttag">blah</sgmltag> will say something like +<literal>Text snippet</literal>. If it says nothing, then chances are that +you are on a top level folder. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Use pre/post text</guilabel></term> +<listitem> +<para> +Enables pre and post text for templates in this folder. This could be a +common header/footer for all of your templates for a given project and +then you copy content templates into that folder and have a complete +page with the custom header/footer as a starting point. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Pre-text</guilabel></term> +<listitem> +<para> +The actual text to insert before your templates content. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Post-text</guilabel></term> +<listitem> +<para> +The actual text to insert after your templates content. +</para> +</listitem> +</varlistentry> +</variablelist> +<!--<para> +The properties for a template file looks a bit different: +<mediaobject> +<imageobject> +<imagedata fileref="template-file-rmb.png" format="PNG" /> +</imageobject> +<caption><para>Properties dialog.</para></caption> +</mediaobject> + +</para>--> +<para> +Additionally if you look at your options with the &RMB; you will see +complete file management tools for creating folders or copying and +pasting templates from one location to another. +</para> +</sect2> +</sect1> + +<sect1 id="vpl-3-2"> +<sect1info> +<title><application>Visual Page Layout</application></title> +<authorgroup> +<author> +<firstname>Nicolas</firstname> +<surname>Deschildre</surname> +<affiliation> +<address><email>nicolasdchd@ifrance.com</email></address> +</affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Christopher</firstname> +<surname>Hornbaker</surname> +<affiliation> +<address><email>chrishornbaker@earthlink.net</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> +</sect1info> + +<title><application>Visual Page Layout</application></title> + +<sect2 id="vpl-views-3-2"> +<title>&VPL; Modes</title> + +<para> +The <application>Visual Page Layout</application> (&VPL;) editor (also known +as <acronym>WYSIWYG</acronym> (What You See Is What You Get)) allows you +to edit a &HTML; or &XHTML; document while seeing the changes on-the-fly. +Just like your favorite wordprocessor, you can click on your document and +a cursor will appear, thus enabling you to enter text, insert images, +apply text decorations, &etc;. &VPL;'s aim is to allow you to create great, +valid web pages without any knowledge of Internet markup languages. +</para> + +<para> +&quantaplus; offers two modes: <guilabel>&VPL; Editor</guilabel> and +<guilabel>&VPL; & Source Editors</guilabel>, which are accessible from +the <guimenu>View</guimenu> menu. The first replaces the <guilabel>Source +Editor</guilabel> with the <guilabel>&VPL; Editor</guilabel>, and the +second splits the editor window into two parts: the <guilabel>Source +Editor</guilabel> and the <guilabel>&VPL; Editor</guilabel>. +</para> + +<para> +The <guilabel>&VPL; Editor</guilabel> works like so: It loads a document +like a normal &HTML; or &XHTML; page and a cursor appears. Then you can +edit it, and switching back to <guilabel>Source Editor</guilabel>, you see +that the changes you made on the <guilabel>&VPL; Editor</guilabel> have +been merged in the <guilabel>Source Editor</guilabel>. +</para> + +<note> +<para> +When working in the <guilabel>&VPL; Editor</guilabel> with a document that +contains &PHP;, you will see a small green icon representing the &PHP; +code. You cannot directly edit it with the <guilabel>&VPL; +Editor</guilabel>. To edit &PHP;, you will still need to use the +<guilabel>Source Editor</guilabel>. There are no plans to change this +functionality. +</para> +</note> + +<para> +The second mode behaves exactly like the first, except that you instantly +see the impact that your changes have made, either in the <guilabel>Source +Editor</guilabel> or in the <guilabel>&VPL; Editor</guilabel>, and the +cursors of the source editor and of the <guilabel>&VPL; Editor</guilabel> +are synchronized. Pressing <keycap>F9</keycap> loads this mode, but, if +it is already loaded, it will move the focus from one view to the other, +while keeping you at the same location of the document. +</para> + +<para> +The refresh intervals between the <guilabel>&VPL; Editor</guilabel> and +the <guilabel>Source Editor</guilabel> are configurable. Go to +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Quanta...</guimenuitem> +</menuchoice>. Select the <guimenu>&VPL; View</guimenu> tab. You can +choose whether you want to refresh a view only when you click on it or +automatically. If you choose automatically, then you can choose a refresh +interval. The general recommendation is: A smaller number for fast +computers and a bigger number for slower ones. +</para> + +<mediaobject> +<imageobject> +<imagedata fileref="vplsourceview.png" format="PNG" /> +</imageobject> +<caption><para>The <guilabel>&VPL; & Source Editors</guilabel> mode.</para></caption> +</mediaobject> +</sect2> + +<sect2 id="vpl-editing-3-2"> +<title>&VPL; Editing</title> + +<sect3 id="doc-prop-dia-3-2"> +<title>The <guilabel>Document Properties</guilabel> Dialog</title> + +<para> +Now, let's say you want to edit the title of your web page. How do you do +it? Simply launch +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Document Properties</guimenuitem> +</menuchoice>. This tool allows editing of <quote>invisible</quote> +tags when using the <guilabel>&VPL; Editor</guilabel>. The +<guilabel>Document Properties</guilabel> dialog is also launched when you +create a new document while in the <guilabel>&VPL; Editor</guilabel>. This +is in order to lessen the amount of hand coding you need to perform. With +it, you can edit: +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Title</guilabel></term> +<listitem> +<para> +The title of the document. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Meta items</guilabel></term> +<listitem> +<para> +Meta tags allow you to store information about the document itself +⪚ keywords for the Internet search engines. You can add or remove +<guilabel>Meta items</guilabel> by pressing the two buttons below, +and edit them by clicking on the list ⪚ put <quote>keywords</quote> on +the <quote>name</quote> column and <quote>keyword1 keyword2</quote> on the +<quote>content</quote> column. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>CSS Rules</guilabel></term> +<listitem> +<para> +<guilabel>CSS Rules</guilabel> are the new way to tell your web browser +how to present the page. You can add or delete the <guilabel>CSS +Rules</guilabel> by pressing the buttons below. You can also fill the +fields like the <guilabel>Meta items</guilabel>. The editing of +<guilabel>CSS Rules</guilabel> is not yet supported. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Link CSS Stylesheet</guilabel></term> +<listitem> +<para> +You can also link an external CSS stylesheet. Simply click on the +<guilabel>Browse</guilabel> button and select your file. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="vpl-editor-3-2"> +<title>The <guilabel>&VPL; Editor</guilabel></title> + +<para> +You can use your cursor like you do in a wordprocessor, moving with the +arrows. There may come a time when the cursor does not want to go where you +want it to go (a pesky bug). Selection also works as usual. You can insert +text by typing and remove text by pressing the &Backspace; or Delete key. +</para> + +<para> +Now we come to tag insertion. You can insert images, applets, text +decorations such as bold and so on by using the same toolbars you use in +the source editor. Note that the insertion of tags does not remove previous +identical tags ⪚ if you insert an anchor tag around some text, then you +must remove any other anchor tag around it. +</para> + +<note> +<para> +Some toolbar items will be disabled, such as the <guilabel>Table +Wizard</guilabel> or <guilabel>Quick List Wizard</guilabel>. They will +work later in &VPL;, but, for this release, you should use the +<guilabel>Tables</guilabel> or <guilabel>Lists</guilabel> toolbars. +</para> +</note> + +<para> +To edit a tag (be it an image, an applet, or whatever), switch to the +<guilabel>Attribute Tree</guilabel>, accessible via +<menuchoice> +<guimenu>View</guimenu> +<guisubmenu>Tool views</guisubmenu> +</menuchoice>. Click on the tag you wish to edit, or, if you cannot access +it, click on an object contained by it. The <guilabel>Attribute +Tree</guilabel> will show the current tag name as well as a list of all its +parents and attributes. Currently &VPL; does not support, say, +&XHTML;+<acronym>MathML</acronym>, but you will see that you can edit +namespaces via this view. You can simply click on the +<guilabel>Value</guilabel> field and modify whatever you want. If you want +to access a parent of the current tag, then select it and the +<guilabel>Attribute Tree</guilabel> will load it. +</para> + +<para> +To delete a tag, we will use the <guilabel>Attribute Tree</guilabel>. Have +you noticed the two little red crosses at the top-right corner? The first one +deletes only the currently selected tag and, if the &HTML;/&XHTML; +specification does not allow some children of the deleted tag to be children of +the parent tag of the tag set to be deleted, then they are also deleted, +and so on. The second cross will delete the selected tag as well as all of +its children, so be careful! +</para> + +</sect3> +</sect2> +</sect1> +</chapter> |
