Module Template Notes

[Soma]

Template Notes

Adds a "Help" tab to pages for notes and instructions on the current template used.

 

You can add content by simply putting a html or markdown file in /site/templates/notes/ the module will automatically load that file if it finds one and adds a "Help" tab to the page edit form.

 

 

Name the files using the template name. You can use html or markdown to write the help text.

 

- /site/templates/notes/[tplname].html

- /site/templates/notes/[tplname].md

 

To style the content you can specify a custom css file url you add to the module settings.

 

http://modules.processwire.com/modules/template-notes/

https://github.com/somatonic/TemplateNotes

This module was quickly written after seeing a wish-list request by Joss http://processwire.com/talk/topic/5016-help-tab-for-template/

[pwired]

+1 good found.

Useful and practical to keep track of structure of larger sites and keeping a history of edits.

[Pete]

Nice one Soma.

I was thinking of a more complicated solution earlier, so +1 for keeping it simple and effective as these notes only need to be written once per template by the person building the site really

[dazzyweb]

Looks good. Very useful. I am liking processwire even more

[hheyne]

+1 amazing!

[kongondo]

Well this is nice! Thanks Soma

[Lance O.]

This is a great module and a simple solution to providing contextual help for my clients. Thank you, Soma!

[Lance O.]

Oops, for some reason, the module isn't detecting my custom CSS file.

My path is correct:

site/templates/notes/notes.css

and the file exists when I visit it in a browser. I'm using PW 2.4.0.

[Soma]

Thanks for the report. I fixed the issue with custom CSS and committed it just now.

[Lance O.]

@soma Looks like that fix did the trick! Thank you for updating. I think I'm going to get a lot of use from this module.

[Soma]

Just fixed some issue with new PW 2.5 while still compatible with 2.4.

The module is now on v1.0.3 and updated on modules.processwire.com

https://github.com/somatonic/TemplateNotes/commit/7a16e25126d1f2b2ef2b4792edc00f70b9c2db1b

[Nico Knoll]

Nice

[Lance O.]

Is this module compatible with PW 3.x? I just installed it but the Help tab isn't displaying for the designated template.

[johndoe]

On 22.09.2016 at 7:33 PM, Lance O. said:

Is this module compatible with PW 3.x? I just installed it but the Help tab isn't displaying for the designated template.

I changed 2 lines in site/modules/TemplateNotes/TemplateNotes.module (starts at line 98)

        if(ProcessWire::versionMajor == 2 && ProcessWire::versionMinor <= 4)
            $form->append($tab);

        if(ProcessWire::versionMajor >= 2 && ProcessWire::versionMinor >= 5)
            $form->prepend($tab);

to

        if(ProcessWire::versionMajor == 3 && ProcessWire::versionMinor <= 4)
            $form->append($tab);

        if(ProcessWire::versionMajor >= 3 && ProcessWire::versionMinor >= 5)
            $form->prepend($tab);

Seems to be working on 3.0.40. Only glitch is the bottom Save button jumps above notes content.