Bugs item #1902887, was opened at 2008-02-27 02:15
Message generated for change (Comment added) made by nobody
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=111005&aid=1902887&group_id=11005
Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Nobody/Anonymous (nobody)
Assigned to: Nobody/Anonymous (nobody)
Summary: documentation bugs
Initial Comment:
The attached patch corrects some bugs of the NEdit documentation.
a) The description of the dialog() subroutine is changed
from dialog( message, btn_1_label, btn_2_label, ... )
... Additional optional arguments represent labels for buttons to appear along
the bottom of the dialog. Returns the number ...
to dialog( message [, btn_1_label, btn_2_label, ... ] )
... Additional optional arguments represent labels for buttons to appear along
the bottom of the dialog. When optional arguments are omitted, the default
"OK" button is used. Returns the number ...
The same is done for the list_dialog() and the string_dialog().
b) Missing descriptions are added for:
last_document()
next_document()
previous_document()
bg_menu_command()
load_tips_file()
unload_tips_file()
nedit*calltip.fontList
nedit.boldItalicHelpFont
nedit.boldItalicFixedHelpFont
c) Broken hyperlink to Rangesets is corrected, see Table of Contents in
nedit.html.
d) Broken formatting of descriptions of the menu actions is corrected.
The following problem is not covered by the patch.
The are four inconsistent descriptions:
process_down( ["nobell", "absolute"] ) ..............
process_shift_down( ["nobell", "absolute"] )
Same as process_down("extend") for compatibility with previous versions.
process_shift_up( ["nobell", "absolute"] )
Same as process_up("extend") for compatibility with previous versions.
process_up( ["nobell", "absolute"] ) ................
The process_down/up functions have no (?) "extend" option (see text.c).
Alexey Kuznetsov
----------------------------------------------------------------------
Comment By: Nobody/Anonymous (nobody)
Date: 2008-02-27 02:28
Message:
Logged In: NO
--- help.etx 2008-02-20 01:31:51.000000000 +0300
+++ ../../help.etx 2008-02-27 12:57:36.000000000 +0300
@@ -34,7 +34,7 @@
Cut_and_Paste_ Macro_Language_
Using_the_Mouse_ Macro_Subroutines_
Keyboard_Shortcuts_ Highlighting_Information_
- Shifting_and_Filling_ Range_Sets_
+ Shifting_and_Filling_ Rangesets_
Tabbed_Editing_ Action_Routines_
File_Format_
Customizing
@@ -804,8 +804,8 @@
You can switch to a tab by simply clicking on it, or you can use the
keyboard.
The default keybindings to switch tabs (which are Ctrl+PageUp/-Down and
Alt+Home,
- see "Keyboard_Shortcuts_") can be changed using the actions
previous_document(),
- next_document() and last_document().
+ see "Keyboard_Shortcuts_") can be changed using the actions
**previous_document()**,
+ **next_document()** and **last_document()**.
----------------------------------------------------------------------
@@ -2546,13 +2546,13 @@
Returns the contents of the clipboard as a macro string. Returns empty
string on error.
-**dialog( message, btn_1_label, btn_2_label, ... )**
+**dialog( message [, btn_1_label, btn_2_label, ... ] )**
Pop up a dialog for querying and presenting information to the user.
First
- argument is a string to show in the message area of the dialog.
- Additional optional arguments represent labels for buttons to appear
along
- the bottom of the dialog. Returns the number of the button pressed
(the
- first button is number 1), or 0 if the user closed the dialog via the
window
- close box.
+ argument is a string to show in the message area of the dialog.
Additional
+ optional arguments represent labels for buttons to appear along the
bottom of
+ the dialog. When optional arguments are omitted, the default "OK"
button is
+ used. Returns the number of the button pressed (the first button is
number 1),
+ or 0 if the user closed the dialog via the window close box.
**filename_dialog( [title[, mode[, defaultPath[, filter[,
defaultName]]]]] )**
Presents a file selection dialog with the given title to the user that
@@ -2604,18 +2604,18 @@
**length( string )**
Returns the length of a string
-**list_dialog( message, text, btn_1_label, btn_2_label, ... )**
+**list_dialog( message, text [, btn_1_label, btn_2_label, ... ] )**
Pop up a dialog for prompting the user to choose a line from the given
text
string. The first argument is a message string to be used as a title
for the
- fixed text describing the list. The second string provides the list
data:
- this is a text string in which list entries are separated by newline
- characters. Additional optional arguments represent labels for
- buttons to appear along the bottom of the dialog. Returns the line of
text
- selected by the user as the function value (without any newline
separator) or
- the empty string if none was selected, and number of the button pressed
(the
- first button is number 1), in $list_dialog_button. If the user closes
the
- dialog via the window close box, the function returns the empty string,
and
- $list_dialog_button returns 0.
+ fixed text describing the list. The second string provides the list
data: this
+ is a text string in which list entries are separated by newline
characters.
+ Additional optional arguments represent labels for buttons to appear
along the
+ bottom of the dialog. When optional arguments are omitted, the default
"OK"
+ button is used. Returns the line of text selected by the user as the
function
+ value (without any newline separator) or the empty string if none was
+ selected, and number of the button pressed (the first button is number
1), in
+ $list_dialog_button. If the user closes the dialog via the window close
box,
+ the function returns the empty string, and $list_dialog_button returns
0.
**max( n1, n2, ... )**
Returns the maximum value of all of its arguments
@@ -2703,15 +2703,15 @@
argument can specify how the separation_string is interpreted. The
default
is "literal". The returned value is an array with keys beginning at 0.
-**string_dialog( message, btn_1_label, btn_2_label, ... )**
+**string_dialog( message [, btn_1_label, btn_2_label, ... ] )**
Pops up a dialog prompting the user to enter information. The first
argument
- is a string to show in the message area of the dialog. Additional
- optional arguments represent labels for buttons to appear along the
bottom of
- the dialog. Returns the string entered by the user as the function
value,
- and number of the button pressed (the first button is number 1), in
- $string_dialog_button. If the user closes the dialog via the window
close
- box, the function returns the empty string, and $string_dialog_button
returns
- 0.
+ is a string to show in the message area of the dialog. Additional
optional
+ arguments represent labels for buttons to appear along the bottom of
the
+ dialog. When optional arguments are omitted, the default "OK" button is
used.
+ Returns the string entered by the user as the function value, and
number of
+ the button pressed (the first button is number 1), in
$string_dialog_button.
+ If the user closes the dialog via the window close box, the function
returns
+ the empty string, and $string_dialog_button returns 0.
**string_compare(string1, string2 [, consider-case])**
Compare two strings and return 0 if they are equal, -1 if string1 is
less
@@ -3113,63 +3113,69 @@
Arguments are text strings enclosed in quotes. Below are the menu
action
routines which take arguments. Optional arguments are enclosed in [].
- **new**( ["tab" | "window" | "prefs" | "opposite"] )
+ **bg_menu_command( ~bg-menu-item-name~ )**
+
+ **close( ["prompt" | "save" | "nosave"] )**
+
+ **execute_command( shell-command )**
+
+ **filter_selection( shell-command )**
- **close**( ["prompt" | "save" | "nosave"] )
+ **find( search-string [, ~search-direction~] [, ~search-type~]**
+ **[, ~search-wrap~] )**
- **execute_command**( shell-command )
+ **find_again( [~search-direction~] [, ~search-wrap~] )**
- **filter_selection**( shell-command )
+ **find_definition( [tag-name] )**
- **find**( search-string [, ~search-direction~] [, ~search-type~]
- [, ~search-wrap~] )
+ **find_dialog( [~search-direction~] [, ~search-type~]**
+ **[, ~keep-dialog~] )**
- **find_again**( [~search-direction~] [, ~search-wrap~] )
+ **find_selection( [~search-direction~] [, ~search-wrap~]**
+ **[, ~non-regex-search-type~] )**
- **find_definition**( [tag-name] )
+ **goto_line_number( [~line-number~] [, ~column-number~] )**
- **find_dialog**( [~search-direction~] [, ~search-type~]
- [, ~keep-dialog~] )
+ **goto_mark( ~mark-letter~ )**
- **find_selection**( [~search-direction~] [, ~search-wrap~]
- [, ~non-regex-search-type~] )
+ **include_file( ~filename~ )**
- **goto_line_number**( [~line-number~] [, ~column-number~] )
+ **load_tags_file( ~filename~ )**
- **goto_mark**( ~mark-letter~ )
+ **load_tips_file( ~filename~ )**
- **include_file**( ~filename~ )
+ **macro_menu_command( ~macro-menu-item-name~ )**
- **load_tags_file**( ~filename~ )
+ **mark( ~mark-letter~ )**
- **macro_menu_command**( ~macro-menu-item-name~ )
+ **new( ["tab" | "window" | "prefs" | "opposite"] )**
- **mark**( ~mark-letter~ )
+ **open( ~filename~ )**
- **open**( ~filename~ )
+ **replace( search-string, replace-string, [, ~search-direction~]**
+ **[, ~search-type~] [, ~search-wrap~] )**
- **replace**( search-string, replace-string,
- [, ~search-direction~] [, ~search-type~] [, ~search-wrap~] )
+ **replace_again( [~search-direction~] [, ~search-wrap~] )**
- **replace_again**( [~search-direction~] [, ~search-wrap~] )
+ **replace_all( search-string, replace-string [, ~search-type~] )**
- **replace_all**( search-string, replace-string [, ~search-type~] )
+ **replace_dialog( [~search-direction~] [, ~search-type~]**
+ **[, ~keep-dialog~] )**
- **replace_dialog**( [~search-direction~] [, ~search-type~]
- [, ~keep-dialog~] )
+ **replace_in_selection( search-string, replace-string**
+ **[, ~search-type~] )**
- **replace_in_selection**( search-string,
- replace-string [, ~search-type~] )
+ **save_as( ~filename~ )**
- **save_as**( ~filename~ )
+ **shell_menu_command( ~shell-menu-item-name~ )**
- **shell_menu_command**( ~shell-menu-item-name~ )
+ **unload_tags_file( ~filename~ )**
- **unload_tags_file**( ~filename~ )
+ **unload_tips_file( ~filename~ )**
**----------- Some notes on argument types above -----------**
- ~Arguments to new()~
+ **~Arguments to new()~**
"tab": Open a new tab
"window": Open a new window
"prefs": Follow the user's tab/window
@@ -3178,33 +3184,38 @@
preference
Default behaviour is "prefs".
- ~filename~ Path names are relative to the directory from
+ **~bg-menu-item-name~**
+ Name of the command exactly as specified in
+ the Window Background Menu dialogs.
+
+ **~filename~** Path names are relative to the directory from
which NEdit was started. Shell interpreted
wildcards and `~' are not expanded.
- ~keep-dialog~ Either "keep" or "nokeep".
+ **~keep-dialog~** Either "keep" or "nokeep".
- ~mark-letter~ The mark command limits users to single letters.
Inside
- of macros, single digits are allowed as marks. These
- won't interfere with marks set by the user.
+ **~mark-letter~** The mark command limits users to single
+ letters. Inside of macros, single digits are
+ allowed as marks. These won't interfere with
+ marks set by the user.
- ~macro-menu-item-name~
+ **~macro-menu-item-name~**
Name of the command exactly as specified in
the Macro Menu dialogs.
- ~non-regex-search-type~
+ **~non-regex-search-type~**
Either "literal", "case", "word", or
"caseWord".
- ~search-direction~
+ **~search-direction~**
Either "forward" or "backward".
- ~search-type~ Either "literal", "case", "word",
+ **~search-type~** Either "literal", "case", "word",
"caseWord", "regex", or "regexNoCase".
- ~search-wrap~ Either "wrap" or "nowrap".
+ **~search-wrap~** Either "wrap" or "nowrap".
- ~shell-menu-item-name~
+ **~shell-menu-item-name~**
Name of the command exactly as specified in
the Shell Menu dialogs.
@@ -3417,7 +3428,7 @@
drag-selection operation can be started with either extend_start or
grab_focus.
-**focus_pane( [relative-pane] | [positive-index] | [negative-index] )**
+**focus_pane( [relative-pane | positive-index | negative-index] )**
Move the focus to the requested pane.
Arguments can be specified in the form of a relative-pane
("first", "last", "next", "previous"), a positive-index
@@ -3456,6 +3467,9 @@
forward/backward-character("extend"), or process-up/down("extend"),
for
compatibility with previous versions.
+**last_document()**
+ Switch to a tab with the last edited document.
+
**move-destination()**
Moves the cursor to the pointer location without
disturbing the selection. (This is an unusual way of working. We left
it in
@@ -3492,6 +3506,11 @@
Inserts a newline character, without automatic
indentation, regardless of the setting of Auto Indent.
+**next_document()**
+ Switch to next tab in a window. When the ~"Next/Prev Tabs Across
Windows"~
+ parameter is disabled (default), all cycled tabs are located in the
same
+ window.
+
**next_page( ["stutter"] ["column"] ["scrollbar"] ["nobell"] )**
Moves the cursor and scroll forward one page.
The parameter "stutter" moves the cursor to the bottom of the display,
@@ -3510,6 +3529,11 @@
pending delete is on, replace the primary selection with the contents
of the
clipboard.
+**previous_document()**
+ Switch to previous tab in a window. When the ~"Next/Prev Tabs Across
Windows"~
+ parameter is disabled (default), all cycled tabs are located in the
same
+ window.
+
**previous_page( ["stutter"] ["column"] ["scrollbar"] ["nobell"] )**
Moves the cursor and scroll backward one page.
The parameter "stutter" moves the cursor to the top of the display,
@@ -3545,7 +3569,7 @@
Moves the cursor up one line. If "absolute" is given, always moves to
the
previous line in the text buffer, regardless of wrapping.
-**raise_window([relative-window] | [positive-index] | [negative-index] [,
"focus" | "nofocus"])**
+**raise_window([relative-window | positive-index | negative-index] [,
"focus" | "nofocus"])**
Raise the current focused window to the front if no argument is
supplied.
Arguments can be specified in the form of a relative-window
("first", "last", "next", "previous"), a positive-index
@@ -4329,6 +4353,10 @@
Background color for calltips
[EMAIL PROTECTED]: helvetica medium 12 points
+
+ Default font for calltips.
+
[EMAIL PROTECTED]: #666
Foreground color for inactive tabs.
@@ -4349,6 +4377,10 @@
Italic font for online help.
+**nedit.boldItalicHelpFont**: helvetica bold italic 12 points
+
+ Italic font for online help.
+
**nedit.fixedHelpFont**: courier medium 12 points
Fixed font for online help.
@@ -4361,6 +4393,10 @@
Fixed italic font for online help.
+**nedit.boldItalicFixedHelpFont**: courier bold italic 12 points
+
+ Fixed italic font for online help.
+
**nedit.h1HelpFont**: helvetica bold 14 points
Font for level-1 titles in help text.
----------------------------------------------------------------------
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=111005&aid=1902887&group_id=11005
--
NEdit Develop mailing list - [email protected]
http://www.nedit.org/mailman/listinfo/develop
