middlemac 3.0.0 → 3.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 31fee728bef8cc15a8f5fccde7b2fbefc66d918d
4
- data.tar.gz: fffd42f0b926640d7863283438f4f31d53ce212d
3
+ metadata.gz: 7317b985a597b76832c31022f3b9fe89ed88e59b
4
+ data.tar.gz: 20edec01a9b12076dcef9149994305a015c835b4
5
5
  SHA512:
6
- metadata.gz: 68f9a4dc8fbf2d3c00c4066c2d22c5dba2b06c6fbe2b853b8d060af9ad02ec7f038aaa7674beb2008466f5a8cc81ff5f7961db391f0ce1b7bcc77b475d01af7a
7
- data.tar.gz: 895b99f44d41673ccab7bf4de1b23fb5a6b6d1c80cd67c9bbee8b93e1607f43acd9dc447f0eed1f843b61d34eba7b59068ff1e4e4024e52f8ff97a0e2c2b8d04
6
+ metadata.gz: 139c7f24a3c4da6f58a8dc8ea5bd5ab726ea94dd646b868e690d098b11cf9af35957bccfccae6acf753bee26db227751439b5d8c2d42c06956589a3cb42f0af5
7
+ data.tar.gz: cffd0b71199a96fa1df3d329c2f05f0eb841d2bfa7adf4d4aceec587784e5a1de5b3e6e6656509d5068a32bb3cb5ad57c1f497488637c443444b6b67d9eaddad
data/CHANGELOG.md CHANGED
@@ -1,24 +1,27 @@
1
1
  middlemac change log
2
2
  ====================
3
3
 
4
- - Version 3.0.0 / 2018-June-18
4
+ - Version 3.0.1 / 2019-September-08
5
5
 
6
- - Major update to Middlemac to support modern macOS Help Books. Middlemac
7
- now builds Help Books that take advantage of Apple’s “Eagle” framework for
8
- providing a consistent look and feel across Help Books, and provides neat
9
- browser-based features such as search and language switching.
6
+ - Updated documentation.
7
+ - Added redirect files, and updated tests.
8
+ - Fix YAML parsing issue for picky parsers.
9
+ - Version bump.
10
+ - All new Middlemac 3.0.
11
+ - Git Commit Issues Fix
12
+ - Ensure that build.sh is captured in version control.
13
+ - Added blank build.sh. Todo is recreate this. Sorry.
10
14
 
11
15
  - Version 2.0.0 / 2016-May-15
12
16
 
17
+ - Touchup changelog, and release gem.
13
18
  - All new Middlemac version 2.0.0!
14
19
  - _Significant_, major upgrade to _Middlemac_.
15
20
  - Now packaged as a real Ruby gem.
16
21
  - Uses the latest Middleman 4.1 series (4.1.7 or newer required).
17
22
  - This version _will_ break old projects.
18
23
  - Read the full documentation to understand the full scope of changes.
19
-
20
- - Previous
21
- - Updated to newer middleman.
24
+ - - Updated to newer middleman.
22
25
  - Use font-awesome-sass gem instead of keeping it in the file system.
23
26
  - Fixed 256x256 image file.
24
27
  - Added built output. RC1
@@ -41,10 +44,3 @@ middlemac change log
41
44
  - README, getting started.
42
45
  - Overhaul of helpers and sitemap manipulators complete.
43
46
  - BRETHREN checkpoint
44
- - Continued refactoring resources.
45
- - Begin refactor helpers to methods.
46
- - Topical content.
47
- - Bug-proofing.
48
- - Added topical content.
49
- - Removed conflicting LESS stuff.
50
- - More content.
@@ -7,7 +7,7 @@
7
7
  <key>CFBundleName</key>
8
8
  <string><%= cfBundleName %></string>
9
9
  <key>HPDBookAccessPath</key>
10
- <string>index.html</string>
10
+ <string>index_hpd.html</string>
11
11
  <key>HPDBookIndexPath</key>
12
12
  <string><%= cfBundleName %>.helpindex</string>
13
13
  <key>HPDBookTitle</key>
@@ -0,0 +1,14 @@
1
+ !!!
2
+ %html{:lang => "#{current_page.hb_locale}"}
3
+ %head
4
+ :javascript
5
+ window.location.href = "./index.html";
6
+ %meta{:charset => 'UTF-8'}
7
+ %meta{:name => 'robots', :content => 'noindex'}
8
+ %meta{:'http-equiv' => 'refresh', :content => "0;url=./index.html" }
9
+ %title= current_page.data.title || "#{product_name} Help"
10
+ %body
11
+
12
+ -#
13
+ This layout should be used for pages with no content, such as the index.html
14
+ pages used as group metadata containers.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Preview and Build your Help Books
3
- blurb: Your development be quicker by previewing your work with
3
+ blurb: >
4
+ Your development be quicker by previewing your work with
4
5
  <em>Middleman</em>’s preview server before the next step:
5
6
  building your Help Book.
6
7
  ---
@@ -128,6 +128,13 @@ blurb: Let us examine all of the files and folders in a standard
128
128
  metadata `index.html` files.
129
129
 
130
130
 
131
+ `your_project/Contents/Resources/SharedGlobalAssets/_layouts/layout-hpd.haml`
132
+
133
+ : This is a layout used by `index_hpd.html` files at the root level of each of
134
+ your languages, and simply causes a redirect to the proper `index.html` file
135
+ in that directory.
136
+
137
+
131
138
  `your_project/Contents/Resources/SharedGlobalAssets/_partials/`
132
139
 
133
140
  : Partials can go here, and should be prefaced with an underscore so that
@@ -213,6 +220,15 @@ blurb: Let us examine all of the files and folders in a standard
213
220
  pages’ frontmatter. See [Apple’s documentation][1] for details.
214
221
 
215
222
 
223
+ `your_project/Contents/Resources/en.lproj/index_hpd.html.md.erb`
224
+
225
+ : This is the file pointed to by the `Info.plist` key `HPDBookAccessPath`,
226
+ and simply redirects to the language’s actual `index.html` file in the built
227
+ project. This is required to avoid conflicts with recent versions of macOS
228
+ wherein **Help Viewer** gets confused when there are multiple `index.html`
229
+ files in both the language level and the `/Resources` directory.
230
+
231
+
216
232
  `your_project/Contents/Resources/en.lproj/InfoPlist.strings`
217
233
 
218
234
  : The `InfoPlist.strings` file is the file that _Middlemac_ will process into
@@ -257,4 +273,4 @@ blurb: Let us examine all of the files and folders in a standard
257
273
  {: .nontabular}
258
274
 
259
275
 
260
- [1]: https://developer.apple.com/library/archive/documentation/Carbon/Conceptual/ProvidingUserAssitAppleHelp/authoring_help/authoring_help_book.html#//apple_ref/doc/uid/TP30000903-CH206-SW5
276
+ [1]: https://developer.apple.com/library/archive/documentation/Carbon/Conceptual/ProvidingUserAssitAppleHelp/authoring_help/authoring_help_book.html#//apple_ref/doc/uid/TP30000903-CH206-SW5
@@ -0,0 +1,4 @@
1
+ ---
2
+ title: HPD redirector
3
+ layout: layout-hpd
4
+ ---
@@ -0,0 +1,4 @@
1
+ ---
2
+ title: HPD redirector
3
+ layout: layout-hpd
4
+ ---
@@ -17,7 +17,7 @@ source 'https://rubygems.org'
17
17
  #######################################
18
18
  # Middlemac, natch.
19
19
  #######################################
20
- gem 'middlemac', '~> 3.0.0'
20
+ gem 'middlemac', '~> 3.0.1'
21
21
  gem 'middleman-targets', '~> 1.0.12'
22
22
 
23
23
 
@@ -42,7 +42,7 @@ Feature: Middlemac produces plist and strings files, uses correct HTML formats,
42
42
  And the file "testing_world_file.html" should contain "com.sample.project.pro.help"
43
43
  And the file "testing_world_file.html" should contain "New Project"
44
44
  And the file "testing_world_file.html" should contain "New Project Pro"
45
- And the file "testing_world_file.html" should contain "3.0.0.wip"
45
+ And the file "testing_world_file.html" should contain "3.0.1"
46
46
  And the file "testing_world_file.html" should contain "http://www.sample.com"
47
47
  And the file "testing_world_file.html" should contain "_new_style_partial"
48
48
  And the file "testing_world_file.html" should contain "_partials_dir_partial"
@@ -7,7 +7,7 @@
7
7
  <key>CFBundleName</key>
8
8
  <string><%= cfBundleName %></string>
9
9
  <key>HPDBookAccessPath</key>
10
- <string>index.html</string>
10
+ <string>index_hpd.html</string>
11
11
  <key>HPDBookIndexPath</key>
12
12
  <string><%= cfBundleName %>.helpindex</string>
13
13
  <key>HPDBookTitle</key>
@@ -0,0 +1,14 @@
1
+ !!!
2
+ %html{:lang => "#{current_page.hb_locale}"}
3
+ %head
4
+ :javascript
5
+ window.location.href = "./index.html";
6
+ %meta{:charset => 'UTF-8'}
7
+ %meta{:name => 'robots', :content => 'noindex'}
8
+ %meta{:'http-equiv' => 'refresh', :content => "0;url=./index.html" }
9
+ %title= current_page.data.title || "#{product_name} Help"
10
+ %body
11
+
12
+ -#
13
+ This layout should be used for pages with no content, such as the index.html
14
+ pages used as group metadata containers.
@@ -0,0 +1,4 @@
1
+ ---
2
+ title: HPD redirector
3
+ layout: layout-hpd
4
+ ---
@@ -0,0 +1,4 @@
1
+ ---
2
+ title: HPD redirector
3
+ layout: layout-hpd
4
+ ---
@@ -17,7 +17,7 @@ source 'https://rubygems.org'
17
17
  #######################################
18
18
  # Middlemac, natch.
19
19
  #######################################
20
- gem 'middlemac', '~> 3.0.0'
20
+ gem 'middlemac', '~> 3.0.1'
21
21
  gem 'middleman-targets', '~> 1.0.12'
22
22
 
23
23
 
@@ -94,7 +94,7 @@ config[:targets] = {
94
94
  :HPDBookIconPath => nil,
95
95
  :CFBundleName => 'New Project',
96
96
  :ProductName => 'New Project',
97
- :ProductVersion => version_app || '3.0.0',
97
+ :ProductVersion => version_app || '3.0.1',
98
98
  :ProductURI => 'http://www.sample.com',
99
99
  :ProductCopyright => '© 2018 Jim Derry. All rights reserved.',
100
100
  :features =>
@@ -112,7 +112,7 @@ config[:targets] = {
112
112
  :HPDBookIconPath => nil,
113
113
  :CFBundleName => 'New Project',
114
114
  :ProductName => 'New Project Pro',
115
- :ProductVersion => version_app || '3.0.0',
115
+ :ProductVersion => version_app || '3.0.1',
116
116
  :ProductURI => 'http://www.sample.com',
117
117
  :ProductCopyright => '© 2018 Jim Derry. All rights reserved.',
118
118
  :features =>
@@ -1,5 +1,5 @@
1
1
  module Middleman
2
2
  module Middlemac
3
- VERSION = '3.0.0'
3
+ VERSION = '3.0.1'
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: middlemac
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.0
4
+ version: 3.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jim Derry
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-06-18 00:00:00.000000000 Z
11
+ date: 2019-09-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: middleman-core
@@ -211,6 +211,7 @@ files:
211
211
  - documentation_project/Contents/Resources/SharedGlobalAssets/_layouts/layout-apple-modern-aside.haml
212
212
  - documentation_project/Contents/Resources/SharedGlobalAssets/_layouts/layout-apple-modern.haml
213
213
  - documentation_project/Contents/Resources/SharedGlobalAssets/_layouts/layout-blank.haml
214
+ - documentation_project/Contents/Resources/SharedGlobalAssets/_layouts/layout-hpd.haml
214
215
  - documentation_project/Contents/Resources/SharedGlobalAssets/_partials/_yard_middlemac_config.erb
215
216
  - documentation_project/Contents/Resources/SharedGlobalAssets/_partials/_yard_middlemac_helpers.erb
216
217
  - documentation_project/Contents/Resources/SharedGlobalAssets/_partials/_yard_middlemac_helpers_extended.erb
@@ -385,12 +386,14 @@ files:
385
386
  - documentation_project/Contents/Resources/en.lproj/assets/images/xcode_integration_target_template.png
386
387
  - documentation_project/Contents/Resources/en.lproj/assets/images/xcode_integration_tool_configuration.png
387
388
  - documentation_project/Contents/Resources/en.lproj/index.html.md.erb
389
+ - documentation_project/Contents/Resources/en.lproj/index_hpd.html.md.erb
388
390
  - documentation_project/Contents/Resources/en.lproj/locale-info.json.erb
389
391
  - documentation_project/Contents/Resources/en.lproj/navigation.json.erb
390
392
  - documentation_project/Contents/Resources/en.lproj/searchTree.json.erb
391
393
  - documentation_project/Contents/Resources/es.lproj/ExactMatch.plist.erb
392
394
  - documentation_project/Contents/Resources/es.lproj/InfoPlist.strings.erb
393
395
  - documentation_project/Contents/Resources/es.lproj/index.html.md.erb
396
+ - documentation_project/Contents/Resources/es.lproj/index_hpd.html.md.erb
394
397
  - documentation_project/Contents/Resources/es.lproj/locale-info.json.erb
395
398
  - documentation_project/Contents/Resources/es.lproj/navigation.json.erb
396
399
  - documentation_project/Contents/Resources/es.lproj/searchTree.json.erb
@@ -431,6 +434,7 @@ files:
431
434
  - fixtures/middlemac_app/Contents/Resources/SharedGlobalAssets/_layouts/layout-apple-modern-aside.haml
432
435
  - fixtures/middlemac_app/Contents/Resources/SharedGlobalAssets/_layouts/layout-apple-modern.haml
433
436
  - fixtures/middlemac_app/Contents/Resources/SharedGlobalAssets/_layouts/layout-blank.haml
437
+ - fixtures/middlemac_app/Contents/Resources/SharedGlobalAssets/_layouts/layout-hpd.haml
434
438
  - fixtures/middlemac_app/Contents/Resources/SharedGlobalAssets/_partials/_partials_dir_partial.erb
435
439
  - fixtures/middlemac_app/Contents/Resources/SharedGlobalAssets/convention/icon-webclip-120x120.png
436
440
  - fixtures/middlemac_app/Contents/Resources/SharedGlobalAssets/convention/icon-webclip-152x152.png
@@ -526,6 +530,7 @@ files:
526
530
  - fixtures/middlemac_app/Contents/Resources/en.lproj/assets/images/subdirectory/pro-image_32x32.png
527
531
  - fixtures/middlemac_app/Contents/Resources/en.lproj/copyright.html.md.erb
528
532
  - fixtures/middlemac_app/Contents/Resources/en.lproj/index.html.md.erb
533
+ - fixtures/middlemac_app/Contents/Resources/en.lproj/index_hpd.html.md.erb
529
534
  - fixtures/middlemac_app/Contents/Resources/en.lproj/locale-info.json.erb
530
535
  - fixtures/middlemac_app/Contents/Resources/en.lproj/navigation.json.erb
531
536
  - fixtures/middlemac_app/Contents/Resources/en.lproj/searchTree.json.erb
@@ -539,6 +544,7 @@ files:
539
544
  - fixtures/middlemac_app/Contents/Resources/es.lproj/assets/images/subdirectory/pro-image_32x32.png
540
545
  - fixtures/middlemac_app/Contents/Resources/es.lproj/copyright.html.md.erb
541
546
  - fixtures/middlemac_app/Contents/Resources/es.lproj/index.html.md.erb
547
+ - fixtures/middlemac_app/Contents/Resources/es.lproj/index_hpd.html.md.erb
542
548
  - fixtures/middlemac_app/Contents/Resources/es.lproj/locale-info.json.erb
543
549
  - fixtures/middlemac_app/Contents/Resources/es.lproj/navigation.json.erb
544
550
  - fixtures/middlemac_app/Contents/Resources/es.lproj/searchTree.json.erb