├── .editorconfig
├── README.md
├── entryinstructions
    ├── EntryInstructionsPlugin.php
    ├── fieldtypes
    │   └── EntryInstructions_InstructionsFieldType.php
    └── templates
    │   └── _instructions
    │       └── layout.html
└── screenshot.png


/.editorconfig:
--------------------------------------------------------------------------------
 1 | # http://editorconfig.org
 2 | 
 3 | # Top-most EditorConfig file
 4 | root = true
 5 | 
 6 | # All files
 7 | [*]
 8 | charset = utf-8
 9 | insert_final_newline = true
10 | 
11 | [*.{js,json}]
12 | indent_size = 4
13 | indent_style = space
14 | trim_trailing_whitespace = true
15 | 
16 | [*.{scss,css}]
17 | indent_size = 2
18 | indent_style = space
19 | trim_trailing_whitespace = true
20 | 
21 | [*.{html,php,rb,xml}]
22 | indent_size = 4
23 | indent_style = space
24 | trim_trailing_whitespace = true
25 | 
26 | [*.md]
27 | indent_style = tab
28 | trim_trailing_whitespace = false
29 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Entry Instructions Plugin for Craft CMS
 2 | =================
 3 | 
 4 | Inspired by [NSM Publish Hints](http://ee-garage.com/nsm-publish-hints).
 5 | 
 6 | ### Installation
 7 | 
 8 | Upload the entryinstructions/ folder to your craft/plugins/ folder.
 9 | 
10 | ### Usage
11 | 
12 | 1. Create a new field
13 | 2. Set the Field Type to "Instructions"
14 | 3. Write your instructions in Markdown
15 | 
16 | ### Screenshot
17 | 
18 | <img src="screenshot.png" alt="Screenshot of Instructions in Control Panel" width="100%">
19 | 


--------------------------------------------------------------------------------
/entryinstructions/EntryInstructionsPlugin.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Craft;
 3 | 
 4 | class EntryInstructionsPlugin extends BasePlugin
 5 | {
 6 |     function getName()
 7 |     {
 8 |         return Craft::t('Entry Instructions');
 9 |     }
10 | 
11 |     function getVersion()
12 |     {
13 |         return '1.1.0';
14 |     }
15 | 
16 |     function getDeveloper()
17 |     {
18 |         return 'Thomas Cunningham';
19 |     }
20 | 
21 |     function getDeveloperUrl()
22 |     {
23 |         return 'https://github.com/thomasthesecond/EntryInstructions';
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/entryinstructions/fieldtypes/EntryInstructions_InstructionsFieldType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Craft;
 3 | 
 4 | class EntryInstructions_InstructionsFieldType extends BaseFieldType
 5 | {
 6 |     public function getName()
 7 |     {
 8 |         return Craft::t('Instructions');
 9 |     }
10 | 
11 |     public function getInputHtml($name, $value)
12 |     {
13 |         // Reformat the input name into something that looks more like an ID
14 |         $id = craft()->templates->formatInputId($name);
15 | 
16 |         // Figure out what that ID is going to look like once it has been namespaced
17 |         $namespacedId = craft()->templates->namespaceInputId($id);
18 | 
19 |         return craft()->templates->render('entryinstructions/_instructions/layout', array(
20 |             'name'  => $name,
21 |             'id'    => $id,
22 |             'value' => $value
23 |         ));
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/entryinstructions/templates/_instructions/layout.html:
--------------------------------------------------------------------------------
 1 | <style type="text/css">
 2 |     #fields-{{ id }}-field .heading label {
 3 |       display: none;
 4 |     }
 5 | 
 6 |     #fields-{{ id }}-field .heading .instructions {
 7 |       background-color: #f9fafa;
 8 |       border-radius: 2px;
 9 |       box-shadow: inset 0 0 0 1px rgba(0, 0, 0, .1);
10 |       color: #53524f;
11 |       font-family: 'HelveticaNeue', 'Helvetica Neue', 'Helvetica', sans-serif;
12 |       font-size: 13px;
13 |       line-height: 16px;
14 |       min-height: 30px;
15 |       padding: 22px 24px 20px;
16 |       position: relative;
17 |     }
18 | 
19 |     #fields-{{ id }}-field .heading .instructions:before {
20 |         background-color: #0d78f2;
21 |         border-radius: 2px 0 0 2px;
22 |         content: '';
23 |         height: 100%;
24 |         left: 0;
25 |         position: absolute;
26 |         top: 0;
27 |         width: 4px;
28 |     }
29 | 
30 |     #fields-{{ id }}-field .heading .instructions h1,
31 |     #fields-{{ id }}-field .heading .instructions h2,
32 |     #fields-{{ id }}-field .heading .instructions h3,
33 |     #fields-{{ id }}-field .heading .instructions h4,
34 |     #fields-{{ id }}-field .heading .instructions h5,
35 |     #fields-{{ id }}-field .heading .instructions h6 {
36 |       color: #0d78f2;
37 |       font-family: inherit;
38 |       font-weight: 700;
39 |       line-height: 1;
40 |     }
41 | 
42 |     #fields-{{ id }}-field .heading .instructions h1,
43 |     #fields-{{ id }}-field .heading .instructions h2 {
44 |       border-bottom: 1px solid rgba(0, 0, 0, .1);
45 |       padding-bottom: 6px;
46 |     }
47 | 
48 |     #fields-{{ id }}-field .heading .instructions h1 { font-size: 19px; margin-bottom: 0; }
49 |     #fields-{{ id }}-field .heading .instructions h2 { font-size: 17px; }
50 |     #fields-{{ id }}-field .heading .instructions h3 { font-size: 15px; }
51 |     #fields-{{ id }}-field .heading .instructions h4 { font-size: 13px; }
52 |     #fields-{{ id }}-field .heading .instructions h5 { font-size: 11px; }
53 |     #fields-{{ id }}-field .heading .instructions h6 { font-size:  9px; }
54 | 
55 |     #fields-{{ id }}-field .heading .instructions p { max-width: 70%; }
56 | 
57 |     #fields-{{ id }}-field .heading .instructions a { text-decoration: underline; }
58 | </style>
59 | 


--------------------------------------------------------------------------------
/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/thomasthesecond/EntryInstructions/41e53d8aaf9fbbd36ef3951b642c919964b63152/screenshot.png


--------------------------------------------------------------------------------