Skip to content

Commit 904c203

Browse files
committed
Merge branch 'feature/issue#31+#32+#34-update-help+docs' into develop
2 parents 035b2c8 + 5d3f046 commit 904c203

35 files changed

+815
-297
lines changed

Docs/Design/FileFormats/export.html

Lines changed: 286 additions & 90 deletions
Large diffs are not rendered by default.

Docs/Design/FileFormats/user-db.html

Lines changed: 318 additions & 93 deletions
Large diffs are not rendered by default.

Docs/Design/reml.html

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,9 @@
201201
<li>
202202
<a href="#entities">Character Entities</a>
203203
</li>
204+
<li>
205+
<a href="#changes">Change Log</a>
206+
</li>
204207
</ul>
205208
</nav>
206209

@@ -384,6 +387,80 @@ <h1>
384387

385388
</section>
386389

390+
<section id="changes">
391+
392+
<h1>Change Log</h1>
393+
394+
<p>
395+
This section notes the changes in the various versions of REML.
396+
</p>
397+
398+
<p>
399+
<strong>v1 of 2008/12/31</strong>
400+
</p>
401+
402+
<p>
403+
Introduced in CodeSnip v2.2.5
404+
</p>
405+
406+
<ul>
407+
<li>
408+
Supported tags: <code class="value">&lt;strong&gt;</code> and <code class="value">&lt;a&gt;</code>.
409+
</li>
410+
<li>
411+
Supported entities: <code class="value">&amp;gt;</code>, <code class="value">&amp;lt;</code>, <code class="value">&amp;quot;</code> and <code class="value">&amp;amp;</code>.
412+
</li>
413+
<li>
414+
Supported protocols for use in <code class="value">&lt;a&gt;</code> tags: <code class="value">http</code>.
415+
</li>
416+
</ul>
417+
418+
<p>
419+
<strong>v2 of 2009/06/29</strong>
420+
</p>
421+
422+
<p>
423+
Introduced in CodeSnip v3.0
424+
</p>
425+
426+
<ul>
427+
<li>
428+
Added tags: <code class="value">&lt;em&gt;</code>, <code class="value">&lt;var&gt;</code>, <code class="value">&lt;warning&gt;</code>, <code class="value">&lt;mono&gt;</code>, <code class="value">&lt;p&gt;</code> and <code class="value">&lt;heading&gt;</code>.
429+
</li>
430+
<li>
431+
Added entity: <code class="value">&amp;copy;</code>.
432+
</li>
433+
</ul>
434+
435+
<p>
436+
<strong>v3 of 2009/07/06</strong>
437+
</p>
438+
439+
<p>
440+
Introduced in CodeSnip v3.0.1
441+
</p>
442+
443+
<ul>
444+
<li>
445+
Added protocol for use in <code class="value">&lt;a&gt;</code> tags: <code class="value">file</code>.
446+
</li>
447+
</ul>
448+
449+
<p>
450+
<strong>v4 of 2011/12/31</strong>
451+
</p>
452+
453+
<p>
454+
Introduced in CodeSnip v4.0 alpha 1 (preview)
455+
</p>
456+
457+
<ul>
458+
<li>
459+
Added protocol for use in <code class="value">&lt;a&gt;</code> tags: <code class="value">https</code>.
460+
</li>
461+
</ul>
462+
463+
</section>
387464
</body>
388465

389466
</html>

Docs/ReadMe.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,14 +245,14 @@ Known Installation and Upgrading Issues
245245
+ Any syntax highlighter customisation you have made will be lost if you are
246246
updating from any v2 or earlier.
247247

248-
You will need to redo any customisation using the "Syntax Highlighter" tab of
248+
You will need to redo any customisation using the "Syntax Highlighter" page of
249249
the Preferences dialogue box displayed from the "Tools | Preferences" menu
250250
option.
251251

252252
+ Your source code formatting preferences will have been lost if you are
253253
updating from v1.7.4 or earlier.
254254

255-
You will need to reconfigure them using the "Code Formatting" tab of the
255+
You will need to reconfigure them using the "Code Formatting" page of the
256256
Preferences dialogue box displayed from the "Tools | Preferences" menu option.
257257

258258
+ If you have updated to CodeSnip v4.2.0 or later from any earlier v4 release,

Src/FmPreferencesDlg.pas

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ interface
2727
/// Dialog box that sets user preferences.
2828
/// </summary>
2929
/// <remarks>
30-
/// This dialog box displays tabs for preferences frames registered with the
30+
/// This dialog box displays pages for preferences frames registered with the
3131
/// dialog box.
3232
/// </remarks>
3333
TPreferencesDlg = class(TGenericOKDlg, INoPublicConstruct)
@@ -161,16 +161,17 @@ implementation
161161
Design notes
162162
------------
163163
164-
This dialog box is a multi-page preferences dialog that provides access to
165-
each page via a tab. The dialog box does not provide an implementation of each
166-
page of the dialog. This representation must be provided by a frame descended
167-
from TPrefsBaseFrame. Such frames must:
168-
(a) register themselves with the dialog box by passing their class to the
164+
This dialogue box is a multi-page preferences dialog that provides access to
165+
each page via a list of page names. The dialogue box does not provide an
166+
implementation of each page. This representation must be provided by a frame
167+
descended from TPrefsBaseFrame. Such frames must:
168+
(a) register themselves with the dialogue box by passing their class to the
169169
TPreferencesDlg.RegisterPage class method.
170170
(b) implement all the abstract methods of TPrefsBaseFrame.
171171
172-
The dialog box will create registered frames when needed and host them within
173-
a tab sheet in the main page control.
172+
The dialogue box will create registered frames when needed and host them
173+
within tab sheet in the main page control. It will also add the name of the
174+
frame to a list control that is used to select the required "page".
174175
175176
There is no need to modify this unit when a new frame is to be addded to it.
176177
}
@@ -188,7 +189,7 @@ implementation
188189

189190
procedure TPreferencesDlg.ArrangeForm;
190191
var
191-
Idx: Integer; // loops through all displayed tab sheets
192+
Idx: Integer; // loops through all displayed page
192193
Frame: TPrefsBaseFrame; // references each preference frame
193194
TabSheet: TTabSheet; // references each tab sheet
194195
begin
@@ -306,7 +307,7 @@ class function TPreferencesDlg.Execute(AOwner: TComponent;
306307

307308
procedure TPreferencesDlg.FormDestroy(Sender: TObject);
308309
begin
309-
// Save current tab
310+
// Save current page
310311
if Assigned(pcMain.ActivePage) then
311312
Preferences.LastTab := MapTabSheetToPage(pcMain.ActivePage).DisplayName;
312313
inherited;
@@ -343,7 +344,7 @@ procedure TPreferencesDlg.InitForm;
343344
// Display and initialise required pages
344345
for TabIdx := 0 to Pred(pcMain.PageCount) do
345346
MapTabSheetToPage(TabIdx).LoadPrefs(fLocalPrefs, fFrameFlags);
346-
// Select last use tab sheet (or 1st if last not known)
347+
// Select last used tab sheet (or 1st if last not known)
347348
fCurrentPageIdx := GetLastTabIdx;
348349
if fCurrentPageIdx < 0 then
349350
fCurrentPageIdx := 0;

Src/FrCodeGenPrefs.pas

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
*
88
* Implements a frame that allows user to set source code generation
99
* preferences.
10-
* Designed for use as one of the tabs in the Preferences dialogue box.
10+
*
11+
* Designed for use as one of the pages in the Preferences dialogue box.
1112
}
1213

1314

Src/FrDisplayPrefs.pas

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
* Copyright (C) 2012-2020, Peter Johnson (gravatar.com/delphidabbler).
77
*
88
* Implements a frame that allows user to set application display preferences.
9-
* Designed for use as one of the tabs in the preferences dialog box.
9+
10+
* Designed for use as one of the pages in the preferences dialogue box.
1011
}
1112

1213

Src/FrGeneralPrefs.pas

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
* Copyright (C) 2007-2020, Peter Johnson (gravatar.com/delphidabbler).
77
*
88
* Implements a frame that allows user to set general application preferences.
9-
* Designed for use as one of the tabs in the Preferences dialogue box.
9+
*
10+
* Designed for use as one of the pages in the Preferences dialogue box.
1011
}
1112

1213

Src/FrHiliterPrefs.pas

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@
66
* Copyright (C) 2006-2020, Peter Johnson (gravatar.com/delphidabbler).
77
*
88
* Implements a frame that allows the user to set syntax highlighter
9-
* preferences. Designed for use as one of the tabs in the Preferences dialogue
10-
* box.
9+
* preferences.
10+
*
11+
* Designed for use as one of the pages in the Preferences dialogue box.
1112
}
1213

1314

Src/FrPrintingPrefs.pas

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
*
66
* Copyright (C) 2007-2020, Peter Johnson (gravatar.com/delphidabbler).
77
*
8-
* Implements a frame that allows user to set printing preferences. Designed for
9-
* use as one of the tabs in the Preferences dialogue box.
8+
* Implements a frame that allows user to set printing preferences.
9+
*
10+
* Designed for use as one of the pages in the Preferences dialogue box.
1011
}
1112

1213

0 commit comments

Comments
 (0)