From 367cac7e872b7cbd006a26ee66ae30a9d188beec Mon Sep 17 00:00:00 2001 From: Darrell Anderson Date: Sat, 26 Mar 2016 15:29:58 +0100 Subject: Update help handbook and screenshots Replace missing icons in Settings configuration Update *.desktop files KDE => TDE changes --- doc/en/index.docbook | 560 ++++++++++++++++----------------------------- doc/en/setuparchive.png | Bin 0 -> 30215 bytes doc/en/setupdefaults.png | Bin 37047 -> 0 bytes doc/en/setupnewfiles.png | Bin 0 -> 38438 bytes doc/en/setupprinting.png | Bin 0 -> 31914 bytes doc/en/setupprintout.png | Bin 32288 -> 0 bytes doc/en/setuptargz.png | Bin 31677 -> 0 bytes doc/en/setuptexteditor.png | Bin 41341 -> 0 bytes doc/en/setuptextview.png | Bin 0 -> 41266 bytes doc/en/setuptreeview.png | Bin 35871 -> 41220 bytes 10 files changed, 203 insertions(+), 357 deletions(-) create mode 100644 doc/en/setuparchive.png delete mode 100644 doc/en/setupdefaults.png create mode 100644 doc/en/setupnewfiles.png create mode 100644 doc/en/setupprinting.png delete mode 100644 doc/en/setupprintout.png delete mode 100644 doc/en/setuptargz.png delete mode 100644 doc/en/setuptexteditor.png create mode 100644 doc/en/setuptextview.png (limited to 'doc') diff --git a/doc/en/index.docbook b/doc/en/index.docbook index a61b5ec..5e159db 100644 --- a/doc/en/index.docbook +++ b/doc/en/index.docbook @@ -1,97 +1,60 @@ -KXML Editor" > - + ]> - - - - - - The KXML Editor Handbook + Lumir Vanek - -
lvanek@users.sourceforge.net
- - +&tde-authors; + 2004 Lumir Vanek - - -&FDLNotice; - - + +&tde-copyright-date; +&tde-team; + -07/08/2004 -1.11 +&FDLNotice; - +&tde-release-date; +&tde-release-version; KXML Editor is an application for browsing and editing XML files. - -This document describes KXML Editor version 1.0. - - - - -KDE +TDE KXML Editor +XML Editor - - - - - - - - Some Fundamentals -Extensible Markup Language (XML) is wide standart for exchanging and +Extensible Markup Language (XML) is wide standard for exchanging and transferring data in application development. XML stores character data in a structured way, using tags placed within the data representing its structure. An XML document has a tree structure, where "XML element" tags comprise the nodes. @@ -118,39 +81,26 @@ You may obtain more informations - - - - - - Introduction - - KXML Editor is a program that lets you browse and edit XML files. Main window is divided to two windows. -Left side contain tree widget with XML structure. XML document has tree structute, one (and only one) -element is root. Every element may own one or more childs elements or contents items. +Left side contain tree widget with XML structure. XML document has tree structure, one (and only one) +element is root. Every element may own one or more child elements or contents items. -Right side contain detail for selected item. If XML element is selectected in left side, -attributes list and raw XML are displayied. If XML contents is selectected in left side, edit widget with full -context is displayied. +Right side contain detail for selected item. If XML element is selected in left side, +attributes list and raw XML are displayed. If XML contents is selected in left side, edit +widget with full context is displayed. - Here's a screenshot of &kxmleditor; @@ -164,7 +114,7 @@ patent issues. --> -KXML Editor contain two toolbars with buttons - one with standart commands and second with +KXML Editor contain two toolbars with buttons - one with standard commands and second with commands for edit XML document. Third toolbar contain Konqueror-like path bar, that display path of selected XML item. @@ -178,12 +128,6 @@ The black icon at the left hand end of the Pathbar clears the text entry box. - - - - - - Edit XML document @@ -217,7 +161,8 @@ hotkey. Then select item, where you can copy XML element. -Finally, use Paste button or the Menubar Edit +Finally, use Paste button or the Menubar +Edit Paste option or the CtrlV hotkey. @@ -227,9 +172,7 @@ action="simul">CtrlV hotkey. Moving a XML element or contents item can be done in the same way as copying, except that you choose the Cut option or CtrlX -instead of Copy. +instead of Copy. You can also exchange XML between &kxmleditor; and text editor using clipboard. Of course, @@ -309,26 +252,11 @@ main window. - - - - - - - - - - The Menu Entries - - + The <guimenu>File</guimenu> Menu @@ -364,15 +292,15 @@ special processing instruction, you may choose XML version and encoding. -This command opens a file. It does this by means of a dialog box -which allows the user to navigate the file system. The dialog operates +This command opens a file. It does this by means of a dialog box +which allows the user to navigate the file system. The dialog operates like a small file manager. Clicking on directories displayed in the central window directs the dialog to enter that directory - displaying its -contents. There is an entry/dropdown box which can be used to type in +contents. There is an entry/dropdown box which can be used to type in directly the location and name of the file or by clicking the arrow at the side choose from a dropdown list of recently used locations. Below this is a filter which similarly may have data entered directly or chosen from a -dropdown list of recent filter types. The filter facility lets only files +dropdown list of recent filter types. The filter facility lets only files that meet its specifications be displayed in the central window. If the filter contained text such as *.xml then only files with the txt extension would be visible in the selection window. Below the filter @@ -388,7 +316,7 @@ with the two arrows curved in on each other updates the view of the current directory. The flag button lets the user set a new bookmark at the current directory or go to one that was previously set. - The last button on the toolbar allows you to create a new + The last button on the toolbar allows you to create a new directory, and finally there is dropdown box with a list of some commonly frequented directories. @@ -416,9 +344,9 @@ still resides at the same location. Save -This saves the current document. If there has already been a save of the document then this will overwrite the previously -saved file without asking for the user's consent. If it is the first save of a new document the save as dialog -(described below) will be invoked. +This saves the current document. If there has already been a save of the document then this +will overwrite the previously saved file without asking for the user's consent. If it is the +first save of a new document the save as dialog (described below) will be invoked. @@ -480,7 +408,7 @@ This allow to remove DTD schema file. Attach Stylesheet -This allow to insert processing instruction for ataching schema (obviously .xsl or .xslt) file. +This allow to insert processing instruction for attaching schema (obviously .xsl or .xslt) file. @@ -490,7 +418,7 @@ This allow to insert processing instruction for ataching schema (obviously .xsl Detach Stylesheet -This allow to remove processing instruction for ataching schema. +This allow to remove processing instruction for attaching schema. @@ -517,8 +445,7 @@ This allow print document. - - + The <guimenu>Edit</guimenu> Menu @@ -552,12 +479,16 @@ This allow print document. -This will call a display box showing a list of the most recent actions on the left and another list of actions which have been 'undone' on the right. -There are also three buttons at the right of the box labeled Undo, Redo, and Close. -Clicking on the Undo button will cause the action at the top of the Undo list to be reversed which will place that particular action at the top of the Redo list. -Likewise, clicking on the Redo button will reinstate the reversed action and move it back to the top of the Undo list. Clicking on an item below the top item in either -list will select all the items from the top down to that point. A subsequent click on the corresponding button will cause all the selected actions to be undone or redone accordingly. -This would be particularly useful when the user knows precisely the point to which she or he would like to proceed - making it unnecessary to go through a series of single undo or redo actions. +This will call a display box showing a list of the most recent actions on the left and another +list of actions which have been 'undone' on the right. There are also three buttons at the +right of the box labeled Undo, Redo, and Close. Clicking on the Undo button will cause the action +at the top of the Undo list to be reversed which will place that particular action at the top of +the Redo list. Likewise, clicking on the Redo button will reinstate the reversed action and move +it back to the top of the Undo list. Clicking on an item below the top item in either list will +select all the items from the top down to that point. A subsequent click on the corresponding +button will cause all the selected actions to be undone or redone accordingly. This would be +particularly useful when the user knows precisely the point to which she or he would like to +proceed, making it unnecessary to go through a series of single undo or redo actions. @@ -569,8 +500,8 @@ This would be particularly useful when the user knows precisely the point to whi Cut -This command deletes the current selection and places it on the clipboard. The -clipboard is a feature of KDE that works invisibly to provide a way to transfer data between +This command deletes the current selection and places it on the clipboard. The +clipboard is a feature of &tde; that works invisibly to provide a way to transfer data between applications. @@ -582,7 +513,7 @@ applications. Copy This copies the currently selected text to the clipboard so that it may be -pasted elsewhere. The clipboard is a feature of KDE that works invisibly to +pasted elsewhere. The clipboard is a feature of &tde; that works invisibly to provide a way to transfer data between applications. @@ -595,7 +526,7 @@ provide a way to transfer data between applications. This will insert the contents of the clipboard at the cursor position. The -clipboard is feature of KDE that works invisibly to provide a way to transfer +clipboard is feature of &tde; that works invisibly to provide a way to transfer data between applications. @@ -660,18 +591,10 @@ data between applications. This opens the find dialog which is used to specify the Text to Find in the document. There is small text box for entering the search -pattern. Other -parameters are included to make the search more efficient. Selecting +pattern. Other parameters are included to make the search more efficient. Selecting Case Sensitive will limit finds to entries that match the case (upper or lower) of each of the characters in the search -pattern. +pattern. @@ -714,7 +637,7 @@ Display dialog which allows the user to edit selected element as raw XML. Special processing instruction dialog - + @@ -726,12 +649,10 @@ You may press Validate button for checking, if XML is well formed. - - - + The <guimenu>View</guimenu> Menu @@ -739,7 +660,7 @@ You may press Validate button for checking, if XML is well formed. AltUp Arrow View -To P arent node +To Parent node Go up a level in the tree hierarchy. Select parent node. @@ -755,8 +676,8 @@ You may press Validate button for checking, if XML is well formed. Expand selected XML element and show entire child subtree. -Tip: You may expand node to choosed level. Press button for this function on toolbar, -hold mouse pressed for small anmount of time. Program show menu, which allows the user to +Tip: You may expand node to chosen level. Press button for this function on toolbar, +hold mouse pressed for small amount of time. Program show menu, which allows the user to expand node to selected level. @@ -773,8 +694,8 @@ expand node to selected level. Collapse selected XML element and hide entire child subtree. -Tip: You may collapse node from choosed level. Press button for this function on toolbar, -hold mouse pressed for small anmount of time. Program show menu, which allows the user to +Tip: You may collapse node from chosen level. Press button for this function on toolbar, +hold mouse pressed for small amount of time. Program show menu, which allows the user to collapse node from selected level. @@ -783,8 +704,7 @@ collapse node from selected level. - - + The <guimenu>Insert</guimenu> Menu @@ -799,7 +719,7 @@ collapse node from selected level. Insert new XML element into tree. Display dialog which allows the user to enter element name. If you have void document, new element becomes root. If you have selected any existing element, new element becomes child of this element. You may decide, if new element will be placed to -begin or end of childs items list. +begin or end of child items list. @@ -828,8 +748,8 @@ attribute list. Insert new XML text item into tree. Display dialog which allows the user to enter contents text. -New item becomes child of celected XML element. You may decide, if new item will be -placed to begin or end of childs items list. +New item becomes child of selected XML element. You may decide, if new item will be +placed to begin or end of child items list. @@ -843,8 +763,8 @@ placed to begin or end of childs items list. Insert new XML CDATA item into tree. Display dialog which allows the user to enter contents text. -New item becomes child of celected XML element. You may decide, if new item will be -placed to begin or end of childs items list. +New item becomes child of selected XML element. You may decide, if new item will be +placed to begin or end of child's items list. @@ -858,8 +778,8 @@ placed to begin or end of childs items list. Insert new XML comment item into tree. Display dialog which allows the user to enter contents text. -New item becomes child of celected XML element. You may decide, if new item will be -placed to begin or end of childs items list. +New item becomes child of selected XML element. You may decide, if new item will be +placed to begin or end of child's items list. @@ -882,9 +802,7 @@ the user to enter target and data. - - - + The <guimenu>Bookmarks</guimenu> Menu @@ -932,8 +850,45 @@ that are closed is skipped. - - + +The <guimenu>Window</guimenu> Menu + + + + +Close + + + +Close the current document. + + + + + +Close all + + + +Close all documents. + + + + + +Close all others + + + +Close all documents except the current document. + + + + + + + + The <guimenu>Settings</guimenu> Menu @@ -956,32 +911,33 @@ initiate frequently used commands. When unchecked the toolbar is hidden. When checked, this displays a small bar at the bottom of the main window -containing information about the status of the current document. When unchecked +containing information about the status of the current document. When unchecked the statusbar is hidden. -SettingsConfigure Shortcuts +SettingsConfigure +Shortcuts This command opens a dialog box whereby the key bindings may be changed. A display window at the top of the dialog box shows the list of commands (actions) that can have -keyboard shortcuts. Below the display are three radio buttons. The user may choose -between No Key, Default Key, and Custom Key. (Note that a set of radio buttons only +keyboard shortcuts. Below the display are three radio buttons. The user may choose +between No Key, Default Key, and Custom Key. (Note that a set of radio buttons only allows the selection of one of the offered items - in the way that buttons on a car -radio only offer the selection of one preset station. Also, the Default Key +radio only offer the selection of one preset station. Also, the Default Key selection is only available for those commands that actually have a 'default' shortcut.) Selecting the Custom Key option activates the three check boxes and key button at the bottom of the dialog. The user may then select a key combination for the command in question by means of the check boxes and key -button. For example, with the About KDE command selected in the display window, +button. For example, with the About &tde; command selected in the display window, the user could select Ctrl and Alt, click on -the key button, and then press the K key on the keyboard. This +the key button, and then press the K key on the keyboard. This would mean that anytime he or she held down the Ctrl and Alt buttons and pressed K (while using -&kxmleditor;) the About KDE display box would be called. +&kxmleditor;) the About &tde; display box would be called. @@ -991,14 +947,14 @@ would mean that anytime he or she held down the Ctrl and Configure Toolbars This will open the dialog whereby the toolbars configuration may -be changed. The user can choose which shortcut buttons should appear on the +be changed. The user can choose which shortcut buttons should appear on the toolbar. A display window on the left lists the commands available to placed -on the toolbar. A display on the right lists those commands already on the -toolbar. A set of four arrow buttons between the two displays manipulates the -selections. The right pointing arrow places any command selected in the left +on the toolbar. A display on the right lists those commands already on the +toolbar. A set of four arrow buttons between the two displays manipulates the +selections. The right pointing arrow places any command selected in the left pane onto the right pane, i.e., it is added to the toolbar. The left arrow does just the opposite, removing any action selected in the right -window from the toolbar. The up and down pointing arrows change the position of +window from the toolbar. The up and down pointing arrows change the position of an action selected in the right window which changes the position of its button in the toolbar. @@ -1017,8 +973,7 @@ linkend="pref-dialog">settings may be adjusted. - - + The <guimenuitem>Help</guimenuitem> Menu @@ -1029,7 +984,7 @@ linkend="pref-dialog">settings may be adjusted. Contents -This invokes the KDE help system starting at the &kxmleditor; help pages (this document). +This invokes the &tde; help system starting at the &kxmleditor; help pages (this document). @@ -1057,8 +1012,8 @@ one exists for the particular item) explaining the item's function. This calls a dialog box to help -the user help the KDE team to track down and solve any -problems(bugs) in the program. The dialog attempts to do this by +the user help the &tde; team to track down and solve any +problems(bugs) in the program. The dialog attempts to do this by means of email using the information given by the user. @@ -1078,7 +1033,7 @@ means of email using the information given by the user. HelpAbout KDE -This displays the KDE version and other basic information. +This displays the &tde; version and other basic information. @@ -1088,35 +1043,27 @@ means of email using the information given by the user. - - - - - - Configure &kxmleditor; Selecting SettingsConfigure KXML Editor from the menu brings up the Configure-KXML Editor -dialog box. This dialog can be used to alter application settings. By means of four buttons -along the bottom of the box the user can control the process. She or he may invoke -the Help system, accept the current settings pressing Apply button, -accept the current settings and close the dialog by means of the OK button, or -Cancel the process. +dialog box. This dialog can be used to alter application settings. By means of four buttons +along the bottom of the box the user can control the process. She or he may invoke +the Help system, accept the current settings pressing Apply +button, accept the current settings and close the dialog by means of the OK +button, or Cancel the process. - Tree View + This category deals with following properties detailed below. -TarGz Extensions +Tree View @@ -1149,7 +1096,7 @@ Set the default expand level for tree view. Enables or disables drag & drop. Disabling it may be useful, when X-Window client -and server is not on the same machine and respond time is slow, that may cause unnecesary +and server is not on the same machine and respond time is slow, that may cause unnecessary drag & drop operation caused while selecting in tree view. @@ -1167,20 +1114,67 @@ or Element, attributes names and its value. - + +Text View + +This category allows setting the text editor syntax highlighting. + + + +Text View + + + + + + + + + + + + +Syntax highlighting + + +You may choose various colors for different XML syntax. + + -Defaults + +Element indentation + + +Choose element indentation for raw XML editing. This indentation is used also for saving document. + + + + +Wrap, instead of Horizontal. Scroll bar + + +Disable horizontal scrollbar and set word wrap ON for raw XML view and editing. + + + + + + + + + +New Files This category allow set default XML version, encoding and program behavior while creating new document -Defaults - - - - - +New Files + + + + + @@ -1211,22 +1205,21 @@ Behavior when creating new XML documents. - - + +Printing -Printout This category allow set parameters for printing XML document -Printout +Printing - + @@ -1252,10 +1245,10 @@ Choose font size for printing document. -Element intendation +Element indentation -Choose element intendation for printing document. +Choose element indentation for printing document. @@ -1279,20 +1272,19 @@ Choose if you can print footer when printing document. + +Archive Extensions - - -TarGz Extensions This category allow set list of XML files, that is TarGz archives. This allow open and save those files transparently. This may be useful for browsing KOffice files. -TarGz Extensions +Archive Extensions - + @@ -1305,55 +1297,8 @@ for browsing KOffice files. Archive files extensions -You may edit list of files extension using New and Delete buttons. -Actually selected item may be changed using edit line. - - - - - - - - - -Text Editor -This category allow set text edior syntax highlighting - - - -Text Editor - - - - - - - - - - - - -Syntax highlighting - - -You may choose various colors for different XML syntax. - - - - -Element intendation - - -Choose element intendation for raw XML editing. This intendation is used also for saving document. - - - - -Wrap, instead of Hrz. Scroll bar - - -Disable horizontal srcrollbar and set word wrap ON for raw XML view and editing. +You may edit list of files extension using New and Delete +buttons. Actually selected item may be changed using edit line. @@ -1363,23 +1308,8 @@ Disable horizontal srcrollbar and set word wrap ON for raw XML view and editing. - - - - - - - - - Credits and License @@ -1409,94 +1339,10 @@ distribution. --> Documentation copyright 2003 Lumir Vanek lvanek@users.sourceforge.net - +&underFDL; -&underFDL; - - - -&underGPL; +&underGPL; - - - - - - - -Installation - - -How to obtain KXML Editor - - -You may obtain &kxmleditor; from URL: -http://sourceforge.net/projects/kxmleditor. - - - - -Requirements - - - - -In order to successfully use &kxmleditor;, you need KDE 3.1.x or higher. -For instructions on acquiring &kde; please see http://www.kde.org. - - - - - -Compilation and installation - - -In order to compile and install &kxmleditor; on your system, type the following in the base -directory: - -% ./configure -% make -% make install - - - -Since &kxmleditor; uses autoconf and automake you should have not trouble compiling it. -Should you run into problems please report them to author. - - - - - -&documentation.index; - diff --git a/doc/en/setuparchive.png b/doc/en/setuparchive.png new file mode 100644 index 0000000..afccfe5 Binary files /dev/null and b/doc/en/setuparchive.png differ diff --git a/doc/en/setupdefaults.png b/doc/en/setupdefaults.png deleted file mode 100644 index 59e1917..0000000 Binary files a/doc/en/setupdefaults.png and /dev/null differ diff --git a/doc/en/setupnewfiles.png b/doc/en/setupnewfiles.png new file mode 100644 index 0000000..ea10d1f Binary files /dev/null and b/doc/en/setupnewfiles.png differ diff --git a/doc/en/setupprinting.png b/doc/en/setupprinting.png new file mode 100644 index 0000000..deb04ed Binary files /dev/null and b/doc/en/setupprinting.png differ diff --git a/doc/en/setupprintout.png b/doc/en/setupprintout.png deleted file mode 100644 index 0d4b083..0000000 Binary files a/doc/en/setupprintout.png and /dev/null differ diff --git a/doc/en/setuptargz.png b/doc/en/setuptargz.png deleted file mode 100644 index 623c817..0000000 Binary files a/doc/en/setuptargz.png and /dev/null differ diff --git a/doc/en/setuptexteditor.png b/doc/en/setuptexteditor.png deleted file mode 100644 index 8e26888..0000000 Binary files a/doc/en/setuptexteditor.png and /dev/null differ diff --git a/doc/en/setuptextview.png b/doc/en/setuptextview.png new file mode 100644 index 0000000..bd29ea8 Binary files /dev/null and b/doc/en/setuptextview.png differ diff --git a/doc/en/setuptreeview.png b/doc/en/setuptreeview.png index ce50d83..7756fb1 100644 Binary files a/doc/en/setuptreeview.png and b/doc/en/setuptreeview.png differ -- cgit v1.2.1