Cleaned up some field samples in the macros

Fixes #54
Bump version to 2.0.2

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 2.0.2 - 2018-08-05
+
+### Changed
+
+- Made a few additional corrections and improvements to code samples
+
+### Fixed
+
+- Fixed a bug some plugins confliced with a macro loader in twig ([#54](https://github.com/focuslabllc/craft-cheat-sheet/issues/54))
+
 ## 2.0.1 - 2018-08-04
 
 ### Changed

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "focuslabllc/craft-cheat-sheet",
   "description": "A fast and customized set of instantly usable Field code samples.",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "type": "craft-plugin",
   "keywords": [
     "craftcms",
@@ -37,7 +37,7 @@
   "extra": {
     "name": "Craft Cheat Sheet",
     "handle": "cheat-sheet",
-    "version": "2.0.1",
+    "version": "2.0.2",
     "documentationUrl": "https://github.com/focuslabllc/craft-cheat-sheet/blob/master/readme.md"
   }
 }

src/Plugin.php

@@ -15,7 +15,7 @@
  * @copyright  Copyright (c) 2016, Focus Lab, LLC
  * @see        https://github.com/focuslabllc/craft-cheat-sheet
  * @package    cheatsheet
- * @version    2.0.0
+ * @version    2.0.2
  *
  * @property Settings $settings
  * @property Fields $fields

src/Settings.php

@@ -11,7 +11,7 @@
  * @copyright  Copyright (c) 2016, Focus Lab, LLC
  * @see        https://github.com/focuslabllc/craft-cheat-sheet
  * @package    cheatsheet
- * @version    2.0.0
+ * @version    2.0.2
  */
 class Settings extends Model
 {

src/assets/CheatSheetAsset.php

@@ -11,7 +11,7 @@
  * @copyright  Copyright (c) 2016, Focus Lab, LLC
  * @see        https://github.com/focuslabllc/craft-cheat-sheet
  * @package    cheatsheet
- * @version    2.0.0
+ * @version    2.0.2
  */
 class CheatSheetAsset extends AssetBundle
 {

src/controllers/RoutesController.php

@@ -16,7 +16,7 @@
  * @copyright  Copyright (c) 2016, Focus Lab, LLC
  * @see        https://github.com/focuslabllc/craft-cheat-sheet
  * @package    cheatsheet
- * @version    2.0.0
+ * @version    2.0.2
  */
 class RoutesController extends Controller
 {

src/services/Fields.php

@@ -31,7 +31,7 @@
  * @copyright  Copyright (c) 2016, Focus Lab, LLC
  * @see        https://github.com/focuslabllc/craft-cheat-sheet
  * @package    cheatsheet
- * @version    2.0.0
+ * @version    2.0.2
  */
 class Fields extends BaseObject
 {
@@ -62,19 +62,19 @@ private function dataPrep(): array
         $whitespace = str_replace('\t', '	', $whitespace);
 
         return [
-            'pageTitle' => 'Field Cheat Sheet',
-            'version' => $plugin->version,
-            'whitespace' => $whitespace,
-            'groups' => $fieldsService->getAllGroups(),
-            'fields' => $fieldsService->getAllFields(),
+            'pageTitle'      => 'Field Cheat Sheet',
+            'version'        => $plugin->version,
+            'whitespace'     => $whitespace,
+            'groups'         => $fieldsService->getAllGroups(),
+            'fields'         => $fieldsService->getAllFields(),
             'currentContext' => $currentContext,
-            'tagContexts' => [
-                'asset' => ['title' => 'Assets', 'tag' => 'asset'],
-                'cat' => ['title' => 'Categories', 'tag' => 'category'],
-                'entry' => ['title' => 'Entries', 'tag' => 'entry'],
+            'tagContexts'    => [
+                'asset'  => ['title' => 'Assets', 'tag' => 'asset'],
+                'cat'    => ['title' => 'Categories', 'tag' => 'category'],
+                'entry'  => ['title' => 'Entries', 'tag' => 'entry'],
                 'global' => ['title' => 'Globals', 'tag' => 'globalSet'],
-                'tag' => ['title' => 'Tags', 'tag' => 'tag'],
-                'user' => ['title' => 'Users', 'tag' => 'user']
+                'tag'    => ['title' => 'Tags', 'tag' => 'tag'],
+                'user'   => ['title' => 'Users', 'tag' => 'user']
             ],
             'nativeFieldTypes' => [
                 Assets::class,
@@ -104,6 +104,7 @@ private function dataPrep(): array
                 Color::class => 'cs_Color',
                 Date::class => 'cs_Date',
                 Dropdown::class => 'cs_Dropdown',
+                Email::class => 'cs_Email',
                 Entries::class => 'cs_Entries',
                 Lightswitch::class => 'cs_Lightswitch',
                 Matrix::class => 'cs_Matrix',

src/templates/frontEnd/_includes/_coreMacros/codeBlock.twig

@@ -4,7 +4,7 @@
 --------------------------------------------- #}
 {%- macro codeBlock(title, code, helpText) %}
 	<div class="code_block">
-		<h3>{{ title }}</h3>
+		<h3>{{ title|raw}}</h3>
 		{% if helpText %}
 		<div class="description">
 			<p>{{ helpText|md }}</p>

src/templates/frontEnd/_includes/_coreMacros/fields.twig

@@ -151,7 +151,7 @@
 		~ '{% if myCategory %}\n'
 		~ data.whitespace ~ '...\n'
 		~ '{% endif %}'
-	, 'This is mostly used in a scenario where you only expect one category to be selected. The result is still a "set" of categories so we just grab the "first" one.')}}
+	, 'This is mostly used in a scenario where you only expect one category to be selected. The result is still a "set" of categories so we just grab the first one.')}}
 
 {% endmacro -%}
 
@@ -168,7 +168,7 @@
 	)}}
 
 
-	{{ macros.codeBlock('Loop through the *selected* options', '
+	{{ macros.codeBlock('Loop through the <em>selected</em> options', '
 		<ul>\n'
 		~ data.whitespace ~ '{% for option in '
 		~ data.sampleTag
@@ -216,6 +216,25 @@
 		{% if ' ~ data.sampleTag ~ ' %} ... {% endif %}'
 	)}}
 
+	{{ macros.codeBlock('Adding to page style rules', '
+		{% if '
+		~ data.sampleTag
+		~ ' %}\n'
+		~ data.whitespace
+		~ '<style type="text/css">\n'
+		~ data.whitespace ~ data.whitespace
+		~ '.content a {\n'
+		~ data.whitespace ~ data.whitespace ~ data.whitespace
+		~ 'color: {{ '
+		~ data.sampleTag
+		~ '.getHex() }};\n'
+		~ data.whitespace ~ data.whitespace
+		~ '}\n'
+		~ data.whitespace
+		~ '</style>\n'
+		~ '{% endif %}'
+	)}}
+
 	{{ macros.codeBlock('As rgb() syntax', '
 		{{ ' ~ data.sampleTag ~ '.rgb }}'
 	)}}
@@ -270,6 +289,19 @@
 
 {% endmacro -%}
 
+{%- macro cs_Email(data) %}
+	{% import _self as macros %}
+
+	{{ macros.codeBlock('Field name', '
+		{{ ' ~ data.sampleTag ~ ' }}'
+	)}}
+
+	{{ macros.codeBlock('"If exists" conditional', '
+		{% if ' ~ data.sampleTag ~ ' %} ... {% endif %}'
+	)}}
+
+{% endmacro -%}
+
 {%- macro cs_Entries(data) %}
 	{% import _self as macros %}
 
@@ -565,6 +597,19 @@
 
 {% endmacro -%}
 
+{%- macro cs_Redactor(data) %}
+	{% import _self as macros %}
+
+	{{ macros.codeBlock('Field name', '
+		{{ ' ~ data.sampleTag ~ ' }}'
+	)}}
+
+	{{ macros.codeBlock('"If exists" conditional', '
+		{% if ' ~ data.sampleTag ~ ' %} ... {% endif %}'
+	)}}
+
+{% endmacro -%}
+
 {%- macro cs_RichText(data) %}
 	{% import _self as macros %}
 
@@ -730,7 +775,7 @@
 	)}}
 
 
-	{{ macros.codeBlock('Avoid a loop if your field limits to 1 user', '
+	{{ macros.codeBlock('Avoid a loop if your field limits to 1 tag', '
 		{% if '
 		~ data.sampleTag
 		~ '.one() %}\n'

src/templates/frontEnd/_includes/_fieldMacros/Categories.twig

@@ -34,6 +34,6 @@
 		~ '{% if myCategory %}\n'
 		~ data.whitespace ~ '...\n'
 		~ '{% endif %}'
-	, 'This is mostly used in a scenario where you only expect one category to be selected. The result is still a "set" of categories so we just grab the "first" one.')}}
+	, 'This is mostly used in a scenario where you only expect one category to be selected. The result is still a "set" of categories so we just grab the first one.')}}
 
 {% endmacro -%}

src/templates/frontEnd/_includes/_fieldMacros/Checkboxes.twig

@@ -11,7 +11,7 @@
 	)}}
 
 
-	{{ macros.codeBlock('Loop through the *selected* options', '
+	{{ macros.codeBlock('Loop through the <em>selected</em> options', '
 		<ul>\n'
 		~ data.whitespace ~ '{% for option in '
 		~ data.sampleTag

src/templates/frontEnd/_includes/_fieldMacros/Color.twig

@@ -9,6 +9,25 @@
 		{% if ' ~ data.sampleTag ~ ' %} ... {% endif %}'
 	)}}
 
+	{{ macros.codeBlock('Adding to page style rules', '
+		{% if '
+		~ data.sampleTag
+		~ ' %}\n'
+		~ data.whitespace
+		~ '<style type="text/css">\n'
+		~ data.whitespace ~ data.whitespace
+		~ '.content a {\n'
+		~ data.whitespace ~ data.whitespace ~ data.whitespace
+		~ 'color: {{ '
+		~ data.sampleTag
+		~ '.getHex() }};\n'
+		~ data.whitespace ~ data.whitespace
+		~ '}\n'
+		~ data.whitespace
+		~ '</style>\n'
+		~ '{% endif %}'
+	)}}
+
 	{{ macros.codeBlock('As rgb() syntax', '
 		{{ ' ~ data.sampleTag ~ '.rgb }}'
 	)}}

src/templates/frontEnd/_includes/_fieldMacros/Email.twig

@@ -0,0 +1,12 @@
+{%- macro cs_Email(data) %}
+	{% import _self as macros %}
+
+	{{ macros.codeBlock('Field name', '
+		{{ ' ~ data.sampleTag ~ ' }}'
+	)}}
+
+	{{ macros.codeBlock('"If exists" conditional', '
+		{% if ' ~ data.sampleTag ~ ' %} ... {% endif %}'
+	)}}
+
+{% endmacro -%}

src/templates/frontEnd/_includes/_fieldMacros/Redactor.twig

@@ -0,0 +1,12 @@
+{%- macro cs_Redactor(data) %}
+	{% import _self as macros %}
+
+	{{ macros.codeBlock('Field name', '
+		{{ ' ~ data.sampleTag ~ ' }}'
+	)}}
+
+	{{ macros.codeBlock('"If exists" conditional', '
+		{% if ' ~ data.sampleTag ~ ' %} ... {% endif %}'
+	)}}
+
+{% endmacro -%}

src/templates/frontEnd/_includes/_fieldMacros/Tags.twig

@@ -26,7 +26,7 @@
 	)}}
 
 
-	{{ macros.codeBlock('Avoid a loop if your field limits to 1 user', '
+	{{ macros.codeBlock('Avoid a loop if your field limits to 1 tag', '
 		{% if '
 		~ data.sampleTag
 		~ '.one() %}\n'

src/templates/frontEnd/_includes/_fieldMacros/_template.txt

@@ -32,14 +32,16 @@
 		<p>You can setup extra info below your snippets.</p>
 	</div>
 
-	{{ macros.codeBlock('Field name', '
+	{{ macros.codeBlock(
+		'Field name', '
 		{{ ' ~ data.sampleTag ~ ' }}'
-	), 'This is an example of code-block specific additional text if you need to prefix the sample code with anything.'}}
+		'This is an example of code-block specific additional text if you need to prefix the sample code with anything.'
+	) }}
 
 
 	{{ macros.codeBlock('"If exists" conditional', '
 		{% if ' ~ data.sampleTag ~ '|length %} ... {% endif %}'
-	)}}
+	) }}
 
 	<div class="extra">
 		<p>Or you can setup extra info below your snippets.</p>