Copyright: (C) 1994, 1995, 1996 David M Candy


Contents

Serenity Macros' Help File

Index of Serenity Commands	Goto Main Help File (Winword.Hlp)
Special Menu	Goto WordBasic Help File
Registration	Goto Word Readme Help File
Installation	Goto Product Support Services Help File


About David's Macros


Troubleshooting

Jumps To Other Help Files

Word uses its own way of finding help files. Help files are listed in Winword6.Ini. Serenity Macros can use the same way of finding help files but the install program will use Winhelp.ini.

Therefore there must be an entry in Winword6.ini or Winhelp.Ini.

Winword6.Ini

[Help]

Serenity.Hlp=<Path>\serenity.hlp

eg:

Serenity.Hlp=c:\winword\template\serenity.hlp

Or

Winhelp.Ini

[Files]

Serenity.Hlp=<path>

eg:

Serenity.Hlp=c:\winword\template

For jumps from this help file to other help files only the standard Window's help system is available. Therefore Winword.Hlp and Wrdbasic.Hlp need to have entries in Winhelp.Ini.

Winhelp.Ini

[Files]

Winword.Hlp=<path>

Wrdbasic.hlp=<path>

eg:

Winword.Hlp=c:\winword

Wrdbasic.hlp=c:\winword

The installation program would have already placed these entries into the appropriate files.


Tips

Tips For Serenity Macros Dialog Boxes

Troubleshooting Help

In most dialog boxes in the Serenity Macros package, help is available on the button or list box by holding the left button down over the item. If you don't want to choose the command move the cursor off the item and release the button.


Tips

In most dialog boxes in the Serenity Macros package, help is available on the button or list box by holding the left button down over the item. If you don't want to choose the command move the cursor off the item and release the button.


Index

File Macros

Macro Name	Description	Menu	Toolbar Button	Keystroke
Macro Warning	Open a document and warns if it has Auto Macros in it. Macro Warning [File Open] V1.0	File Open...		Ctrl + O
Save As Graphic...	Saves the selected object (overwrites the clipboard) or the contents of the clipboard as a WMF file.	File	_	_
Save Selection As...	Saves the selection in a seperate document.	File	_	_
Run Program...	Switches to or starts common windows programs.	File	_	_
Exit Windows...	Exits Windows and optionally restarts Windows or reboots the system. Prompts to save any changes to files.	File	_	_
Editing Macros

Macro Name	Description	Menu	Toolbar Button	Keystroke
Transpose Char...	Transposes characters.	Edit		Alt + 6
Transpose Word...	Transpose's current word with previous.	Edit	Shf +	Alt + 7
Serenity Expand	Similar to Emacs Dabbrev-Expand. Completes a word from a previous word in a document.	_	_	Alt + /
Find Prev Selected To Find	Finds the previous occurence of the current find string.	_		_
Find Prev Selected To Find	Copies selected text into the find buffer.	_	Ctrl +	_
Find Prev Selected To Find	Opens the find dialog box.	_	Shf +	_
Find Next Selected To Replace	Finds the next occurence of the current find string.	_		_
Find Next Selected To Replace	Copies selected text into the replace buffer.	_	Ctrl +	_
Find Next Selected To Replace	Opens the replace dialog box.	_	Shf +	_
End Of Word	Goes to the end of the current word.	_	_	Alt +
View Macros

Macro Name	Description	Menu	Toolbar Button	Keystroke
View2 Toolbar	Shows or hides the standard toolbar.	View Toolbar	_	_
View2 Ribbon	Shows or hides the formatting toolbar (ribbon).	View Ribbon	_	_
Stay On Top	Keeps Word as the top window, so it's always visible. WARNING... Drop down list boxes are hidden.	View	_	_
Show Zoom	Displays current zoom percentage in the status bar.	View	_	Alt + Z
Zoom 100	Changes the Zoom to 100% without changing the view mode.	View 100%	_	_
Tools Macros

Macro Name	Description	Menu	Toolbar Button	Keystroke
Spelling Helper...	Searches Word's dictionary for partial matches for the current word. Checks words formatted with "No Proofing".	Tools	_	Alt + F7
Sel Info...	Gives information about the insertion point or the selection.	Tools	_	_
Doc Info...	Displays the save status of all open documents. Also free disk space and current directory.	Tools	_	_
Other Settings...	Set options in Winword6.ini that affects technical aspects of Word.	Tools	_	_
Serenity Options...	Alters the options for Run Program and Spelling Helper. Sets the location of the Serenity help file.	Tools	_	_
Calculator...	Evaluates algebraic expressions. Inserts results into the document.	Tools	_	_
Table Macros

Macro Name	Description	Menu	Toolbar Button	Keystroke
Auto Column Width...	Changes selected cells to equal width, or changes table width to page width.	Table	_	_
Insert Cell Ref...	Memorises the current cell reference, and inserts a previous cell reference.	Table	_	_
Cell Ref 2 Clipboard	Copies the the cell reference to the clipboard.	_	_	Ctrl + Alt + Shf + C
Help Macros

Macro Name	Description	Menu	Toolbar Button	Keystroke
Serenity Help	Help for Serenity Macros.	Help	_	_
About Serenity...	Gives information about the version of Serenity Macros, and how to contact the author.	Help	_	_
Word Info...	Gives information about the version of Dos, Windows, and Word. Also some technical details.	Help	_	_
Macros Macros

Macro Name	Description	Menu	Toolbar Button	Keystroke
Macro Word Count...	Counts chars, words, lines in a macro pane or selection. Also gives macro name, description, and save status.	_		_
Insert Stop	Inserts a Stop Command at the beginning of the line, or removes a stop command.	_		_
Macro Indent Line	Indents a line or group of selected lines by using Tabs. Used in a macro window. Will work in a document.	_		_
Macro Unindent Line	UnIndents a line or group of selected lines by removing Tabs. Used in a macro window. Will work in a document.	_		_
Macro Library...	Common routines for Serenity Macros. Running this macro will open a dialog box listing the routines.	_		_
Macro Display Variable	Inserts a MsgBox that displays the highlighted variable.	_		_
Support Macros

Macro Name	Description	Menu	Toolbar Button	Keystroke
Regenerate Menu	Sets or resets the item on the Special menu.	Special	_	_
Auto Open Auto Close Auto New Auto Exec File New Default	All these macros call Regenerate Menu


Macro Library (Listing)
Macro Library

A Listing Of All Common Sub-Routines And Functions

See Macro Library Command

Function WriteClipboardText(Text$)

Function ReadClipboardText$

Function CheckMenu(MainMenuString$, SubMenuString$, Action)

Function GetParentWindow

Sub ContextHelp(FName$, Topic)

Sub XtraHelp(FName$, Topic$)

Function FindHelpFile$(FName$)

Sub MsgErr1(HelpFile$)

Sub MsgErr2(HelpFile$)

Function Browse$(FName$, Title$, Filter1$, Filter2$, Flags, Type)

Sub WriteInt(lp, num)

Sub WriteLong(lp, num)

Function ReadInt(lpGlobal)

Sub RemoveSpecialMenu

Sub MakeSpecialMenu

Function IsProtected

Function GetModifer


WriteClipboardText

Function WriteClipboardText(Text$)

Assigns the contents of a variable to the clipboard.

Text$	The string to write to the clipboard.
Returns	-1 if successful.

If the string cannot be written then the function warns the user that the clipboard is in use by another application.


ReadClipboardText
ReadClipboardText$

Function ReadClipboardText$

Assigns the contents of the clipboard to a string.

Returns	The text in the clipboard.

If the clipboard doesnt contain a string or is unavailable then the function warns the user.


CheckMenu

Function CheckMenu(MainMenuString$, SubMenuString$, Action)

Adds a tick or removes a tick from a menu item. Queries if a menu item is ticked.

MainMenuString$	The text of the menu item on the menu bar. Include the ampersand for the unerlined character
SubMenuString$	The text of the menu item on the sub menu. Include the ampersand for the unerlined character
Action	0 Queries if the menu item is checked. 1 Checks the menu item 2 Uncheckes the menu item
Returns	If Action=0 -1 If Checked 0 If Unchecked 1 If error If Action = 1 or 2 -1 If successful 1 If Error

If Word changes the menu structure, either through Tools-Customisation or loading a template that changes the menu structure, the ticks are lost.


GetParentWindow

Function GetParentWindow

Gets the handle of the top level window. Often used in API calls.

Returns	The handle of the top level window.


ContextHelp

Sub ContextHelp(FName$, Topic)

Starts context sensitive help. This sub calls FindHelpFile.

FName$	The filename of the help file without a path.
Topic	The context sensitive help number. These numbers are defined in the help project file. If you dont write your own help files this is probably not very useful. If nul then the file is opened to the contents page.


XtraHelp

Sub XtraHelp(FName$, Topic$)

Starts help. This sub calls FindHelpFile.

FName$	The filename of the help file without a path.
Topic$	The string for a topic in help. This is the same as appears in Search dialog box in windows help. If nul then the file is opened to the contents page.


FindHelpFile$

Function FindHelpFile$(FName$)

This function takes a filename and returns a path and filename to a help file. It looks in Words programme and template directories, in winword6.ini and winhelp.ini. If the file isnt found an error message is given listing the directories where it looked.

FName$	The filename of the help file without a path.
Returns	The path and filename of the helpfile.


MsgErr1
MsgErr

Sub MsgErr1(HelpFile$) or Sub MsgErr2(HelpFile$)

MsgErr1	Advises the user that helpfile was found but could not be opened.
MsgErr2	Advises the user that a helpfile could not be found. It lists where the calling routine (FindHelpFile) looked.
HelpFile$	The name of the help file.


Browse$

Function Browse$(FName$, Title$, Filter1$, Filter2$, Flags, Type)

Displays a standard File Open or File Save As dialog box.

FName$	A filename or null. This displays in the textbox labled File Name. If null the filter is displayed instead.
Title$	The title of the dialog box. If null then Serenity Options - Browse will be displayed.
Filter1$	The name of the filter. If null then All Files will be displayed.
Filter2$	The actual filter specification. If null then *.* will be used. Note this function only allows one filter pattern.
Flags	Add flags together. See the Windows SDK for a full listing. 2 Overwrite warning 4 Hides the read only checkbox. This function doesnt return the state of this checkbox so this flag should be used. 8 Changes the directory back if the user changes it. 2048 Path must exist. 4096 File must exist. 8192 Shows a file not found, create it. 16384 ShareAware flag. This flag must be used. The system may crashed if its not.
Type	0 File Open 1 File Save As
Returns	The path and filename of the file chosen.


WriteInt

Sub WriteInt(lp, num)

Writes an integer to an address. Used for initialising structures.

lp	A long pointer. This is the address that the integer will be written at. This address is obtained by calling GlobalLock(hMem).
num	The number to write.


WriteLong

Sub WriteLong(lp, num)

Writes an long to an address. Used for initialising structures.

lp	A long pointer. This is the address that the integer will be written at. This address is obtained by calling GlobalLock(hMem).
num	The number to write.


ReadInt

Function ReadInt(lpGlobal)

Reads an integer from an memory address.

lpGlobal	A long pointer. This is the address that the integer will be read from. This address is obtained by calling GlobalLock(hMem).
Returns	A number. Word assumes that integers are between 0 to -32787. That is the sequence is 0, 1, 2,..., 32787, -32787, -32786,...,-1


SpecialMenu

Sub RemoveSpecialMenu or Sub MakeSpecialMenu

Adds or removes the Special Menu item. Note this only effects the menu bar and the first item. See RegenerateMenu for the command that puts the items on the menu.


IsProtected

Function IsProtected

Tests the current document to see if its protected by Tools Protect Document.

Returns	-1 If the current document is protected.


GetModifer

Function GetModifer

Returns if a shift, control, or alt key was pressed on the last mouse click or key press.

Returns	1 If the Shf key was pressed. 2 If the Control key was pressed. 4 If the Alt key was pressed.


File Open

To Protect Against Suspicious Documents

Macro Warning is a macro that is called File Open. It guards against documents and templates that carry auto macros. It also warns when a document is really a template.

Macro Warning displays a message only when there is something to report. It reports the presense of auto macros, templates with the extension of doc, and warns if the document is protected.

Only templates can have macros and viruses can spread in Word's templates. Viruses will usually call themselves AutoOpen or one of the other auto macros. Not all macros that are auto macros are bad, this program simply warns that there may be something amiss. Some viruses will call themselves File Open, File Close, or File Save.

If the document is protected Macro Warning cannot access the internal commands to test the document and displays the following dialog box.

The options are

Open File	Open the file according to the radio button options.
Close File	Closes the file. Doesn't allow any macros to run.
Help	Starts Help (this page).
Disable AutoMacros	Doesn't allow any auto macros to run such as AutoClose or AutoExit.
Enable Auto Macros	Leaves Auto Macros enabled.
If auto macros are detected, or a template has an extension other than .dot, the following dialog box is displayed.

The options are

Open File	Open the file according to the radio button options.
Close File	Closes the file. Doesn't allow any macros to run.
Help	Starts Help (this page).
Open Normally	Leaves auto macros enabled. and runs AutoOpen.
Don't Run Auto Open	Leaves auto macros enabled. But doesn't run AutoOpen.
Disable AutoMacros	Doesn't allow any auto macros to run such as AutoClose or AutoExit.


Save As Graphic
Save As Graphic...

Save Selected Object Or Clipboard Contents As A .WMF File

Saves selected object or contents of the clipboard as a windows metafile. Word copies text to the clipboard in a number of formats. Text selected in Word is saved as a text box in a metefile.

If an object is selected in the document the following message box appears.

The options are

Yes	Copies the selected object onto the clipboard.
No	Doesn't copy the selected object on to the clipboard. The existing contents of the clipboard will be saved as a graphic.
Cancel	Quits the macro.

The main dialog box shows a preview of the picture.

Save As	Chooses a filename for the selected picture, and then saves the picture.
Close	Quits the macro
Help	Starts Help (this page).

A standard file save dialog is then shown. File Save As Graphic offers a default file name of Pic<NUM>.wmf.


Save Selection As

Saves The Selection In A New Document On Disk.

Copies the selection into a new document. Opens the standard Save As dialog box. Saves the file in the format chosen and returns to the original document.

For more information on Save As choose help from the dialog box.


Run Program

To Start Common Window's Programs

Run Program starts or switches to common Window's programs.

To have Run Program find programs that aren't on the path run Serenity Options on the Tools Menu

or edit Winword6.Ini:

[Run Program]

calc.exe=c:\windows\msacess (for the windows calculator)

The custom apps require the following ini settings

[Run Program]

Executable FileName.FileExtension=path to file

CustomText1 (or 2)=Text that appears in the dialog box.

CustomFileName1 (or 2)= Executable FileName.FileExtension

CustomWindowName1 (or 2)=The text that appears in the title bar of the application.

Leaving CustomWindowName1 blank means that Run Program will start a new instance of the program rather than switching to an existing running program.

Run Program doesn't return any error messages. If it can not find the file it issues a general exec and hopes that windows can find the file.


Exit Windows

To Exit Windows And Optionally Rebooot Or Restart Windows

Exits Windows. Confirms that you really want to exit, issues a File Save All command which prompts to save changes to files, then exits.

Ok	Carries out the command specified by the radio buttons. Prompts to save all changes.
Cancel	Quits the macro.
Help	Starts Help (this page).
Exit Windows	Returns to the DOS prompt.
Restart Windows	Exits and restarts Windows.
Reboot System	Exits Windows and reboots the computer.


Transpose Character Or Word

To Transpose Characters Or Words

Both of these commands appear on the Edit Menu.

	Transpose Character Transposes characters either side of the insertion point. Default key assignment is Alt + 6. The Install program will have inserted a toolbar button on the main toolbar.
Shf +	Transpose Word Transposes the current word with the previous. Default key assignment is Alt + 7.  The Toolbar button is Shift key + the same button as Transpose character.


Serenity Expand

Completes A Word From A Previous Word In A Document.

Serenity expand is invoked by Alt + /. The status bar shows the keys to press. Each additional press of the / key will jump to a previous string. Pressing enter will copy the word to where you are typing.

/  Key	Jumps to a previous string that starts with the partial word that was being typed when Serenity Expand was started.
Ctrl  Key	Expands a found phrase one word.
Enter Key	Copies the found word or phrase to complete the partial word.
Escape Key	Cancels searching and Serenity Expand mode.


Find Prev Selected To Find & Find Next Selected To Replace

Toolbar Buttons For Finding And Replacing

	Find Previous Finds the previous occurrence of the current search string.
	Find Next Finds the next occurrence of the current search string.
Ctrl +	Copy Selected Text To Find String Copies the currently selected text into the Find What buffer and searches for it.
Ctrl +	Copy Selected Text To Replace String Copies the currently selected text into the Replace With buffer and searches for the string in the Find What buffer..
Shf +	Opens Find Dialog Box
Shf +	Opens Replace Dialog Box


End Of Word

Goes To The End Of The Current Word

End Of Word goes to the end of the current word and is assigned to Alt + [image].


Toolbar

To Allow Quick Switching Of The Toolbar As WW2

Toolbar allows the toolbar to be shown of hidden by a quick menu command. A tick appears next to the menu when the toolbar is visible

If the toolbar is shown or hidden from elsewhere in word, the menu will get out of sync with the toolbar's actual status. Running the command will resynch the toolbar and menu. (See Regenerate Menu)

This was a command that disappeared from Word 6.0 but was in Word 2.0.


Ribbon

To Allow Quick Switching Of The Ribbon As WW2

Ribbon allows the ribbon to be shown of hidden by a quick menu command. A tick appears next to the menu when the toolbar is visible

If the ribbon is shown or hidden from elsewhere in word, the menu will get out of sync with the ribbon's actual status. Running the command will resynch the ribbon and the menu. (See Regenerate Menu)

This was a command that disappeared from Word 6.0 but was in Word 2.0.


Stay On Top

To Allow Word To Stay On To Of Other Windows

Stay on top is a menu command that allows Word to stay on top of other windows.

When activated a tick will appear next to the menu. It doesn't remember its settings from one session to another.


Show Zoom

Shows The Current Zoom In The Status Bar.

Shows the current zoom in the status bar. This command is assigned to Alt + Z. Used when the toolbar button showing zoom is removed to allow other buttons on the bar.


100%

Sets The Zoom To 100% Without Changing To Normal View

This macro changes the zoom to 100%. When using Words built in equivalent command it changes the view to normal. This macro doesn't change the view.


Spelling Helper

To Help With Finding The Correct Spelling For A Word

Helps with finding the correct spelling of a word and derived words. Checks words formatted with no proofing. Will also check words in a Macro Pane. Allows words that are spelt correctly to be used to find the correct word.

Macro can only return a maximum of 20 alternatives. Use wildcards to narrow the search.

All words are checked in English[Aus]. Edit winword6.ini  and change 'Language= ' line in the [Spelling Helper] section or use Serenity Options to change. Use the format from Tools-Language. Spelling Helper uses the custom dictionary specified in Win.ini.

Close

Closes Spelling Helper and makes no changes

Replace

Replaces the current word in the document with the replacement word and exits Spelling Helper.

Clipboard

Copies the replacement word to the clipboard. Doesn't exit Spelling Helper

Revert

Returns to the original word that Spelling Helper started with.

Lookup

Looks up the search word in the dictionary

Suffixes.

Removes suffixes from the search word to try to find the root word. This is to find derivative words.

Longer suffixes are removed first.

ology	able	ably	ible	iest	less	ling	logy	ness	ting
ate	ely	ern	ial	idy	ier	ies	ily	ing	ion
ise	ism	ist	ity	ive	ory	ous	tic	's	al
ed	er	ic	ix	ly	e	s	y.

Array Full

	Indicates that the array is full. Try using wildcards or a different parameter to Finish Word to narrow the search. Only visible when the array is full

Search Mode

	The type of search. Finish Word Searches words that start with the string. Same as a wildcard search but has a * or ? appended to the end invisibly. See Finish Word options below. Anagrams Find anagrams of the string. Good for puzzles in the paper. Wild Card Find a string using wildcards. Wildcards are not invisible.  * is any no of chars. ? is a single chars D?g would find dog or dag.  Help?? would find helper.  Help* would find help or helper." Standard is Word's standard spelling algorithm.
Finish Word Options

	Is only seen when Finish Word is the search method. Indicates approx how much longer is the word is, as Winword can only return 20 suggestions.


Selection Info

To Find Out Information About The Selection

To find out what characters are in a selections.

Top box tells the page and section where the selection ends, the distance from the top of the selection to the top of the page, and left of the selection to left of the page.

Bottom box gives the ANSI codes of the selection and allows the paging of large selections.


Document Info

To Find Out Information About The Document

To set various options for the document and a quick check of printing options.

Gives information about all open documents.

Saved Status	Whether Word considers the document saved. Changing this to unsaved means Word will ask "File has changed. Do you wish to save?". Changing this to saved means Word considers the file already to have been saved and won't prompt to save changes.
Embed True Type Fonts	This determines if unusual True Type fonts are saved in the current document, allowing the document to be printed on another computer where the fonts aren't available.
Native Picture Format	Saves only Windows graphics in the current document on files imported from the Mac platform.
Fast Saves	Uses Fast Saves to save documents. This applies to all documents.
Backups	Creates Backup files for all documents.
File Size	The size of the current document on the disk. Files need to have been saved first to show the actual size of the file in memory.
Free Space	The free space on the disk.
Paper Size	The default paper size for the current document.


Other Settings

To Customise Settings In Word

To set options in Winword6.ini in an easy way.

For information on the actual settings see Winword6.Ini setting in Word's Readme Help


Serenity Options

To Set Options For Serenity Macros

Sets the location of the Serenity help file, the parameters for Run Program, and the default language for Spelling Helper.

Ok	Saves changes.
Cancel	Doesn't save changes.
Help	Starts context sensitive help (this page).

There are four areas that options can be set for.

Run Program

Sets the options for Run Program, a macro that starts other programs.

Setup Item	Run Program has nine program items, seven of which are preset and two user configurable. This drop list box chooses which of the nine items to set up.
Menu Name	Changeable for user configurable items only. The name displayed in the Run Program dialog box.
Program Name	Changeable for user configurable items only. The executable file name and extension.
Window Name	Changeable for user configurable items only. The name that appears in the title bar. This can be only the first few words.
Path	The path to the executable file. If this isn't specified then only the MS-DOS path and windows directory is searched.
Browse...	Allows the easy selection of paths for preset items and paths and filename for user configurable items.

Spelling Helper

Sets the options for Spelling Helper, a macro that searches Word's dictionary for partial matches for the current word.

Language	The default language that Spelling Helper users. As Spelling Helper checks word formatted with No Proofing it needs to be told the language to use.  As most users only have one dictionary, and Word uses the closest dictionary to the language specified. Therefore all languages are checked to this one dictionary.

Serenity Help

The location of the Serenity Help file.

Location of the Serenity Help	The location of Serenity Help. Due to the way Windows Help works it may be necessary to tell Windows where Serenity Help is.
Browse	Allows the easy selection of the path.

Menu's

Options for the Special Menu .

Special Menu	Turns on or off the Special Menu.
Fast Menu	Turns on or off checking of the Special Menu and ticks of the Toolbar and Ribbon items on the View menu. Turning this off will improve responsivness when opening and closing documents, but Regenerate Menu may need to be run manually.


Calculator

Quick Access To An Algebraic Calculator

Allows the calculations of sums.

Ok	Closes the calculator.
Insert	Inserts the result into the document.
Evaluate	Evaluates the expression.

Calculator remembers the last expression used.

For information on terms that can be used in the expression see Formula Fields in Winword.Hlp


Auto Column Width

Changes Cells To Equal Width, Or Changes Table To Page Width.

To changes cells to equal width, or changes table to page width.

Ok	Carries out the command specified by the options buttons.
Cancels	Closes the dialog box and doesn't carry out the command.
Help	Starts context sensitive help (this page)
Equal Size	Makes selected columns (or current column if no selection) equal size. The total width of the selected columns doesn't change. It is assumed that the space between column is 0.38cm.
Equal Size & Fill Margins	Makes the selected columns (or current column if no selection) equal size. The total width of the selected columns will change so the total table width is equal to the margin width.
AutoFit	Makes selected columns just wide enough to fit the text without changing  the way text is wrapped.


Insert Cell Reference

Memorises Current Cell Reference, Inserts A Saved Cell Reference.

To copy a cell reference to a formula. See Cell Ref 2 Clipboard to quickly copy cell references.

Cell references are used in tables to give spreadsheet like functions. See Formula Fields in Winword.Hlp

Insert	Inserts the previously saved cell reference into the document.
Copy	Copies the cell reference where the cursor is to a buffer, allowing it to be inserted later by the insert command. This is stored in Winword6.Ini.
Close	Closes the dialog box.
Help	Starts context sensitive help (this page)


Cell Ref 2 Clipboard

Copies The Cell Reference To The Clipboard.

Copies the current cell reference to the clipboard. This macro is assigned to Ctrl + Alt +Shf + C.

This is a quick way of coping cell references without a dialog box. See Insert Cell Reference


Serenity Help

Help For Serenity Macros

Starts the Help file and sets it to the contents.


About Serenity

Information About The Version Of Serenity Macros

Shows copyright and version information about Serenity Macros


Word Info

To Find Out Information On Dos, Windows, and Word

Word Info give information on Dos, Windows, Word, and hardware.

Windows returns the version of 3.10 to allow old programs to run.

Checking the box marked Floppy will check free space on drive A, otherwise free space is shown for the current drive.

The default Date and Time shows the default format word is using. The clock will only run for several minutes (32768 / 18.2 =1800 seconds).

Running WordInfo will compact memory and may alleviate an Out Of Memory condition.


Macro Word Count

To Count Words In A Macro Pane

	Gives the name, description, word count, and saved status of a macro that's being edited. This differs from Word's word count in that it will count in a macro pane.


Insert Stop

To Aid In Debugging A Macro

	Inserts a Stop -1 at the beginning of  a line. If the line already contains a Stop -1 then it removes it. The insertion point can be anywhere on the line. Stop -1 stops a running macro without displaying a dialog box. It is a debugging statement. See Stop in Word Basic Help


Macro Indent & Unindent Line

To Help Format Macros

	Macro Unindent Line	Shifts a line or selected area indented with tabs one tab stop to the left by removing tabs.
	Macro Indent Line	Indents a line or selected area one tab stop to the right by inserting tabs.


Macro Library (Command)

Lists Common Routines

	Macro Library allows the insertion of Serenity's Macros common routines. See Macro Library Listing for a description of each routine.
Ok	Closes the dialog box.
Insert	Inserts the chosen function into the active window.
Help	Starts context sensitive help (this page).


Macro Display Variable

Displays The Contents Of A Variable

	Inserts a message box displaying the value of the variable. A message box will ask whether to insert the macro ststement on the next line or to copy it to the clipboard. This is used in debugging macros.


Special Menu

Menu Access To Inbuilt Commands

This is an additional menu that allows access to additional Word's commands that don't normally appear on the menus. Serenity also adds some commands to the other menus (see Additional Commands.).

Because Word hasn't added these menu items they obey different rules to menu items on Word's other menus. They don't list keyboard shortcuts, and if Word changes its' menu structure they disappear.

Running Regenerate Menu will rebuild the menu and also retick the items on the View menu.

Serenity automatically calls Regenerate Menu when a file is opened (using File Open only), closed or a new file is chosen. This can slow Word down a bit and can be turned off in Serenity Options.

To get help on an menu item position the cursor over the item and press F1 or click the Help Tool and then the menu item.


Regenerate Menu

Rebuilds The Special Menu

Rebuilds the items on the Special Menu and reticks the items on the View menu.


Additional Commands

Inbuilt Word's Commands Added To The Menu

Serenity adds several inbuilt commands to Word's menus and one to the main toolbar. Change Case is added to the Toolbar next to Transpose Char.

To find help on these commands click the Help Tool and then the menu item.

File

Organiser

Edit

Select Drawing Objects

Repeat Find

View

Draft

Status Bar

Insert

Page Break

Remove Frames

Format

Shrink To Fit

Copy Format

Paste Format

Tools

Advanced Settings

Help

System Information


Installation

Installing Serenity Macros

System Requirements

To start the Install program just open Install.Doc in Word.

The installation program finds out what is the Startup directory and if there isn't one creates it and tells Word that it's been created. It then copies two files into the startup directory, Serenity.Dot and Serenity.Hlp.

It finds the four standard Word help files and adds them to Winhelp.Ini to allow inter help file jumps from Serenity help. It then add Serenity.Hlp to Winhelp.Ini. After this it closes Install.Doc.

Serenity does not modify Normal.Dot in any way.

Serenity uses the Microsoft suggested way of installing macros, which is to install them as a separate template.

To uninstall

Delete Serenity.Dot and Serenity.Hlp, and remove any reference to Serenity.Hlp from Winhelp.Ini (though it won't matter much if you leave it in there). Some of the Macros store settings in Winword6.Ini. These are under the following headings:

[Spelling Helper]

[Run Program]

[Calculator]

Both Spelling Helper and Run Program add their entries to MS Word Editable Sections (which allows them to be edited with "ToolsAdvancedSettings").

To temporally uninstall just move the files. To add in as required move both files to a different directory, alter the path in Winhelp.Ini, and use File-Templates-Add Global Templates and Addins.


System Requirements

Serenity macros started out as macros for Word V 1.0, rewritten for Word V 2.0, and again rewritten fo Word V 6.0.

Heavy use has been made of new Word V 6.0 commands and most of these macros will not work with earlier versions of Word. Microsoft added some commands to Word V 6.0A that weren't available in Word V 6.0.

Serenity make a large number of Windows API function calls as well.

It has been tested on Word V6.0C on Windows 3.11 running on a 486SX/33 with 8 Mbyte of RAM. It runs at a good speed. The speed has been found acceptable with only 4Mbyte, but this was on a highly tuned Windows system with as many modules (such as multimedia) as possible removed from memory.

It hasn't been tested under Word V 6.0/Windows 95 but I think it should run.

It won't run under Word V 7.0 (Word 95) as it uses Windows 3.10/3.11 function calls.