Skip to content

Commit 677cecb

Browse files
committed
Add Update Frequency override in options dialog.
Merge doc fixes.
1 parent d8e95f9 commit 677cecb

29 files changed

+322
-205
lines changed

docs/assets/images/options.jpg

26.6 KB
Loading

docs/dev/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ This is a GUI test, so do not move your mouse or type on your keyboard or let yo
6969
completed. Total test run time is about 12 minutes.
7070
7171
The tests all pass on Windows 10, but currently some tests fail on Windows 11, there seems to be some breaking changes
72-
in the Windows Automation layer that XML notepad tests are using. This is being investigated.
72+
in the Windows Automation layer that XML Notepad tests are using. This is being investigated.
7373
7474
Note: [bug 10244](https://github.com/dotnet/winforms/issues/10244) is still open in in .net 4.8
7575
System.Windows.Automation of menu items that blocks the tests, so checkout the branch `clovett/net472` to run the unit
@@ -142,4 +142,4 @@ See [XML Notepad Design ](design.md) for more detailed information about how thi
142142
143143
Feedback and suggestions are welcome, just use the [GitHub issues
144144
list](https://github.com/microsoft/XmlNotepad/issues). Pull requests are also welcome, in fact, a number of good pull
145-
requests have already been merged. Thanks to all who are helping to make XML notepad a great tool!
145+
requests have already been merged. Thanks to all who are helping to make XML Notepad a great tool!

docs/help/analytics.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11

22
## Analytics
33

4-
In order to understand which features are important XML Notepad records anonymous usage like:
4+
To understand which features are important, XML Notepad records anonymous usage data, like:
55

6-
1. how many times the app is used
7-
2. how many times each feature is used (options, xslt, search, etc)
6+
1. The number of times the app is used.
7+
2. The number of times each feature is used (options, xslt, search, etc)
88

9-
The data is collected using Google Analytics and shared only with members of the XML Notepad development team. The data
10-
is used to prioritize future work to improve the features that are most popular.
9+
The data is collected using Google Analytics and shared solely with members of the XML Notepad development team.
10+
It's used to prioritize future enhancements.
1111

12-
As a teaser, here is a map of countries where XML Notepad was used in July 2022. That's super cool to see a healthy
13-
community of users and this motivates the team to keep XML notepad in tip-top shape.
12+
As a sneak peek, here is a map illustrating the countries where XML Notepad was used in July 2022. This vibrant user
13+
community is a strong motivator for the team to continually refine XML Notepad.
1414

1515
![map](../assets/images/map.png)
1616

@@ -30,19 +30,19 @@ The first time you install XML Notepad on your computer you will be prompted wit
3030
![popup](../assets/images/analytics.png)
3131

3232

33-
Thanks to those who have allowed analytics to be collected, it really helps to understand usage patterns and prioritize
34-
what to improve. But, if you really need to click `No` then the choice will be written to the XML Notepad settings file
35-
and it will not be prompted again. Analytics can be enabled or disabled any time using the `Allow analytics` option in
36-
the [Options dialog](options.md).
33+
We appreciate those who allow analytics to be collected; significantly aids in understanding usage patterns and
34+
prioritizing improvements. However, if you prefer not to participate, click `No` then your preference will be written to
35+
the XML Notepad settings file, and the prompt will not reappear. You can enable or disable analytics at any time using the
36+
`Allow analytics` option in the [Options dialog](options.md).
3737

38-
If you want to disable analytics before installing XML Notepad (perhaps in an enterprise wide distribution) then you can
39-
set this environment system wide on the end user's machine:
38+
For enterprise-wide distributions or pre-installation customization, you can set the following environment variable
39+
system-wide on the end user's machine:
4040

4141
```
4242
set XML_NOTEPAD_DISABLE_ANALYTICS=1
4343
```
4444

45-
You can also disable the Analytics UI option from appearing in the [Options dialog](options.md) by setting the
45+
Additionally, you can disable the Analytics UI option from appearing in the [Options dialog](options.md) by setting the
4646
`AnalyticsClientId` to disabled in the default [XmlNotepad.settings](settings.md) file as follows:
4747
```xml
4848
<Settings>
@@ -51,4 +51,4 @@ You can also disable the Analytics UI option from appearing in the [Options dial
5151
</Settings>
5252
```
5353

54-
This ensures the user cannot enable analytics after starting XML notepad.
54+
This ensures that users cannot enable analytics after starting XML Notepad.

docs/help/clipboard.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Cut/Copy/Paste and [Drag/drop](dragdrop.md) are based on the same XML clipboard
66
out of XML Notepad and into any editor that supports a text clipboard format and its the same as doing a Cut & Paste
77
operation.
88

9-
The clipboard format is the XML serialization of the selected node plus any namespace declarations needed to make that
10-
fragment well formed.
9+
The clipboard format is the XML serialization of the selected node, along with any necessary any namespace declarations
10+
needed to ensure the fragment well formed.
1111

12-
When XML is pasted from the clipboard (or dropped) onto the [tree view](overview.md) the namespace declarations are
13-
matched with what is in the target document already and normalized accordingly. This ensures your document doesn't
14-
sprout lots of redundant namespace declarations as a side effect of these editing operations.
12+
When XML is pasted from the clipboard (or dropped) onto the [tree view](overview.md), the namespace declarations are
13+
matched those already present in the target document and normalized accordingly. This prevents your document from
14+
accumulating redundant namespace declarations as a side effect of these editing operations.

docs/help/customeditors.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,46 @@
11

22
## Custom Editors
33

4-
If an XML schema is provided for validation then that schema can also define custom editors on specific
4+
If an XML schema is provided for validation, it can also define custom editors on specific
55
`<xsd:simpleType>` tags.
66

7-
A default custom editor is provided for the simpleTypes xsd:date xsd:dateTime and xsd:time. Any element or attribute of
8-
this type will be edited using the WinForms DateTimePicker, configured for the current system locale, for example:
7+
A default custom editor is provided for the simpleTypes `xsd:date`, `xsd:dateTime`, and `xsd:time`. Any element or
8+
attribute of this type will be edited using the WinForms DateTimePicker, configured for the current system locale, for
9+
example:
910

1011

1112
![datetime](../assets/images/datetime.jpg)
1213

1314
## Custom Builders
1415

15-
Custom Builders provide a button that appears at the top of the intellisense list, when the user clicks on that button
16-
it invokes the builder to edit the value, which usually pops up a modal dialog.
16+
Custom Builders provide a button that appears at the top of the intellisense list. When the user clicks on that button,
17+
it invokes the builder to edit the value, typically triggering a modal dialog.
1718

1819
A custom builder for editing file names is provided and is automatically associated with the xsd:anyURI data type. You
1920
can associate this builder manually using the `vs:builder="XmlNotepad.UriBuilder">` attribute. When you edit an element
20-
of this type a button will appear titled "Browse..." at the top of the intellisense list and when you click on this
21-
button the WinForms OpenFileDialog will appear.
21+
of this type, a button titled "Browse..." will appear at the top of the intellisense list, and clicking it will open
22+
the WinForms OpenFileDialog.
2223

23-
A custom builder for editing colors is provided. But since there is no standard color type defined in XSD, you must
24-
specify the vs:builder attribute as shown in the following example:
24+
A custom builder for editing colors is also provided. However, since there is no standard color type defined in XSD, you must
25+
specify the `vs:builder` attribute as shown in the following example:
2526

2627
```xml
2728
<xsd:simpleType name="color" vs:builder="XmlNotepad.ColorBuilder">
2829
```
29-
Where the "vs" prefix is bound to the following namespace:
30+
Where the `vs` prefix is bound to the following namespace:
3031
`xmlns:vs="http://schemas.microsoft.com/Visual-Studio-Intellisense"`.
3132

32-
If you build your own custom editors you will also need to specify the `vs:assembly="FontBuilder, Version=1.0.0.0,
33+
If you build your own custom editors, you will also need to specify the `vs:assembly="FontBuilder, Version=1.0.0.0,
3334
Culture=neutral, PublicKeyToken=007b972e7cff2ded, processorArchitecture=MSIL"` attribute to point to your assembly. XML
3435
Notepad will then load your assembly so it can find the specified types.
3536

3637
![Colors](../assets/images/colors.jpg)
3738

38-
When you edit an element of this type a button will appear titled "Color Picker" at the top of the intellisense list and
39-
when you click on this button the WinForms ColorDialog will appear. The resulting color will then be serialized back to
39+
When you edit an element of this type a button titled "Color Picker" will appear at the top of the intellisense list and
40+
and clicking on it will open the WinForms ColorDialog. The resulting color will then be serialized back to
4041
the XML string using the `ColorConverter`.
4142

42-
You can implement your own builders by implementing `IXmlBuilder `and specifying your full class name in the
43+
You can implement your own builders by implementing `IXmlBuilder` and specifying your full class name in the
4344
`vs:builder` attribute.
4445

4546
See also [Schemas Dialog](schemas.md).

docs/help/dragdrop.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11

22
## Drag/Drop Support
33

4-
You can drag and drop nodes from the tree view to move them around inside the document or across documents using
4+
You can drag and drop nodes from the tree view to rearrange them within the document or more them across documents using
55
multiple instances of XML Notepad. (Note: You can easily create a new instance of XML Notepad by selecting the
6-
Window/New Window menu item). You can also drag an XML file from Windows Explorer onto XML Notepad as a quick way to
7-
open that file.
6+
Window/New Window menu item). Additionally, you can drag an XML file from Windows Explorer onto XML Notepad as a quick
7+
way to open that file.
88

9-
When you Drag/Drop nodes across programs, it uses the same text format as [Cut/Copy/Paste](clipboard.md).
9+
When you drag and drop nodes across programs, it uses the same text format as [Cut/Copy/Paste](clipboard.md).
1010

11-
When dragging the selected element a shadow node will appear in the tree that moves with the cursor showing you where
12-
the node will be moved to. In the example below, the "Street" element is being dragged to a new location after the
11+
As you drag the selected element, a shadow node will appear in the tree, moving with the cursor to indicate where
12+
the node will be placed. In the example below, the "Street" element is being dragged to a new location after the
1313
"First" element and before the "Middle" element:
1414

1515
![DragDrop](../assets/images/dragdrop.jpg)
1616

17-
When you hover the mouse over a collapsed node it is automatically expanded just in case you are trying to drop the node
18-
inside that collapsed container and conversely, when you hover over an expanded node it is automatically collapsed so
19-
that you can easily find nodes above or below that container.
17+
When hovering the mouse over a collapsed node, automatically expands to facilitate dropping the node inside that
18+
collapsed container. Conversely, when hovering over an expanded node, it automatically collapses, aiding in finding
19+
nodes above or below that container.
2020

21-
Dragging is a move operation by default, even across XML Notepad instances, which means if you drag a node from one XML
22-
Notepad instance to another it will be removed from the first instance. If you want to perform a copy operation, hold
23-
down the CONTROL key.
21+
By default, dragging is a move operation, even across XML Notepad instances, meaning if you drag a node from one XML
22+
Notepad instance to another, it will be removed from the first instance. If you wish to perform a copy operation
23+
instead, hold down the CONTROL key.
2424

25-
See [Keyboard](keyboard.md) for more information.
25+
See [Keyboard](keyboard.md) for more information.

docs/help/dynamic.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
When you have an associated [XSD schema](schemas.md), the `xsd:documentation` associated with the current node is
44
displayed in a tooltip popup and in the Dynamic Help Tab.
55

6-
For example, the `Employee.xsd` schema contains the following annotation on the defintion of the Employee Id attribute:
6+
For example, the `Employee.xsd` schema contains the following annotation on the definition of the Employee Id attribute:
77

88
```xml
99
<xs:simpleType name="EmployeeID">
@@ -17,7 +17,7 @@ For example, the `Employee.xsd` schema contains the following annotation on the
1717
</xs:simpleType>
1818
```
1919

20-
Now if you open Employee.xml and select the Employee Id attribute you will see this annotation listed in the Dynamic
20+
Now, if you open Employee.xml and select the Employee Id attribute you will see this annotation listed in the Dynamic
2121
Help tab as follows:
2222

2323
![annotations](../assets/images/annotations.png)

docs/help/fileassociation.md

+23-21
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,38 @@
11
## XML Notepad File Association
22

3-
See the following video that shows how to associate XML Notepad with various .xml file types:
3+
Watch the following video tutorial to learn how to associate XML Notepad with various .xml file types:
44

5-
[Youtube Video](https://youtu.be/n-6sSUSlN34)
5+
[YouTube Video](https://youtu.be/n-6sSUSlN34)
66

7-
The general approach that works is to do the following:
7+
Here's a step-by-step guide:
88

9-
1. Open the XML Notepad that you installed already.
10-
2. Select Help/Open Sample... and select "Hamlet.xml"
11-
3. You will see a long file path in the address bar like this:
9+
1. Open XML Notepad, which you have already installed.
10+
2. Navigate to Help > Open Sample... and select "Hamlet.xml".
11+
3. Note the long file path displayed in the address bar, such as:
1212

13-
> C:\Program Files\WindowsApps\43906ChrisLovett.XmlNotepad_2.9.0.5_neutral__hndwmj480pefj\Application\Samples\Hamlet.xml
13+
```
14+
C:\Program Files\WindowsApps\43906ChrisLovett.XmlNotepad_2.9.0.5_neutral__hndwmj480pefj\Application\Samples\Hamlet.xml
15+
```
1416

1517
If you open this path in Windows Explorer you can locate XmlNotepad.exe here:
16-
17-
> C:\Program Files\WindowsApps\43906ChrisLovett.XmlNotepad_2.9.0.5_neutral__hndwmj480pefj\Application\XmlNotepad.exe
18-
18+
```
19+
C:\Program Files\WindowsApps\43906ChrisLovett.XmlNotepad_2.9.0.5_neutral__hndwmj480pefj\Application\XmlNotepad.exe
20+
```
1921
Copy this path to the clipboard.
2022

21-
Now use the start menu to find the "Default apps" settings dialog.
22-
23-
Enter the file type at the top (e.g. type in ".xsd" or ".xslt"), then click the button labelled `+ Choose a default`.
24-
25-
Scroll to the bottom of this dialog and click `Choose an app on your PC`
26-
27-
And paste in the path you coped to the clipboard earlier. Click `Open` then click `Set Default`.
23+
Now, follow these steps:
24+
- Open the "Default apps" settings dialog using the start menu.
25+
- Enter the file type at the top (e.g., type in ".xsd" or ".xslt").
26+
- Click the button labeled `+ Choose a default`.
27+
- Scroll to the bottom of this dialog and click `Choose an app on your PC`.
28+
- Paste in the path you copied to the clipboard earlier.
29+
- Click `Open`, then click `Set Default`.
2830

29-
As soon as you do this the icon on the file type you associated should change in Windows Explorer showing the XML
30-
Notepad icon and when you double click the file it will automatically open XML Notepad.
31+
As soon as you do this, the icon on the file type you associated should change in Windows Explorer showing the XML
32+
Notepad icon, and when you double click the file, it will automatically open XML Notepad.
3133

3234
Note that when you have done one extension, all the other extensions are much easier because XML Notepad will now show
3335
up in the list of possible apps to choose.
3436

35-
The path you have registered here is version specific so you may have to repeat this process when you install new
36-
versions of XML Notepad.
37+
Keep in mind that the path you have registered here is version specific, so you may have to repeat this process when you
38+
install new versions of XML Notepad.

docs/help/find.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11

22
## Find/Replace
33

4-
The "Find..." item under the [Edit Menu](menus.md) (CTRL+F) brings up the following dialog:
4+
Selecting the "Find..." item under the [Edit Menu](menus.md) (CTRL+F) opens the following dialog:
55

66
![Find](../assets/images/find.png)
77

8-
The "Replace..." item under the [Edit Menu](menus.md) (CTRL+H) changes this dialog to show the extra replace fields:
8+
Choosing "Replace..." item under the [Edit Menu](menus.md) (CTRL+H) modifies this dialog to display additional replace
9+
fields:
910

1011
![Find](../assets/images/replace.png)
1112

12-
By default this dialog will allow you to search "Everything" in the current XML document with a given find string. You
13-
can limit the search in the following ways:
13+
By default this dialog will allow you to search "Everything" in the current XML document with a specified find string.
14+
You can refine the search using the following options:
1415

15-
**Match case**: This will only find nodes that contain the exact search string in the same case.
16+
**Match case**: Only find nodes that contain the exact search string in the same case.
1617

17-
**Match whole word**: this will only find nodes that contain the search string as a complete word, i.e., not a
18+
**Match whole word**: Only find nodes that contain the search string as a complete word, i.e., not a
1819
substring.
1920

20-
**Use Regular Expressions**: this will treat the find string as a regular expression. See .NET regular expressions for
21+
**Use Regular Expressions**: Treats the find string as a regular expression. See .NET regular expressions for
2122
help with the regular expression language.
2223

23-
**Use XPath**: this option allows you to find nodes using an XPath expression. When you choose this option an extra
24-
table appears where you can edit the namespace prefix mappings used in the XPath expression. See [XPath
24+
**Use XPath**: Allows you to find nodes using an XPath expression. Choosing this option reveals an extra table
25+
where you can edit the namespace prefix mappings used in the XPath expression. See [XPath
2526
Syntax](https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-4.0/ms256471(v=vs.100)?redirectedfrom=MSDN)
2627
for help with the XPath expression language.
2728

2829
![Find](../assets/images/findxpath.png)
2930

30-
**Search Filter**: this option allows you to limit the search to just "Names" which means only search node names, or
31+
**Search Filter**: Limits the search to just "Names" which means only search node names, or
3132
"Text" which means only search node values, or "Comments" which means only search comment nodes.
3233

33-
**Direction**: this allows you to search backwards from the current location in the document ("Up") or forwards
34-
("Down").
34+
**Direction**: Determines the search direction: "Up" (backwards from the current location) or "Down" (forwards).
3535

36-
**Find Next**: this button finds the next matching node in the specified direction after the currently selected node and
37-
it highlights the matching substring within the node name or value.
36+
**Find Next**: Finds the next matching node in the specified direction after the currently selected node and
37+
highlights the matching substring within the node name or value.
3838

39-
**Replace**: this button finds the next matching node in the specified direction after the currently selected node and
40-
if it finds something it replaces it with the replace text.
39+
**Replace**: Finds the next matching node in the specified direction after the currently selected node and
40+
replaces it with the specified replace text.
4141

42-
**Replace All**: this button replaces all matching text with the replace text.
42+
**Replace All**: Replaces all matching text with the specified replace text.

0 commit comments

Comments
 (0)