j1-template 2021.0.16 → 2021.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (307) hide show
  1. checksums.yaml +4 -4
  2. data/_includes/themes/j1/blocks/footer/boxes/legal_statements.proc +4 -0
  3. data/_includes/themes/j1/modules/connectors/ad/google-adsense.html +1 -1
  4. data/_includes/themes/j1/modules/connectors/ads +1 -1
  5. data/_includes/themes/j1/modules/connectors/analytic/google-analytics-legacy.html +36 -0
  6. data/_includes/themes/j1/modules/connectors/analytic/google-analytics.html +1 -1
  7. data/_includes/themes/j1/modules/connectors/analytics +2 -3
  8. data/_includes/themes/j1/modules/connectors/comment/disqus.html +1 -1
  9. data/_layouts/default.html +11 -1
  10. data/assets/data/galleries.json +2 -2
  11. data/assets/data/gallery_customizer.html +2 -2
  12. data/assets/themes/j1/adapter/js/asciidoctor.js +166 -0
  13. data/assets/themes/j1/adapter/js/carousel.js +24 -0
  14. data/assets/themes/j1/adapter/js/fam.js +0 -12
  15. data/assets/themes/j1/adapter/js/j1.js +36 -21
  16. data/assets/themes/j1/adapter/js/{jf_gallery.js → justifiedGallery.js} +9 -9
  17. data/assets/themes/j1/adapter/js/{gallery_customizer.js → justifiedGalleryCustomizer.js} +11 -11
  18. data/assets/themes/j1/adapter/js/logger.js +35 -23
  19. data/assets/themes/j1/adapter/js/navigator.js +0 -12
  20. data/assets/themes/j1/core/css/vendor.css +14 -2
  21. data/assets/themes/j1/core/css/vendor.min.css +1 -1
  22. data/assets/themes/j1/core/js/template.js +8 -2
  23. data/assets/themes/j1/core/js/template.js.map +1 -1
  24. data/assets/themes/j1/core/js/template.min.js +8 -2
  25. data/assets/themes/j1/core/js/template.min.js.map +1 -1
  26. data/assets/themes/j1/modules/log4javascript/docs/backwardsincompatibilities.html +90 -0
  27. data/assets/themes/j1/modules/log4javascript/docs/distribution.html +87 -0
  28. data/assets/themes/j1/modules/log4javascript/docs/index.html +190 -0
  29. data/assets/themes/j1/modules/log4javascript/docs/lite.html +182 -0
  30. data/assets/themes/j1/modules/log4javascript/docs/manual.html +3217 -0
  31. data/assets/themes/j1/modules/log4javascript/docs/manual_lite.html +383 -0
  32. data/assets/themes/j1/modules/log4javascript/docs/quickstart.html +230 -0
  33. data/assets/themes/j1/modules/log4javascript/docs/whatsnew.html +86 -0
  34. data/assets/themes/j1/modules/log4javascript/js/log4javascript.js +5826 -0
  35. data/assets/themes/j1/modules/{util/js/log4javascript.js → log4javascript/js/log4javascript.min.js} +17 -0
  36. data/exe/j1 +1 -1
  37. data/lib/j1/commands/generate.rb +32 -9
  38. data/lib/{patches/rubygems/eventmachine-1.2.7-x64-mingw32/lib/2.6 → j1/patches/rubygems/eventmachine-1.2.7-x64-mingw32/lib/2.7}/fastfilereaderext.so +0 -0
  39. data/lib/{patches/rubygems/eventmachine-1.2.7-x64-mingw32/lib/2.6 → j1/patches/rubygems/eventmachine-1.2.7-x64-mingw32/lib/2.7}/rubyeventmachine.so +0 -0
  40. data/lib/j1/patches/rubygems/execjs-2.7.0/lib/execjs/external_runtime.rb +246 -0
  41. data/lib/j1/version.rb +1 -1
  42. data/lib/j1_app.rb +1 -1
  43. data/lib/j1_app/j1_auth_manager/auth_manager.rb +8 -2
  44. data/lib/j1_app/j1_site_manager/static_site.no-cross-origin.rb +94 -0
  45. data/lib/j1_app/j1_site_manager/static_site.rb +13 -11
  46. data/lib/starter_web/Gemfile +20 -14
  47. data/lib/starter_web/_config.yml +6 -47
  48. data/lib/starter_web/_data/_defaults/j1_config.yml +460 -0
  49. data/lib/starter_web/_data/{private.yml@localhost → _defaults/private.yml} +8 -51
  50. data/lib/starter_web/_data/_defaults/resources.yml +626 -325
  51. data/lib/starter_web/_data/apps/defaults/{justified_gallery.yml → justifiedGallery.yml} +2 -2
  52. data/lib/starter_web/_data/apps/defaults/{gallery_customizer.yml → justifiedGalleryCustomizer.yml} +0 -0
  53. data/lib/starter_web/_data/apps/defaults/{light_gallery.yml → lightGallery.yml} +0 -0
  54. data/lib/starter_web/_data/apps/{justified_gallery.yml → justifiedGallery.yml} +7 -7
  55. data/lib/starter_web/_data/apps/{gallery_customizer.yml → justifiedGalleryCustomizer.yml} +0 -0
  56. data/lib/starter_web/_data/apps/{light_gallery.yml → lightGallery.yml} +0 -0
  57. data/lib/starter_web/_data/blocks/banner.yml +18 -30
  58. data/lib/starter_web/_data/blocks/footer.yml +15 -3
  59. data/lib/starter_web/_data/blocks/panel.yml +4 -6
  60. data/lib/starter_web/_data/j1_config.yml +8 -7
  61. data/lib/starter_web/_data/modules/authentication.yml +11 -100
  62. data/lib/starter_web/_data/modules/defaults/log4javascript.yml +37 -40
  63. data/lib/starter_web/_data/modules/defaults/quicksearch.yml +2 -0
  64. data/lib/starter_web/_data/modules/log4javascript.yml +11 -83
  65. data/lib/starter_web/_data/modules/navigator_menu.yml +25 -6
  66. data/lib/starter_web/_data/modules/quicksearch.yml +2 -0
  67. data/lib/starter_web/_data/plugins/defaults/paginator.yml +15 -12
  68. data/lib/starter_web/_data/plugins/paginator.yml +5 -3
  69. data/lib/starter_web/_data/private.yml +29 -57
  70. data/lib/starter_web/_data/private@default.yml +119 -0
  71. data/lib/starter_web/_data/private@localhost.yml +156 -0
  72. data/lib/starter_web/_data/resources.yml +33 -16
  73. data/lib/starter_web/_data/utilities/defaults/util_srv.yml +49 -3
  74. data/lib/starter_web/_data/utilities/util_srv.yml +8 -65
  75. data/lib/starter_web/_includes/attributes.asciidoc +9 -6
  76. data/lib/starter_web/_plugins/asciidoctor-extensions/callout.rb +47 -5
  77. data/lib/starter_web/_plugins/asciidoctor-extensions/conum.rb +28 -1
  78. data/lib/starter_web/_plugins/lunr_index.rb +17 -2
  79. data/lib/starter_web/assets/images/collections/blog/featured/dynamic-web-access.png +0 -0
  80. data/lib/starter_web/assets/images/collections/blog/featured/jamstack-generators.gif +0 -0
  81. data/lib/starter_web/assets/images/collections/blog/featured/jamstack-generators.jpg +0 -0
  82. data/lib/starter_web/assets/images/collections/blog/featured/static-web-access.png +0 -0
  83. data/lib/starter_web/assets/images/modules/attics/leon-1920x1280.jpg +0 -0
  84. data/lib/starter_web/assets/images/modules/attics/machine-generator-1920x1280.jpg +0 -0
  85. data/lib/starter_web/assets/images/modules/icons/j1/j1-256x256.gif +0 -0
  86. data/lib/starter_web/collections/posts/public/featured/_posts/0000-00-00-welcome-to-j1.adoc.erb +44 -45
  87. data/lib/starter_web/collections/posts/public/featured/_posts/{2020-06-01-about-cookies.adoc → 2020-01-01-about-cookies.adoc} +43 -41
  88. data/lib/starter_web/collections/posts/public/featured/_posts/{2020-05-01-top-site-generators.adoc → 2021-03-01-site-generators.adoc} +57 -30
  89. data/lib/starter_web/collections/posts/public/featured/_posts/2021-03-03-about-j1.adoc +125 -0
  90. data/lib/starter_web/collections/posts/public/featured/_posts/_includes/attributes.asciidoc +4 -0
  91. data/lib/starter_web/collections/posts/public/series/_posts/2020-01-02-post-test-series.adoc +1 -1
  92. data/lib/starter_web/collections/posts/public/series/_posts/2020-01-03-post-test-series.adoc +1 -1
  93. data/lib/starter_web/collections/posts/public/series/_posts/2020-01-04-post-test-series.adoc +1 -1
  94. data/lib/starter_web/collections/posts/public/wikipedia/_posts/2016-11-20-minneapolis.adoc +1 -1
  95. data/lib/starter_web/collections/posts/public/wikipedia/_posts/2016-11-24-narcisse-snake-dens.adoc +1 -1
  96. data/lib/starter_web/collections/posts/public/wikipedia/_posts/2016-11-26-columbia-river.adoc +1 -1
  97. data/lib/starter_web/dot.gitattributes +1 -1
  98. data/lib/starter_web/dot.gitignore +5 -1
  99. data/lib/starter_web/package.json +3 -2
  100. data/lib/starter_web/pages/public/asciidoc_skeletons/_templates/asciidoc-extensions/gallery.asciidoc +1 -1
  101. data/lib/starter_web/pages/public/asciidoc_skeletons/book/200_chapter.adoc +1 -1
  102. data/lib/starter_web/pages/public/asciidoc_skeletons/book/book.adoc +1 -1
  103. data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/200_chapter.asciidoc +1 -1
  104. data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/multi.adoc +1 -1
  105. data/lib/starter_web/pages/public/blog/navigator/archive.html +1 -1
  106. data/lib/starter_web/pages/public/blog/navigator/archive/categoryview.html +1 -1
  107. data/lib/starter_web/pages/public/blog/navigator/archive/dateview.html +2 -2
  108. data/lib/starter_web/pages/public/blog/navigator/archive/tagview.html +1 -1
  109. data/lib/starter_web/pages/public/blog/navigator/index.html +1 -1
  110. data/lib/starter_web/pages/public/learn/roundtrip/100_present_images.adoc +44 -47
  111. data/lib/starter_web/pages/public/learn/roundtrip/100_present_videos.adoc +20 -19
  112. data/lib/starter_web/pages/public/learn/roundtrip/200_typography.adoc +5 -1
  113. data/lib/starter_web/pages/public/learn/roundtrip/300_icon_fonts.adoc +38 -34
  114. data/lib/starter_web/pages/public/learn/roundtrip/400_asciidoc_extensions.adoc +37 -35
  115. data/lib/starter_web/pages/public/learn/roundtrip/410_bs_modals_extentions.adoc +15 -13
  116. data/lib/starter_web/pages/public/learn/roundtrip/420_responsive_tables_extensions.adoc +10 -8
  117. data/lib/starter_web/pages/public/learn/roundtrip/500_themes.adoc +29 -26
  118. data/lib/starter_web/pages/public/learn/roundtrip/600_quicksearch.adoc +49 -48
  119. data/lib/starter_web/pages/public/learn/roundtrip/_includes/documents/100_gistblock.asciidoc +1 -1
  120. data/lib/starter_web/pages/public/learn/where_to_go.adoc +43 -16
  121. data/lib/starter_web/pages/public/legal/en/100_copyright.adoc +114 -0
  122. data/lib/starter_web/pages/public/legal/en/200_impress.adoc +81 -0
  123. data/lib/starter_web/pages/public/legal/en/300_privacy.adoc +70 -48
  124. data/lib/starter_web/pages/public/legal/en/400_comment_policy.adoc +121 -0
  125. data/lib/starter_web/pages/public/panels/intro_panel/panel.adoc +78 -70
  126. data/lib/starter_web/pages/public/previewer/justified_gallery.html +2 -2
  127. data/lib/starter_web/pages/public/previewer/md_color_palette.adoc +0 -1939
  128. data/lib/starter_web/pages/public/previewer/mdi_icons_preview.adoc +6 -8
  129. data/lib/starter_web/utilsrv/_defaults/package.json +13 -9
  130. data/lib/starter_web/utilsrv/package.json +6 -2
  131. data/lib/starter_web/utilsrv/server.js +228 -55
  132. metadata +45 -214
  133. data/assets/data/menu.1.html +0 -505
  134. data/lib/starter_web/_data/_defaults/j1_light_gallery.yml +0 -110
  135. data/lib/starter_web/_data/_defaults/template_settings.yml +0 -258
  136. data/lib/starter_web/_data/plugins/defaults/notebooks.yml +0 -61
  137. data/lib/starter_web/_data/plugins/notebooks.yml +0 -70
  138. data/lib/starter_web/assets/images/collections/blog/featured/staticgen.jpg +0 -0
  139. data/lib/starter_web/assets/images/modules/attics/aditya-joshi-1920x1280.jpg +0 -0
  140. data/lib/starter_web/assets/images/modules/attics/alex-holyoake-1920x1280.jpg +0 -0
  141. data/lib/starter_web/assets/images/modules/attics/anaya-katlego-1920x1280.jpg +0 -0
  142. data/lib/starter_web/assets/images/modules/attics/antonella-lombardi-1920x1280.jpg +0 -0
  143. data/lib/starter_web/assets/images/modules/attics/antonino-visalli-1920x1280.jpg +0 -0
  144. data/lib/starter_web/assets/images/modules/attics/banner/docker-1280x600-bw.jpg +0 -0
  145. data/lib/starter_web/assets/images/modules/attics/banner/jekyll.1200x600-bw.jpg +0 -0
  146. data/lib/starter_web/assets/images/modules/attics/banner/signpost-1920x800-bw.jpg +0 -0
  147. data/lib/starter_web/assets/images/modules/attics/banner/water-journal-1280x600.jpg +0 -0
  148. data/lib/starter_web/assets/images/modules/attics/banner/write-1280x600-bw.jpg +0 -0
  149. data/lib/starter_web/assets/images/modules/attics/brandon-mowinkel-1920x1280.jpg +0 -0
  150. data/lib/starter_web/assets/images/modules/attics/daniel-jensen-1920x1280.jpg +0 -0
  151. data/lib/starter_web/assets/images/modules/attics/florian-olivo-1920x1280.jpg +0 -0
  152. data/lib/starter_web/assets/images/modules/attics/giammarco-boscaro-1920x1280.jpg +0 -0
  153. data/lib/starter_web/assets/images/modules/attics/go-up-1920x1280-bw.jpg +0 -0
  154. data/lib/starter_web/assets/images/modules/attics/ian-schneider-1920x1280.jpg +0 -0
  155. data/lib/starter_web/assets/images/modules/attics/jason-rosewell-1920x1280.jpg +0 -0
  156. data/lib/starter_web/assets/images/modules/attics/joel-filipe-1920x1280.jpg +0 -0
  157. data/lib/starter_web/assets/images/modules/attics/lianhao-1920x1280.jpg +0 -0
  158. data/lib/starter_web/assets/images/modules/attics/library-1920x1280-bw.jpg +0 -0
  159. data/lib/starter_web/assets/images/modules/attics/mae-mue-1920x1280-v.jpg +0 -0
  160. data/lib/starter_web/assets/images/modules/attics/mae-mue-1920x1280.jpg +0 -0
  161. data/lib/starter_web/assets/images/modules/attics/markus-spiske-1920x1280.jpg +0 -0
  162. data/lib/starter_web/assets/images/modules/attics/markus-spiske.jpg +0 -0
  163. data/lib/starter_web/assets/images/modules/attics/markus-spiske3-1920x1280.jpg +0 -0
  164. data/lib/starter_web/assets/images/modules/attics/modules-apps-1920x1280.jpg +0 -0
  165. data/lib/starter_web/assets/images/modules/attics/nicola-styles-1920x1280.jpg +0 -0
  166. data/lib/starter_web/assets/images/modules/attics/no-time-1920x1280.jpg +0 -0
  167. data/lib/starter_web/assets/images/modules/attics/nousnou-iwasaki-1920x1280.jpg +0 -0
  168. data/lib/starter_web/assets/images/modules/attics/premium-1920x1280-bw.jpg +0 -0
  169. data/lib/starter_web/assets/images/modules/attics/responsive-text-1920x1280.jpg +0 -0
  170. data/lib/starter_web/assets/images/modules/attics/robert-v-ruggiero-1920x1280.jpg +0 -0
  171. data/lib/starter_web/assets/images/modules/attics/romain-vignes-1920x1280.jpg +0 -0
  172. data/lib/starter_web/assets/images/modules/attics/spider-web-1920x1200-bw.jpg +0 -0
  173. data/lib/starter_web/assets/images/modules/attics/the-place-1920x1280.jpg +0 -0
  174. data/lib/starter_web/assets/images/modules/icons/algolia/search-by-algolia.png +0 -0
  175. data/lib/starter_web/assets/images/modules/icons/d1/d1-256x256.png +0 -0
  176. data/lib/starter_web/assets/images/modules/icons/d1/d1-32x32.ico +0 -0
  177. data/lib/starter_web/assets/images/modules/icons/d1/d1-512x512.png +0 -0
  178. data/lib/starter_web/assets/images/modules/icons/d1/d1-64x64.png +0 -0
  179. data/lib/starter_web/assets/images/modules/icons/d1/d1.ico +0 -0
  180. data/lib/starter_web/assets/images/modules/icons/d1/favicon.ico +0 -0
  181. data/lib/starter_web/assets/images/modules/icons/d1/scalable/d1.svg +0 -2025
  182. data/lib/starter_web/assets/images/modules/icons/netlify/nf-logo.png +0 -0
  183. data/lib/starter_web/assets/images/modules/icons/p1/favicon.ico +0 -0
  184. data/lib/starter_web/assets/images/modules/icons/p1/p1-256x256.png +0 -0
  185. data/lib/starter_web/assets/images/modules/icons/p1/p1-32x32.ico +0 -0
  186. data/lib/starter_web/assets/images/modules/icons/p1/p1-512x512.png +0 -0
  187. data/lib/starter_web/assets/images/modules/icons/p1/p1-64x64.png +0 -0
  188. data/lib/starter_web/assets/images/modules/icons/p1/p1.ico +0 -0
  189. data/lib/starter_web/assets/images/modules/icons/p1/scalable/p1.svg +0 -2020
  190. data/lib/starter_web/assets/images/modules/icons/patreon/favicon-16x16.png +0 -0
  191. data/lib/starter_web/assets/images/modules/icons/patreon/favicon-32x32.png +0 -0
  192. data/lib/starter_web/assets/images/pages/j1_webhooks/000_browser_console-1280x600.jpg +0 -0
  193. data/lib/starter_web/assets/images/pages/j1_webhooks/001_smee_channel-1280x400.jpg +0 -0
  194. data/lib/starter_web/assets/images/pages/j1_webhooks/002_gh_repo_settings-1280x800.jpg +0 -0
  195. data/lib/starter_web/assets/images/pages/j1_webhooks/003_gh_webhook_settings-1280x1000.jpg +0 -0
  196. data/lib/starter_web/assets/images/pages/j1_webhooks/004_gh_webhook_settings-post-1280x600.jpg +0 -0
  197. data/lib/starter_web/assets/images/pages/j1_webhooks/005_smee_channel_ping_receive-1280x800.jpg +0 -0
  198. data/lib/starter_web/assets/images/pages/j1_webhooks/006_gh_redeliver_payload-1280x900.jpg +0 -0
  199. data/lib/starter_web/assets/images/pages/j1_webhooks/007_receive_redelivered_payload-1280x800.jpg +0 -0
  200. data/lib/starter_web/assets/images/pages/j1_webhooks/base/000_browser_console.jpg +0 -0
  201. data/lib/starter_web/assets/images/pages/j1_webhooks/base/000_smee_channel.jpg +0 -0
  202. data/lib/starter_web/assets/images/pages/j1_webhooks/base/002_gh_repo-settings.jpg +0 -0
  203. data/lib/starter_web/assets/images/pages/j1_webhooks/base/003_gh_webhook_settings.jpg +0 -0
  204. data/lib/starter_web/assets/images/pages/j1_webhooks/base/004_gh_webhook_settings-post.jpg +0 -0
  205. data/lib/starter_web/assets/images/pages/j1_webhooks/base/005_smee_channel_ping_received.jpg +0 -0
  206. data/lib/starter_web/assets/images/pages/j1_webhooks/base/006_gh_redeliver_payload.jpg +0 -0
  207. data/lib/starter_web/assets/images/pages/j1_webhooks/base/007_receive_redelivered_payload.jpg +0 -0
  208. data/lib/starter_web/assets/images/pages/j1_webhooks/base/webhook_flow.jpg +0 -0
  209. data/lib/starter_web/assets/images/pages/j1_webhooks/flows/webhook_flow-1920x1280.jpg +0 -0
  210. data/lib/starter_web/assets/images/pages/j1_webhooks/scaleable/webhook_flow.svg +0 -432
  211. data/lib/starter_web/assets/images/pages/j1_webhooks/uml/auth_mgmr_signin_request_flow.uxf +0 -632
  212. data/lib/starter_web/assets/images/pages/j1_webhooks/uml/webhook_flow.uxf +0 -648
  213. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/get-started-1920x1280-bw.jpg +0 -0
  214. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/130_layout_inheritance.png +0 -0
  215. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/content_inheritance.png +0 -0
  216. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/content_inheritance_thumb.png +0 -0
  217. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/html_layout.png +0 -0
  218. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/j1-quickstart-windows.png +0 -0
  219. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/j1-template-theme.jpg +0 -0
  220. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/j1_layout.png +0 -0
  221. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/jekyll-minima-theme.png +0 -0
  222. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/lane_inheritance.png +0 -0
  223. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/intro/layout_inheritance.png +0 -0
  224. data/lib/starter_web/assets/images/pages/kickstarter/web_in_a_day/preparations/msys_installation.jpg +0 -0
  225. data/lib/starter_web/assets/images/pages/log4j/apache-log4j-logo.png +0 -0
  226. data/lib/starter_web/assets/images/pages/log4r/code-1920x600.jpg +0 -0
  227. data/lib/starter_web/assets/images/pages/log4r/log4r-logo.png +0 -0
  228. data/lib/starter_web/assets/images/pages/log_expert/image_000.png +0 -0
  229. data/lib/starter_web/assets/images/pages/log_expert/image_001.png +0 -0
  230. data/lib/starter_web/assets/images/pages/log_expert/image_002.png +0 -0
  231. data/lib/starter_web/assets/images/pages/log_expert/image_003.png +0 -0
  232. data/lib/starter_web/assets/images/pages/log_expert/image_004.png +0 -0
  233. data/lib/starter_web/assets/images/pages/log_expert/image_005.png +0 -0
  234. data/lib/starter_web/assets/images/pages/log_expert/image_006.png +0 -0
  235. data/lib/starter_web/assets/images/pages/log_expert/image_007.png +0 -0
  236. data/lib/starter_web/assets/images/pages/log_expert/image_008.png +0 -0
  237. data/lib/starter_web/assets/images/pages/log_expert/image_009.png +0 -0
  238. data/lib/starter_web/assets/images/pages/log_expert/image_010.png +0 -0
  239. data/lib/starter_web/assets/images/pages/log_expert/image_011.png +0 -0
  240. data/lib/starter_web/assets/images/pages/log_expert/image_012.png +0 -0
  241. data/lib/starter_web/assets/images/pages/log_expert/image_013.png +0 -0
  242. data/lib/starter_web/assets/images/pages/log_expert/image_014.png +0 -0
  243. data/lib/starter_web/assets/images/pages/log_expert/image_015.png +0 -0
  244. data/lib/starter_web/assets/images/pages/log_expert/image_016.png +0 -0
  245. data/lib/starter_web/assets/images/pages/log_expert/image_017.png +0 -0
  246. data/lib/starter_web/assets/images/pages/log_expert/image_018.png +0 -0
  247. data/lib/starter_web/assets/images/pages/log_expert/image_019.png +0 -0
  248. data/lib/starter_web/assets/images/pages/log_expert/image_020.png +0 -0
  249. data/lib/starter_web/assets/images/pages/log_expert/image_021.png +0 -0
  250. data/lib/starter_web/assets/images/pages/log_expert/image_022.png +0 -0
  251. data/lib/starter_web/assets/images/pages/log_expert/image_023.png +0 -0
  252. data/lib/starter_web/assets/images/pages/log_expert/image_024.png +0 -0
  253. data/lib/starter_web/assets/images/pages/log_expert/image_025.png +0 -0
  254. data/lib/starter_web/assets/images/pages/log_expert/image_026.png +0 -0
  255. data/lib/starter_web/assets/images/pages/log_expert/image_027.png +0 -0
  256. data/lib/starter_web/assets/images/pages/log_expert/image_028.png +0 -0
  257. data/lib/starter_web/assets/images/pages/log_expert/image_029.png +0 -0
  258. data/lib/starter_web/assets/images/pages/log_expert/image_030.png +0 -0
  259. data/lib/starter_web/assets/images/pages/log_expert/image_031.png +0 -0
  260. data/lib/starter_web/assets/images/pages/log_expert/image_032.png +0 -0
  261. data/lib/starter_web/assets/images/pages/log_expert/image_033.png +0 -0
  262. data/lib/starter_web/assets/images/pages/log_expert/image_034.png +0 -0
  263. data/lib/starter_web/assets/images/pages/log_expert/image_035.png +0 -0
  264. data/lib/starter_web/assets/images/pages/log_expert/image_036.png +0 -0
  265. data/lib/starter_web/assets/images/pages/log_expert/image_037.png +0 -0
  266. data/lib/starter_web/assets/images/pages/log_expert/image_038.png +0 -0
  267. data/lib/starter_web/assets/images/pages/log_expert/image_039.png +0 -0
  268. data/lib/starter_web/assets/images/pages/log_expert/image_040.png +0 -0
  269. data/lib/starter_web/assets/images/pages/log_expert/image_041.png +0 -0
  270. data/lib/starter_web/assets/images/pages/log_expert/image_042.png +0 -0
  271. data/lib/starter_web/assets/images/pages/log_expert/image_043.png +0 -0
  272. data/lib/starter_web/assets/images/pages/log_expert/image_044.png +0 -0
  273. data/lib/starter_web/assets/images/pages/log_expert/image_045.png +0 -0
  274. data/lib/starter_web/assets/images/pages/log_expert/image_046.png +0 -0
  275. data/lib/starter_web/assets/images/pages/log_expert/image_047.png +0 -0
  276. data/lib/starter_web/assets/images/pages/log_expert/image_048.png +0 -0
  277. data/lib/starter_web/assets/images/pages/log_expert/image_049.png +0 -0
  278. data/lib/starter_web/assets/images/pages/log_expert/image_050.png +0 -0
  279. data/lib/starter_web/assets/images/pages/log_expert/image_051.png +0 -0
  280. data/lib/starter_web/assets/images/pages/log_expert/image_052.png +0 -0
  281. data/lib/starter_web/assets/images/pages/log_expert/image_053.png +0 -0
  282. data/lib/starter_web/assets/images/pages/log_expert/image_054.png +0 -0
  283. data/lib/starter_web/assets/images/pages/log_expert/image_055.png +0 -0
  284. data/lib/starter_web/assets/images/pages/log_expert/image_056.png +0 -0
  285. data/lib/starter_web/assets/images/pages/log_expert/image_057.png +0 -0
  286. data/lib/starter_web/assets/images/pages/material/apple-touch-icon.png +0 -0
  287. data/lib/starter_web/assets/images/pages/pen/jquery/jQuery-logo.png +0 -0
  288. data/lib/starter_web/assets/images/pages/pen/jquery/jquery-banner-1280x600.jpg +0 -0
  289. data/lib/starter_web/assets/images/pages/pen/jquery/jquery-banner-1920x800.jpg +0 -0
  290. data/lib/starter_web/assets/images/pages/pen/jquery/src/JQuery-Logo.svg +0 -122
  291. data/lib/starter_web/assets/images/pages/pen/jquery/src/banner.psd +0 -0
  292. data/lib/starter_web/assets/images/pages/winlogbeat/coordinate-map.png +0 -0
  293. data/lib/starter_web/assets/images/pages/winlogbeat/kibana-powershell.jpg +0 -0
  294. data/lib/starter_web/assets/images/pages/winlogbeat/option_ignore_outgoing.png +0 -0
  295. data/lib/starter_web/assets/images/pages/winlogbeat/winlogbeat-dashboard.png +0 -0
  296. data/lib/starter_web/assets/images/pages/writers_guide/1280px-PDCA_Process.png +0 -0
  297. data/lib/starter_web/assets/images/pages/writers_guide/annie-spratt-1920x1280.jpg +0 -0
  298. data/lib/starter_web/assets/images/pages/writers_guide/deming-cycle.png +0 -0
  299. data/lib/starter_web/assets/images/pages/writers_guide/humble-lamb-1920x1280.jpg +0 -0
  300. data/lib/starter_web/assets/images/pages/writers_guide/john-schnobrich-1920x1280.jpg +0 -0
  301. data/lib/starter_web/assets/images/pages/writers_guide/sigmund-1920x1280.jpg +0 -0
  302. data/lib/starter_web/pages/protected/site_search.adoc +0 -180
  303. data/lib/starter_web/pages/public/asciidoc_skeletons/book/book.pdf +1 -5439
  304. data/lib/starter_web/pages/public/legal/en/000_copyright.adoc +0 -93
  305. data/lib/starter_web/pages/public/legal/en/100_impress.adoc +0 -55
  306. data/lib/starter_web/pages/public/legal/en/200_terms_of_use.adoc +0 -53
  307. data/lib/starter_web/pages/public/legal/en/eu/cookie.policy.asciidoc +0 -50
@@ -3,16 +3,17 @@ title: Roundtrip
3
3
  tagline: asciidoc extensions
4
4
  date: 2020-11-07 00:00:00
5
5
  description: >
6
- J1 Template implements some incubating Ruby-based extensions
7
- for Asciidoctor. Most extensions are based on the examples
8
- given with the Asciidoctor Extensions Lab.
9
- All implemented Asciidoctor Extensions can be found in this article.
10
- A set of useful extensions to the Markup language Asciidoc are made
11
- especially for documents of the Jekyll content type pages, but can
12
- be used for post or collections as well.
6
+ J1 Template implements some incubating Ruby-based
7
+ extensions for Asciidoctor. Most extensions are based
8
+ on the examples given with the Asciidoctor Extensions
9
+ Lab. All implemented Asciidoctor Extensions can be
10
+ found in this article.
13
11
 
14
- tags: [ Roundtrip, Introduction ]
15
12
  categories: [ Asciidoc, Extension ]
13
+ tags: [ Roundtrip, Introduction ]
14
+
15
+ comments: false
16
+ fam_menu_id: page_ctrl_simple
16
17
 
17
18
  permalink: /pages/public/learn/roundtrip/asciidoc_extensions/
18
19
  regenerate: false
@@ -60,27 +61,27 @@ Most extensions are based on the examples given with the
60
61
  If you simply want to use the extensions from this repository, go ahead to
61
62
  {asciidoctor-extensions-use-extension}[Using an extension, {browser-window--new}].
62
63
 
63
- To create extensions on your own, it is highly recommended to read first the
64
+ To create extensions on your own, it is highly recommended to read the
64
65
  {asciidoctor-user-manual-extensions}[extensions section, {browser-window--new}] in
65
66
  the Asciidoctor user manual.
66
67
 
67
68
  == Asciidoc Extensions
68
69
 
69
- All already implemented Asciidoctor Extensions can be found below. A set of
70
- additional useful extensions to the Markup language Asciidoc are made
71
- especially for documents of the Jekyll content type pages (but can be used
72
- for post or collections as well).
70
+ All already implemented Asciidoctor Extensions can be found below. Additional
71
+ valuable extensions to the Markup language Asciidoc to the Markup language
72
+ Asciidoc are made especially for documents of the Jekyll content type pages
73
+ (but can be used for posts or collections as well).
73
74
 
74
75
  == Asciidoc Code
75
76
 
76
77
  J1 Template adds a simple Javascript based on the `View Result Extension` to
77
78
  any `listingblock`. The extension adds an interactive toggle button `VIEW`
78
- to the output of an Asciidoc listingblock box placed to the top right of
79
+ to the output of an Asciidoc listing block box placed to the top right of
79
80
  the example box. If a result block `[.result]` is placed under a `listingblock`,
80
81
  clicking the toggle button `VIEW` displays (or hide) the content given by the
81
82
  `result block`.
82
83
 
83
- The `View Result Extension` is quite useful for example sections discussing
84
+ The `View Result Extension` is quite helpful, for sections discussing
84
85
  Asciidoc code and how the resulting (HTML) code would look alike.
85
86
 
86
87
  .This example place a button `VIEW` top right of the example box
@@ -118,8 +119,8 @@ CAUTION: Icon background-color: red
118
119
  == Q&A Blocks
119
120
 
120
121
  Q&A sections are used quite often to answer popular questions. To make
121
- such a Q&A section more eye-minded, the additional Admonition Blocks
122
- `[QUESTION]` and `[ANSWER]` are available for J1 Template as Asciidoctor
122
+ such a Q&A section more eye-minded. The additional Admonition Blocks
123
+ `[QUESTION]` and `[ANSWER]` are available through the J1 Template Asciidoctor
123
124
  extensions.
124
125
 
125
126
  === Question block
@@ -145,7 +146,7 @@ What's the main tool for selecting colors used for J1 Template?
145
146
 
146
147
  The Admonition Answer block is an extension to the Asciidoc admonition
147
148
  block types that introduce an admonition type of answer in conjunction
148
- to the admonition of type question.
149
+ with the type question's admonition.
149
150
 
150
151
  .Example of a answer block
151
152
  [source, prometheus, role="noclip"]
@@ -165,11 +166,11 @@ You'll find the full color scheme for Material Design.
165
166
 
166
167
  == Lightboxes
167
168
 
168
- To make the use of the built-in Lightbox easier, J1 Template offers an Asciidoc
169
- extension: the LightBox block macro. The `lightbox::` block macro embeds one or
170
- more images into the output document and puts the default Lightbox (lightbox)
171
- for J1 automatically on. For all images, the `size` (width) and individual
172
- `caption text` can be configured.
169
+ To make the use of the built-in Lightbox easier, the J1 Template offers an
170
+ Asciidoc extension: the LightBox block macro. The `lightbox::` block macro
171
+ embeds one or more images into the output document and puts the default
172
+ Lightbox for J1 automatically on. For all images, the `size` (width) and
173
+ individual `caption text` can be configured.
173
174
 
174
175
  .Lightbox Block
175
176
  [source, prometheus, role="noclip"]
@@ -182,11 +183,11 @@ NOTE: For a `lightbox::` block, images are placed in the output document
182
183
  without any other scaling than in width - they are placed using simple
183
184
  HTML `img` tags. This is fine for images that are even in size. For images in
184
185
  different sizes, a gallery should be used as a J1 Gallery Apps to rearrange
185
- images and make them fit at its best for the available space.
186
+ images and make them fit at their best for the available space.
186
187
 
187
188
  === Standalone Images
188
189
 
189
- For your convenience, and better readability, the image data should be
190
+ For your convenience and better readability, the image data should be
190
191
  defined as Asciidoc attributes. The image data is given as a string
191
192
  of data pairs:
192
193
 
@@ -209,7 +210,7 @@ default asset path for images, a relative path needs to be given for
209
210
  `path/to/image`.
210
211
 
211
212
  WARNING: If an absolute path is configured, like `/path/to/image`, the base
212
- path gets ignored - this is the default behaviour of the Asciidoc Markup
213
+ path gets ignored - this is the default behavior of the Asciidoc Markup
213
214
  processor. If an absolute path is given, the full path to the images
214
215
  used has to be configured.
215
216
 
@@ -245,7 +246,7 @@ lightbox::images-group[ 400, {data-images-group}, group_name ]
245
246
 
246
247
  == Icon Fonts
247
248
 
248
- J1 Template comes with full icon support for Asciidoc documents included.
249
+ The J1 Template comes with full icon support for Asciidoc documents included.
249
250
  All icon fonts are supported:
250
251
 
251
252
  * FA (FontAwesome)
@@ -390,17 +391,17 @@ and Twitter Emoji emoji:smile[].
390
391
 
391
392
  == Blind Text (Lorem)
392
393
 
393
- The Ruby Gem Middleman, a Ruby-gem based static site generator, provides a
394
- set of powerful helpers for generating random text content. The Lorem
394
+ The Ruby Gem Middleman, a Ruby-based static site generator, provides a
395
+ set of great helpers for generating random text content. The Lorem
395
396
  inline macro `lorem:` adapted this functionality from Middleman for the use
396
397
  of Asciidoc-based documents processed by Jekyll.
397
398
 
398
399
  If you start writing larger documents having several chapters, not all of the
399
400
  content is available at the beginning. It is quite useful to place blind text
400
- first to get a better impression how a page will look-alike that is not
401
+ first to get a better impression of how a page will look-alike that is not
401
402
  finished yet.
402
403
 
403
- Placeholders for blind text comes in several flavours given by `macro`. The
404
+ Placeholders for blind text comes in several flavors given by `macro`. The
404
405
  syntax for the `lorem:` inline macro is simple like this:
405
406
 
406
407
  [source, prometheus]
@@ -491,11 +492,12 @@ include::{documentdir}/100_gistblock.asciidoc[]
491
492
 
492
493
  Asciidoc, respectively Asciidoctor, extensions open up the Markup language to
493
494
  new use cases. Using the full power of programming languages to extend what's
494
- needed whether it be Ruby, Java, Groovy or JavaScript. The number of extensions
495
- will grow - to get handy and powerful functionality that is needed for modern
496
- web pages based on the Asciidoc Markup language generated by Jekyll. For sure!
495
+ needed, whether it be Ruby, Java, Groovy, or JavaScript. The number of
496
+ extensions will grow - to get handy and powerful functionality that is needed
497
+ for modern web pages based on the Asciidoc Markup language generated by Jekyll.
498
+ For sure!
497
499
 
498
- The next preview is focussing advanced Bootstrap Modals. The modals feature
500
+ The next preview is focussing on advanced Bootstrap Modals. The modals feature
499
501
  is currently in beta status, but it is a great option to customize your
500
502
  user dialogues using them!
501
503
 
@@ -3,15 +3,18 @@ title: Roundtrip
3
3
  tagline: advanced bootstrap modals
4
4
  date: 2020-11-08 00:00:00
5
5
  description: >
6
- Bootstrap modals are used to add dialogues to your web pages for user
7
- notifications. To highlight important information to your visitor's. Modals
8
- are positioned over everything else in the document so that messages
9
- get the users attention.
6
+ Bootstrap modals are used to add dialogs to your
7
+ web pages for user notifications. To highlight important
8
+ information to your visitors. Modals are positioned over
9
+ everything else in the document so that messages get the
10
+ user's attention.
10
11
 
12
+ categories: [ Bootstrap, Modals ]
11
13
  tags: [ Roundtrip, Introduction ]
12
- categories: [ Bootstrap, Modal, Extension ]
13
14
 
14
15
  flowtext: false
16
+ comments: false
17
+ fam_menu_id: page_ctrl_simple
15
18
 
16
19
  permalink: /pages/public/learn/roundtrip/modals/
17
20
  regenerate: false
@@ -56,17 +59,17 @@ link:{mdb-bs-modals-legacy}[Enhanced Bootstrap Modals, {browser-window--new}]. A
56
59
  current version is available from here: link:{mdb-bs-modals}[Modal examples & templates, {browser-window--new}].
57
60
 
58
61
  Bootstrap modals are used to add dialogues to your web pages for user
59
- notifications. To highlight important information to your visitor's. Modals
62
+ notifications. To highlight important information to your visitors. Modals
60
63
  are positioned over everything else in the document so that messages
61
- get the users attention.
64
+ get the user's attention.
62
65
 
63
66
  == BS advanced Modals
64
67
 
65
68
  To improve your visitor's experience on important information that shouldn't
66
- missed, modals are a great choice to bring the users attention on. Using J1
67
- Template BS enhanced predefined modal styles, some emotional weight is added
68
- to the information displayed - ranging from an info level, a simple warning to
69
- critical messages.
69
+ be missed, modals are a great choice to bring the user's attention. Using the
70
+ J1 Template BS enhanced predefined modal styles, some emotional weight is
71
+ added to the information displayed - ranging from an info level, a simple
72
+ warning to critical messages.
70
73
 
71
74
  NOTE: For more information on how to use Bootstrap’s JavaScript modal
72
75
  plugin, refer to: link:{bs_doc_components_modal}[Bootstrap Docs, {browser-window--new}].
@@ -83,10 +86,9 @@ needs some enhancement to display tables on low-resolution devices or smaller
83
86
  (browser-) window sizes.
84
87
 
85
88
  The first version for improved responsive tables that scale better is available
86
- for J1 Template on top of the classic BS CSS styles. Check out what from here
89
+ for J1 Template on top of the classic BS CSS styles. Check out from here
87
90
  what the link:{roundtrip-responsive-tables}[BS tables extensions] can do!
88
91
 
89
-
90
92
  // Include the modals HTML portion
91
93
  // -----------------------------------------------------------------------------
92
94
  include::{documentdir}/419_advanced_modals_demo.asciidoc[]
@@ -7,10 +7,12 @@ description: >
7
7
  J1 Template is based on pure CSS on top of the classic Bootstrap styles for
8
8
  simplicity and portability to be viewed best on all devices and browsers.
9
9
 
10
+ categories: [ Bootstrap, Tables ]
10
11
  tags: [ Roundtrip, Introduction ]
11
- categories: [ Bootstrap, Table, Extension ]
12
12
 
13
13
  flowtext: false
14
+ comments: false
15
+ fam_menu_id: page_ctrl_simple
14
16
 
15
17
  permalink: /pages/public/learn/roundtrip/responsive_tables/
16
18
  regenerate: false
@@ -58,7 +60,7 @@ simplicity and portability to be viewed best on all devices and browsers.
58
60
 
59
61
  == Table types
60
62
 
61
- But, for sure, the solution provided is a compromise. To fit the common needs
63
+ But, for sure, the solution provided is a compromise. To fit the everyday needs
62
64
  for tables viewed on desktop and mobile devices, three types of responsive
63
65
  tables are implemented:
64
66
 
@@ -182,7 +184,7 @@ Post's front matter by specifying a new date/time in the format
182
184
 
183
185
  === Responsive tables
184
186
 
185
- Responsive tables *rebuilds* a table. The header is set to invisible and
187
+ Responsive tables *rebuild* a table. The header is set to invisible, and
186
188
  all columns gets vertically *stacked as rows*.
187
189
 
188
190
  .Example, R Table using responsive text size
@@ -254,7 +256,7 @@ Responsive Bootstrap tables support tables to be scrolled horizontally
254
256
  on smaller viewports. Making any table responsive across all viewports,
255
257
  the additional class `rtable` is used. For specific (Bootstrap)
256
258
  breakpoints, the classes `rtable{-sm|-md|-lg|-xl}` are available
257
- to have better control over what viewport sizes table are transformed.
259
+ to better control over what viewport sizes table are transformed.
258
260
  From a specified breakpoint and up, the table will behave normally and do
259
261
  not scroll horizontally.
260
262
 
@@ -410,9 +412,9 @@ the form `#RRGGBB`
410
412
 
411
413
  == Whats next
412
414
 
413
- Expectedly you've enjoyed exploring all the possibilities J1 offers sofar.
414
- An interesting feature may using themes. But much, much more can the J1 do
415
+ Expectedly you've enjoyed exploring all the possibilities J1 offers so far.
416
+ An exciting feature may the use of themes. But much, much more can the J1 do
415
417
  for your Web Site.
416
418
 
417
- Check out what themes can do. Have a look at link:{roundtrip-themes}[BS themes]
418
- feature!
419
+ Check out what themes can do. Have a look at the
420
+ link:{roundtrip-themes}[BS themes] feature!
@@ -8,10 +8,12 @@ description: >
8
8
  sense to present what is possible using different
9
9
  versions of Bootstrap's CSS styles for a website.
10
10
 
11
- tags: [ Bootstrap, Themes ]
12
- categories: [ Introduction, Features ]
11
+ categories: [ Bootstrap, Themes ]
12
+ tags: [ Roundtrip, Introduction ]
13
13
 
14
14
  scrollbar: false
15
+ comments: false
16
+ fam_menu_id: page_ctrl_simple
15
17
 
16
18
  permalink: /pages/public/learn/roundtrip/themes/
17
19
  regenerate: false
@@ -52,6 +54,7 @@ resource_options:
52
54
  // Page content
53
55
  // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54
56
 
57
+
55
58
  // Include sub-documents
56
59
  // -----------------------------------------------------------------------------
57
60
 
@@ -59,14 +62,14 @@ Themes for the template system J1 are based on the free and open-source CSS
59
62
  front-end framework {url-bs--home}[Bootstrap, {browser-window--new}] of
60
63
  version V4.
61
64
 
62
- Bootstrap is a HTML, CSS & JS Library that focuses on simplifying the
63
- development of modern web pages. The primary purpose to apply the framework
64
- to J1 is to provide a general standard colors, sizes, fonts and the overall
65
- layout of a J1-based site. Bootstrap provides basic style definitions for all
66
- common used HTML elements.
65
+ Bootstrap is an HTML, CSS & JS Library that focuses on simplifying the
66
+ development of modern web pages. The primary purpose of applying the
67
+ framework to J1 is to provide a general standard for colors, sizes, fonts,
68
+ and the overall layout of a J1-based site. Bootstrap provides basic style
69
+ definitions for all commonly used HTML elements.
67
70
 
68
71
  This results in a uniform appearance for the content in terms of the overall
69
- layout, text, tables and form elements across all modern web browsers available
72
+ layout, text, tables, and form elements across all modern web browsers available
70
73
  on the market. In addition, developers can take advantage of CSS classes
71
74
  defined in Bootstrap to customize content individually.
72
75
 
@@ -77,10 +80,10 @@ versions of Bootstrap's CSS styles for a website.
77
80
  == Template themes
78
81
 
79
82
  Themes step in the framework to further adjust the appearance of a website
80
- based on the core CSS rules and definitions of Bootstrap. Themes does not
81
- change the functionality of the framwork, but modifies rule-based e.g. the
83
+ based on the core CSS rules and definitions of Bootstrap. Themes do not
84
+ change the functionality of the framework but modify rule-based, e.g., the
82
85
  color scheme, fonts, sizes or the appearance of more complex elements like
83
- forms or tables. Additionally, a theme may add additonal components but in
86
+ forms,or tables. Additionally, a theme may add additional components but in
84
87
  the *sense* of Bootstrap's framework rules and philosophy.
85
88
 
86
89
  It is expected that many people will change the template for their needs. To
@@ -88,7 +91,7 @@ really create unique websites. Fundamental to do this is are CSS styles
88
91
  defined by Bootstrap.
89
92
 
90
93
  Modifying the CSS styles of link:{bootstrap-home}[Bootstrap, {browser-window--new}]
91
- is not rocket science. But, to be honest, some knowledge is needed to
94
+ is not rocket science. But, to be honest, some knowledge is needed for
92
95
  link:{w3org-css-spec}[the CSS technology] to do so. We encourage you to spend
93
96
  some time first on learning CSS. To learn what is the
94
97
  link:{w3schools-css-tutorial}[design base, {browser-window--new}] of each and
@@ -96,12 +99,12 @@ every website.
96
99
 
97
100
  Thanks to the people at link:{bootswatch-home}[Bootswatch, {browser-window--new}],
98
101
  a great set of already prepared Bootstrap stylesheets in various designs are
99
- available at their website. No need to start from scratch, to re-define all
102
+ available on their website. No need to start from scratch, to re-define all
100
103
  the Bootstrap variables and rebuild the framework files to create a new
101
104
  theme. Many different styles are available. What is already available at
102
105
  Bootswatch is at least a good base for your modifications; your unique design.
103
106
 
104
- Besides the bunch of different stylesheets at Bootswatch, a
107
+ Besides the bunch of different stylesheets at Bootswatch, an
105
108
  link:{bootswatch-api}[Integration API, {browser-window--new}] is available
106
109
  that helps a lot to integrate available designs into an existing site. This API
107
110
  is the base to integrate selectable Bootswatch stylesheets into the J1 Template
@@ -109,7 +112,7 @@ navigation system for easy use.
109
112
 
110
113
  === Apply a template theme
111
114
 
112
- The base for designing pages using J1 Template is the theme Uno, a modern
115
+ The base for designing pages using the J1 Template is the theme Uno, a modern
113
116
  light theme that can be used for many types of websites. And what we mentioned
114
117
  already, web design is not: one size fits all. The theme Uno can be seen as
115
118
  a good base, a starting point. Combining Uno and a different theme may a fast
@@ -117,12 +120,12 @@ solution for your site!?
117
120
 
118
121
  You can find all available themes, all stylesheets to be applied to your pages
119
122
  from the menu Themes. You're invited to check how a page is changing for
120
- their design if other stylesheets, other ideas of web design is used.
123
+ its design if other stylesheets, other ideas of web design are used.
121
124
 
122
- NOTE: Changing BS-based styles is one thing, changing from one theme to the
123
- next at runtime a bit more challenging. For the first version of J1 Template,
124
- many styles are automatically changed for J1 specific components as well, but
125
- not all of them for now.
125
+ NOTE: Changing BS-based styles is one thing. Changing from one theme to the
126
+ next at runtime a bit more challenging. For the first version of the J1
127
+ Template, many styles are automatically changed for J1 specific components
128
+ as well, but not all of them for now.
126
129
 
127
130
  Simply select a theme from this menu, and a new BS-based stylesheet is
128
131
  automatically applied to your pages.
@@ -130,9 +133,9 @@ automatically applied to your pages.
130
133
  == Code Highlighter Rouge
131
134
 
132
135
  _Rouge_ is a pure Ruby and themeable syntax highlighter. It can highlight
133
- 100+ different languages, and output HTML or ANSI 256-color text. Find with
134
- this section all available themes and examples for several lanuguages how
135
- highlightning works using _Rouge_.
136
+ 100+ different languages and output HTML or ANSI 256-color text. Find with
137
+ this section all available themes and examples for several languages how
138
+ highlighting works using _Rouge_.
136
139
 
137
140
  For the default theme `Uno` of J1 Template, the following _Rouge_ themes
138
141
  are used:
@@ -140,7 +143,7 @@ are used:
140
143
  * light: `igorpro`
141
144
  * dark: `monokai.sublime`
142
145
 
143
- NOTE: The default themes used for J1 Template can be configured with the
146
+ NOTE: The default themes used for the J1 Template can be configured with the
144
147
  global template config file `~/_data/j1_config.yml`.
145
148
 
146
149
 
@@ -243,8 +246,8 @@ end
243
246
 
244
247
  Using a theme, the character of a website can change a lot. If you don't want
245
248
  to support multiple themes with your site, a theme is a good base to create
246
- your own theme, anayway.
249
+ your own theme, anyway.
247
250
 
248
251
  An important feature for larger webs is searching. The visitors should be able
249
252
  to search your site to find pages and posts they are interested in. Check what
250
- is searching a J1 websites all about at link:{roundtrip-quicksearch}[Quicksearch].
253
+ is searching a J1 website all about at link:{roundtrip-quicksearch}[Quicksearch].
@@ -4,17 +4,19 @@ tagline: full index search based on lunr
4
4
  date: 2020-11-08 00:00:00
5
5
  description: >
6
6
  QuickSearch is based on the search engine Lunr,
7
- fully integrated with J1 Template. Lunr is designed
8
- to be lightweight, yet full featured to provide a
7
+ fully integrated with the J1 Template. Lunr is designed
8
+ to be lightweight yet full-featured to provide a
9
9
  great search experience. No need for complex external,
10
- server-sideed search engines, or commercial services
10
+ server-sided search engines or commercial services
11
11
  on the Internet like Google.
12
12
 
13
- tags: [ Roundtrip, QuickSearch ]
14
- categories: [ Search ]
13
+ categories: [ QuickSearch, Lunr ]
14
+ tags: [ Roundtrip, Introduction ]
15
15
 
16
16
  toc: true
17
17
  scrollbar: false
18
+ comments: false
19
+ fam_menu_id: page_ctrl_simple
18
20
 
19
21
  permalink: /pages/public/learn/roundtrip/quicksearch/
20
22
  regenerate: false
@@ -55,22 +57,21 @@ resource_options:
55
57
  // Include sub-documents
56
58
  // -----------------------------------------------------------------------------
57
59
 
60
+ QuickSearch is based on the search engine Lunr, fully integrated with the J1
61
+ Template. Lunr is designed to be lightweight yet full-featured to provide a
62
+ great search experience. No need for complex external, server-sided search
63
+ engines or commercial services on the Internet like Google.
58
64
 
59
- QuickSearch is based on the search engine Lunr, fully integrated with J1
60
- Template. Lunr is designed to be lightweight, yet full featured to provide a
61
- great search experience. No need for complex external, server-sideed search
62
- engines, or commercial services on the Internet like Google.
63
-
64
- Searching a website using QuickSearch is different in compare to search engines
65
- like Google or Microsoft Bing. Those search platforms using complex algorithm
66
- to provide a simple interface to the public, but using a lot of artificial
67
- intelligence (AI) methods in behind to make senseful results out of a handfull
68
- words given for a search.
65
+ Searching a website using QuickSearch is different in relation to search engines
66
+ like Google or Microsoft Bing. Those search platforms using complex algorithms
67
+ to provide a simple interface to the public but using a lot of artificial
68
+ intelligence (AI) methods to make sense of results out of a handful of words
69
+ given for a search.
69
70
 
70
71
  Nevertheless, QuickSearch, the J1 implementation of Lunr, is simple like
71
- searching at Google, but offers additional features to do searches more
72
- specific - if wanted. QuickSearch provides a easy to use query language for
73
- better results - anyway!
72
+ searching at Google but offers additional features to do searches more
73
+ specifically - if wanted. QuickSearch provides an easy-to-use query language
74
+ for better results - anyway!
74
75
 
75
76
  == Core concepts
76
77
 
@@ -80,8 +81,8 @@ relevant search results.
80
81
 
81
82
  === Indexing documents
82
83
 
83
- QuickSearch, offers searches on *all* documents of website generated by J1
84
- but only for this site. Advantage, no internet access is done for searches,
84
+ QuickSearch offers searches on *all* documents of the website generated by J1
85
+ but only for this site. Advantage, no internet access is done for searches
85
86
  because it's not needed. Searches are based on a pre-build local site
86
87
  *full-text* index loaded by the browser on a page request. The index for a
87
88
  site is generated by the (Jekyll) plugin `lunr_index.rb` located in the
@@ -115,7 +116,7 @@ site: J1 QuickSearch: finished, index ready.
115
116
 
116
117
  === Documents
117
118
 
118
- The searchable data in an index is organized as documents that contains the
119
+ The searchable data in an index is organized as documents that contain the
119
120
  text, the words (terms), that you want to be able to search on. A document is
120
121
  a data set (JSON object) with a set of fields that are processed to create the
121
122
  result list for a search.
@@ -141,8 +142,8 @@ A document data set might look like this:
141
142
  }
142
143
  ----
143
144
 
144
- In this document there are several fields, like `title`, `tagline`, or
145
- `description` that could be used for *full-text* searches. But additional
145
+ In this document, there are several fields, like `title`, `tagline`, or
146
+ `description`, that could be used for *full-text* searches. But additional
146
147
  fields are available, like `tags` or `categories` that can be used for
147
148
  more specific searches based on `identifiers`.
148
149
 
@@ -152,26 +153,26 @@ field is removed from a document. The `body` field not available as an
152
153
  *explicit* field for searches, but the *content* is fully searchable.
153
154
 
154
155
  To do a simple full-text search as well as more specific searches, the
155
- QuickSearch core engine Lunr offers a query language, a DSL (domain specific
156
- language). Find more about *QuickSearch|Lunr DSL* queries with section
156
+ QuickSearch core engine Lunr offers a query language, a DSL (domain-specific
157
+ language). Find more about *QuickSearch|Lunr DSL* queries with the section
157
158
  <<Searching>>.
158
159
 
159
160
  === Scoring
160
161
 
161
162
  The relevance (the `score`) of a document is calculated based on an algorithm
162
163
  called *BM25*, along with other factors. You don’t need to worry too much about
163
- the details of how this technically works. To summarize: the more a search term
164
+ the details of how this technique works. To summarize: the more a search term
164
165
  occurs in a single document, the more that term will increase that document’s
165
166
  score, but the more a search term occurs in the *overall* collection of
166
167
  documents, the less that term will increase a document’s score. In other words,
167
- seldom words counts, and increase the score.
168
+ seldom words count and increase the score.
168
169
 
169
- Scoring information, generated by the BM25 algorithm, is added to the (local)
170
+ Scoring information generated by the BM25 algorithm is added to the (local)
170
171
  search index. This allows a very fast calculation of the relevance of documents
171
172
  for queries.
172
173
 
173
174
  Imagine you’re website contains documents about Jekyll. The term `Jekyll` may
174
- occur very frequently throughout the entire website; used quite often for the
175
+ occur very frequently throughout the entire website. Used quite often for the
175
176
  content. So finding a document that mentions the term Jekyll isn’t very
176
177
  significant for a search.
177
178
 
@@ -180,10 +181,10 @@ the website have the word `Generator` in them, and that will bring the score
180
181
  (relevance) for documents having both words in them at a higher level,
181
182
  bring them higher up in the search results.
182
183
 
183
- Matching and scoring is used by all search engines; the same to J1 QuickSearch.
184
- You'll see for QuickSearch a similiar behavior in *sorting* search results as
185
- you already know from commercial internet search engines like Google: the top
186
- results are the more relevant ones.
184
+ Matching and scoring are used by all search engines - the same as for J1
185
+ QuickSearch. You'll see for QuickSearch a similar behavior in *sorting*
186
+ search results as you already know from commercial internet search engines
187
+ like Google: the top results are the more relevant ones.
187
188
 
188
189
  == Searching
189
190
 
@@ -194,12 +195,12 @@ area in the menu bar at the top-right of every page.
194
195
  lightbox::quicksearch-icon[ 800, {data-quicksearch-icon} ]
195
196
 
196
197
  A mouse-click on the magnifier button opens the search input and disables
197
- all other navigation to focus on what you're itended to do: searching.
198
+ all other navigation to focus on what you're intended to do: searching.
198
199
 
199
200
  .Input bar for a QuickSearch
200
201
  lightbox::quicksearch-input[ 800, {data-quicksearch-input} ]
201
202
 
202
- Search queries looks like simple text. But the search `engine` under the
203
+ Search queries look like a simple text. But the search `engine` under the
203
204
  hood of QuickSearch transforms the given search string (text) always into a
204
205
  search query. This supports a special syntax, the DSL, for defining more
205
206
  complex queries for better (scored) results.
@@ -228,7 +229,7 @@ jekyll tutorial
228
229
 
229
230
  The above example will match documents that contain either `jekyll` *OR*
230
231
  `tutorial`. Documents that contain _both_ will increase the score, and those
231
- documents be returned first.
232
+ documents are returned first.
232
233
 
233
234
  NOTE: In difference to a Google search (terms are combined at Google by a
234
235
  logical `AND`) a Quicksearch combines the terms by an `OR`.
@@ -255,8 +256,8 @@ jek*
255
256
  ----
256
257
 
257
258
  NOTE: Language grammar rules are not relevant for searches. To simplify an
258
- index, all words (terms) are transformed to lower case. As result, a word
259
- `Jekyll` is the same as `jekyll` from a search-engines prospective. Language
259
+ index, all words (terms) are transformed to lower case. As a result, the word
260
+ `Jekyll` is the same as `jekyll` from a search-engines perspective. Language
260
261
  variations of words like `Jekyll's` or plurals like `Generators` are reduced
261
262
  to their base form. For searches, don't take care of grammar rules but the
262
263
  spelling. If you're unsure about the spelling of a word, use wildcards.
@@ -275,7 +276,7 @@ title:jekyll
275
276
 
276
277
  The search term is prefixed with the name of the field, followed by a
277
278
  colon (`:`). The field _must_ be one of the fields defined when building
278
- the index. Unrecognised fields will lead to an error.
279
+ the index. Unrecognized fields will lead to an error.
279
280
 
280
281
  Field-based searches can be combined with all other term modifiers and
281
282
  wildcards, as well as other terms. For example, to search for words
@@ -289,7 +290,7 @@ the following query can be used:
289
290
 
290
291
  ==== Available fields
291
292
 
292
- Beside the document *body*, an intrinsic field to create the full-text index
293
+ Besides the document *body*, an intrinsic field to create the full-text index
293
294
  out of the document *content*, some more specific fields are available for
294
295
  searches.
295
296
 
@@ -386,18 +387,18 @@ at the end.
386
387
 
387
388
  By default, Lunr combines multiple terms together in a search with a
388
389
  logical OR. That is, a search for `jekyll collections` will match documents
389
- that contain `jekyll` or contain `collections` or contain both. This behaviour
390
- is controllable at the term level, i.e. the presence of each term in
390
+ that contain `jekyll` or contain `collections` or contain both. This behavior
391
+ is controllable at the term level, i.e., the presence of each term in
391
392
  matching documents can be specified.
392
393
 
393
- By default each term is optional in a matching document, though a document
394
+ By default, each term is optional in a matching document, though a document
394
395
  must have at least one matching term. It is possible to specify that a term
395
- must be present in matching documents, or that it must be absent in matching
396
+ must be present in matching documents or that it must be absent in matching
396
397
  documents.
397
398
 
398
- To indicate that a term must be *present* in matching documents the term
399
- could be prefixed with a plus sign (`+`) (required) and to indicate that a
400
- term must be *absent* (not wanted) the term should be prefixed with a minus
399
+ To indicate that a term must be *present* in matching documents, the term
400
+ could be prefixed with a plus sign (`+`) (required), and to indicate that a
401
+ term must be *absent* (not wanted), the term should be prefixed with a minus
401
402
  (`-`).
402
403
 
403
404
  The below example searches for documents that *must* contain `jekyll`, and
@@ -408,7 +409,7 @@ must *not* contain the word `collection`:
408
409
  +jekyll -collection
409
410
  ----
410
411
 
411
- To simulate a logical *AND* search of documents that contains the word `jekyll`
412
+ To simulate a logical *AND* search of documents that contain the word `jekyll`
412
413
  *AND* the word `collection`, mark both terms as required:
413
414
 
414
415
  [source, text]