Skip to content

Commit

Permalink
Final updates for 5.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@hbowie
hbowie committed Feb 13, 2021
1 parent f6f290d commit 20618c4
Show file tree
Hide file tree
Showing 17 changed files with 218 additions and 109 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Expand Up @@ -4,3 +4,4 @@ Notenik Help/includes/
.DS_Store
/Notenik.xcodeproj/project.xcworkspace/xcuserdata/hbowie.xcuserdatad/UserInterfaceState.xcuserstate
WorkspaceSettings.xcsettings
/Notenik.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
23 changes: 23 additions & 0 deletions ...k Help/Notenik.help/Contents/Resources/en.lproj/seq-.1-tailor-collection-preferences.html
View file
@@ -0,0 +1,23 @@
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Tailor Collection Preferences</title>
<meta name="KEYWORDS" content="collection, prefs">
</head>
<body class="Aside apd-topic" dir="ltr" id="seq-.1-tailor-collection-preferences" data-istaskopen="false">
<a name="seq-.1-tailor-collection-preferences"></a>
<h1>
Tailor Collection Preferences
</h1>
<p>In some cases, you will be presented with the Preferences for your Collection immediately after creating it. </p>
<p>But you can always access these Preferences later by selecting <code>Preferences&#8230;</code> beneath the <code>Collection</code> menu. </p>
<p>(Note that these are different from the Application preferences, found beneath the <code>Notenik</code> menu. The Application Preferences apply globally to all of your Collections.) </p>
<p>The first tab in the Collection Preferences allows you to tweak the Collection Title, the file extension used for Notes, and a few other settings. </p>
<p>The default Collections Title will be formed from the folder path containing this Collection. Feel free to tweak this title, but understand that this will not change the actual name of the folder in which your Notes are stored. </p>
<p>Each Note file is an ordinary text file, and can be opened using any text editor, in addition to being editable within Notenik. Depending on what application you might wish to be the default text editor for your notes, you may wish to pick some special file extension to be used. (If you don't care about this, or this doesn't make any sense to you, then feel free to just ignore this whole paragraph and leave the Preferred File Extension set to the normal default of <code>txt</code>.) </p>
<p>The second tab allows you to choose the fields you would like to include in the Collection. Feel free to check additional ones if they seem useful to you. </p>
<p>If you would like to further customize the list of fields for a Collection, read how to <a href="https://ntnk.app/overridedefaultfieldswithatemplatefile">Override Default Fields with a Template file</a>, consulting the online article on <a href="https://notenik.net/articles/field-labels-and-types.html">Field Labels and Types</a> as necessary. </p>

<p>Next Topic: <a href="seq-.2-display-a-note.html">Display a Note</a></p>
</body>
</html>
26 changes: 26 additions & 0 deletions Notenik Help/Notenik.help/Contents/Resources/en.lproj/seq-.2-display-a-note.html
View file
@@ -0,0 +1,26 @@
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Display a Note</title>
<meta name="KEYWORDS" content="display, prefs">
</head>
<body class="Aside apd-topic" dir="ltr" id="seq-.2-display-a-note" data-istaskopen="false">
<a name="seq-.2-display-a-note"></a>
<h1>
Display a Note
</h1>
<p>The Display tab shows you what your Note looks like. Your note is formatted as a web page, and displayed within Notenik using a built-in web browser. If you click on a hyperlink within the display, then the linked page will replace your Note. If you wish to get back to your Note, then click on the Refresh button in the Toolbar. If your Note has a Link value, then click on the Launch Link button in the Toolbar to see the linked page within your default web browser, instead of Notenik's internal browser. </p>
<p>You can alter the typeface and font size used on the Display tab by selecting the Display Appearance item under the Format menu, or by clicking on the Display Fonts button on the toolbar. You may then pick a typeface and font from the displayed dropdown menus or, if you'd like, enter the CSS you'd like to be used directly, bypassing the limits of these menus. The default font list only includes a relatively short list of common fonts; by checking the box to use the long list, showing all fonts, the user may select any font family available on your Mac. </p>
<p>The Collection Preferences contain a couple of options for changing the way a Note is formatted on the Display tab. </p>
<ul>
<li>
<p>Include explicit Body field label on the Display tab? - This is checked by default, but you can uncheck this option if you'd prefer the body to just show up without any header label. </p>
</li>
<li>
<p>Display Note Titles as Level 1 Headings? - The default is to display note titles as paragraphs with strong emphasis, but check this box if you'd prefer them to be displayed within <code>h1</code> tags. </p>
</li>
</ul>

<p>Next Topic: <a href="seq-06-add-delete-and-update-your-notes.html">Add, Delete and Update Your Notes</a></p>
</body>
</html>
11 changes: 6 additions & 5 deletions Notenik Help/Notenik.help/Contents/Resources/en.lproj/seq-01-table-of-contents.html
View file
Expand Up @@ -17,11 +17,12 @@ <h1>
<li><a href="#getting-started">Getting Started</a> <br />
3.1 <a href="#help-using-notenik">Help Using Notenik</a> <br />
3.2 <a href="#create-a-new-collection">Create a New Collection</a> <br />
3.3 <a href="#display-a-note">Display a Note</a> <br />
3.4 <a href="#add-delete-and-update-your-notes">Add, Delete and Update Your Notes</a> <br />
3.5 <a href="#view-your-notes-as-a-list">View Your Notes as a List</a> <br />
3.6 <a href="#search-for-one-or-more-notes-containing-specified-text">Search for One or More Notes Containing Specified Text</a> <br />
3.7 <a href="#view-the-log">View the Log</a> <br />
3.3 <a href="#tailor-collection-preferences">Tailor Collection Preferences</a> <br />
3.4 <a href="#display-a-note">Display a Note</a> <br />
3.5 <a href="#add-delete-and-update-your-notes">Add, Delete and Update Your Notes</a> <br />
3.6 <a href="#view-your-notes-as-a-list">View Your Notes as a List</a> <br />
3.7 <a href="#search-for-one-or-more-notes-containing-specified-text">Search for One or More Notes Containing Specified Text</a> <br />
3.8 <a href="#view-the-log">View the Log</a> <br />
</li>
<li><a href="#files-and-folders">Files and Folders</a> <br />
4.1 <a href="#each-note-is-its-own-text-file">Each Note is its own Text File</a> <br />
Expand Down
3 changes: 2 additions & 1 deletion Notenik Help/Notenik.help/Contents/Resources/en.lproj/seq-02-table-of-contents.html
View file
Expand Up @@ -14,7 +14,8 @@ <h1>
<li><a href="seq-03-getting-started.html">Getting Started</a></li>
<li><a href="seq-04-help-using-notenik.html">Help Using Notenik</a></li>
<li><a href="seq-05-create-a-new-collection.html">Create a New Collection</a></li>
<li><a href="seq-.1-display-a-note.html">Display a Note</a></li>
<li><a href="seq-.1-tailor-collection-preferences.html">Tailor Collection Preferences</a></li>
<li><a href="seq-.2-display-a-note.html">Display a Note</a></li>
<li><a href="seq-06-add-delete-and-update-your-notes.html">Add, Delete and Update Your Notes</a></li>
<li><a href="seq-07-view-your-notes-as-a-list.html">View Your Notes as a List</a></li>
<li><a href="seq-08-search-for-one-or-more-notes-containing-specified-text.html">Search for One or More Notes Containing Specified Text</a></li>
Expand Down
31 changes: 20 additions & 11 deletions Notenik Help/Notenik.help/Contents/Resources/en.lproj/seq-05-create-a-new-collection.html
View file
Expand Up @@ -9,25 +9,34 @@
<h1>
Create a New Collection
</h1>
<p>Beneath the File menu you will find three different options for creating a New Notenik Collection. </p>
<p>Beneath the File menu you will find several different options for creating a New Notenik Collection. </p>
<p>As a new user, it is recommended you start with the first option that appears, simply labeled <code>New Collection&#8230;</code>. </p>
<p>You will then see a window that will walk you through three different tabs. </p>
<ul>
<li>
<p><strong>New in iCloud&#8230;</strong> - When you select this option, you will be prompted only for a name for your new Collection. Assuming this name is not already in use, a folder with that name will be created for you within Notenik's special iCloud container. </p>
<p><code>Location</code> - Here you can specify whether you'd like your new Collection to be stored within Notenik's special iCloud container, or somewhere else. If unsure, the first option is the easiest. </p>
</li>
<li>
<p><strong>New Elsewhere&#8230;</strong> - When you select this option, you will first need to navigate to a location on your hard drive where you would like your new Collection to be stored, and then will need to create a new folder within that location. You will be presented with a standard Mac window for selecting a folder. Use the standard New Folder button in the lower left corner of this window to create an empty folder for your new Collection, then select that newly created folder (all within the same window) and hit the Open button. </p>
<p><code>Name</code> - Here you get to specify the name of your new Collection. This will become the name of the folder in which your notes will be stored. </p>
</li>
<li>
<p><strong>New Web Collection&#8230;</strong> - This option is similar to <code>New Elsewhere</code>, but will create a special Web Collection that can be used to mirror your Notes to HTML pages. </p>
<p><code>Fields</code> - Here you specify what sort of Notes Collection you would like. Different types of Collections will have different fields available for each Note. On this tab you can pick from one of several different options, starting with the simplest, and working towards more complex options. Pick the one that sounds closest to matching your intentions. Don't worry too much about making a mistake here, because you will be shown a couple of different ways of further customizing your Collection a little farther on. </p>
</li>
</ul>
<p>If you are just getting started with Notenik, and not sure which option to choose, then <code>New in iCloud</code> will be your best bet. </p>
<p>The next thing you will see is a window allowing you to specify certain attributes for your new Collection. </p>
<p>The Collections Title will be formed from the folder path containing this Collection. Feel free to tweak this if you'd like. </p>
<p>Each Note file is an ordinary text file, and can be opened using any text editor, in addition to being editable within Notenik. Depending on what application you might wish to be the default text editor for your notes, you may wish to pick some special file extension to be used. If you don't care about this, or this doesn't make any sense to you, then feel free to just ignore this whole paragraph and leave the Preferred File Extension set to txt. </p>
<p>Next select the fields you would like to be made part of each Note. Every Note must have a Title and a Body, and the Tags and Link fields are commonly used, but feel free to use the checkboxes to select whatever other fields might be useful to you. </p>
<p>When you're done with this screen, click OK to continue, and you'll see your first Note! </p>
<p>Once you become a little more familiar with the way Notenik works, you may want to go straight to one of the later options for creating a new Collection. </p>
<ul>
<li>
<p><code>New in iCloud&#8230;</code> - When you select this option, you will be prompted only for a name for your new Collection. Assuming this name is not already in use, a folder with that name will be created for you within Notenik's special iCloud container. </p>
</li>
<li>
<p><code>New Elsewhere&#8230;</code> - When you select this option, you will first need to navigate to a location on your hard drive where you would like your new Collection to be stored, and then will need to create a new folder within that location. You will be presented with a standard Mac window for selecting a folder. Use the standard New Folder button in the lower left corner of this window to create an empty folder for your new Collection, then select that newly created folder (all within the same window) and hit the Open button. </p>
</li>
<li>
<p><code>New Web Collection&#8230;</code> - This option is similar to <code>New Elsewhere</code>, but will create a special Web Collection that can be used to mirror your Notes to HTML pages. </p>
</li>
</ul>
<p>No matter which route you choose, you will later be able to <a href="https://ntnk.app/tailorcollectionpreferences">Tailor Collection Preferences</a> &#8211; including the list of fields supported within your Collection. </p>

<p>Next Topic: <a href="seq-.1-display-a-note.html">Display a Note</a></p>
<p>Next Topic: <a href="seq-.1-tailor-collection-preferences.html">Tailor Collection Preferences</a></p>
</body>
</html>
7 changes: 7 additions & 0 deletions Notenik Help/Notenik.help/Contents/Resources/en.lproj/seq-53-version-history.html
View file
Expand Up @@ -9,6 +9,13 @@
<h1>
Version History
</h1>
<h3 id="version-5.6.0-11-feb-2021">Version 5.6.0 | 11 Feb 2021</h3>
<h4 id="added-a-sort-option-for-date-added">1. Added a Sort Option for Date Added</h4>
<p>Added an option to sort a list in sequence by date added. </p>
<h4 id="simplified-means-of-creating-a-new-collection">2. Simplified Means of Creating a New Collection</h4>
<p>There is a new option beneath the File menu that simply prompts the user to create a New Collection. Selecting this option brings up a tabbed window that walks the user through three steps: selecting a parent folder; naming the Collection; and choosing a Collection Type (which in turn implies a set of fields). </p>
<h4 id="changing-of-file-extensions-enabled">3. Changing of File Extensions Enabled</h4>
<p>When you change the Preferred File Extension for a Collection, by modifying the Collection Preferences, Notenik will now change the file extensions for all the Notes in the Collection to the new value, instead of only changing the extension of the template file. </p>
<h3 id="version-5.5.0-02-feb-2021">Version 5.5.0 | 02 Feb 2021</h3>
<h4 id="enabled-open-link-in-new-window-for-all-hyperlinks-on-the-display-tab">1. Enabled Open Link in New Window for all hyperlinks on the Display Tab</h4>
<p>By using a Secondary Click (otherwise known as a right-click or a control-click) on a hyperlink showing on the Display tab, the user can see a contextual (aka shortcut) menu with the option to <code>Open Link in New Window</code>. Before this change, selecting this option did nothing. It will now attempt to pass the link to your preferred Web browser, requesting that it be opened there. </p>
Expand Down
11 changes: 6 additions & 5 deletions Notenik Help/notes/Table of Contents.text
View file
Expand Up @@ -16,11 +16,12 @@ Body:
<li><a href="#getting-started">Getting Started</a> <br />
3.1 <a href="#help-using-notenik">Help Using Notenik</a> <br />
3.2 <a href="#create-a-new-collection">Create a New Collection</a> <br />
3.3 <a href="#display-a-note">Display a Note</a> <br />
3.4 <a href="#add-delete-and-update-your-notes">Add, Delete and Update Your Notes</a> <br />
3.5 <a href="#view-your-notes-as-a-list">View Your Notes as a List</a> <br />
3.6 <a href="#search-for-one-or-more-notes-containing-specified-text">Search for One or More Notes Containing Specified Text</a> <br />
3.7 <a href="#view-the-log">View the Log</a> <br />
3.3 <a href="#tailor-collection-preferences">Tailor Collection Preferences</a> <br />
3.4 <a href="#display-a-note">Display a Note</a> <br />
3.5 <a href="#add-delete-and-update-your-notes">Add, Delete and Update Your Notes</a> <br />
3.6 <a href="#view-your-notes-as-a-list">View Your Notes as a List</a> <br />
3.7 <a href="#search-for-one-or-more-notes-containing-specified-text">Search for One or More Notes Containing Specified Text</a> <br />
3.8 <a href="#view-the-log">View the Log</a> <br />
</li>
<li><a href="#files-and-folders">Files and Folders</a> <br />
4.1 <a href="#each-note-is-its-own-text-file">Each Note is its own Text File</a> <br />
Expand Down
7 changes: 6 additions & 1 deletion Notenik Help/notes/Tailor Collection Preferences.text
View file
Expand Up @@ -2,8 +2,14 @@ Title: Tailor Collection Preferences

Tags: collection, prefs

Timestamp: 20210211221900

Seq: 5.1

Level: 3

Date Added: 2021-02-11 14:19:00 -0800

Body:

In some cases, you will be presented with the Preferences for your Collection immediately after creating it.
Expand All @@ -21,4 +27,3 @@ Each Note file is an ordinary text file, and can be opened using any text editor
The second tab allows you to choose the fields you would like to include in the Collection. Feel free to check additional ones if they seem useful to you.

If you would like to further customize the list of fields for a Collection, read how to [[Override Default Fields with a Template file]], consulting the online article on [Field Labels and Types](https://notenik.net/articles/field-labels-and-types.html) as necessary.

17 changes: 17 additions & 0 deletions Notenik Help/notes/Version History.text
View file
Expand Up @@ -8,6 +8,23 @@ Tags: changes, versions, history, log

Body:

### Version 5.6.0 | 11 Feb 2021

#### 1. Added a Sort Option for Date Added

Added an option to sort a list in sequence by date added.


#### 2. Simplified Means of Creating a New Collection

There is a new option beneath the File menu that simply prompts the user to create a New Collection. Selecting this option brings up a tabbed window that walks the user through three steps: selecting a parent folder; naming the Collection; and choosing a Collection Type (which in turn implies a set of fields).


#### 3. Changing of File Extensions Enabled

When you change the Preferred File Extension for a Collection, by modifying the Collection Preferences, Notenik will now change the file extensions for all the Notes in the Collection to the new value, instead of only changing the extension of the template file.


### Version 5.5.0 | 02 Feb 2021

#### 1. Enabled Open Link in New Window for all hyperlinks on the Display Tab
Expand Down
2 changes: 1 addition & 1 deletion Notenik Help/notes/alias.txt
View file
@@ -1,6 +1,6 @@
Title ID Timestamp
openparentrealm 20191107014754
tailorcollectionpreferences 20210211221900
overview 20200215001940
notenikicloudcontainer 20200507224011
openparentrealm 20191107014754
overridedefaultfieldswithatemplatefile 20191210005646

0 comments on commit 20618c4

Please sign in to comment.