Commit | Line | Data |
030fd7f2 |
1 | NAME |
4d766b14 |
2 | CatalystX::HelpText - Helper to include text/html snippets in Catalyst |
3 | View templates |
4 | |
5 | SYNOPSIS |
6 | Create a model class in your Catalyst project like: package |
7 | TestApp::Model::Help; use Moose; use namespace::autoclean; |
8 | |
9 | extends 'CatalystX::HelpText::Model'; |
10 | |
11 | 1; |
12 | |
13 | Configure it setting value for: |
14 | |
15 | help_files_path |
16 | Where the help files will be found |
17 | |
18 | help_files_ext |
19 | What is the extension for the help files (default: html) |
20 | |
21 | wrapper_tag |
22 | What tag will be used to wrap the shippet (default: span) |
23 | |
24 | wrapper_css_class |
25 | What css class will be applied to the wrapper tag (default: |
26 | help_text) |
27 | |
28 | Create files with the text/html to be included and store them at |
29 | help_files_path. |
30 | |
31 | Apply the CatalystX::HelpText::ViewRole in your View. |
32 | |
33 | Uses the "[% helptext('SomeHelpTopic') %]"in your templates to include |
34 | the file "SomeHelpTopic.html" in the page. |
35 | |
36 | Uses the script "search_undocumented_templates.pl" to find the missing |
37 | help text files. |
38 | |
39 | SEE ALSO |
40 | CatalystX::HelpText::Model |
41 | CatalystX::HelpText::ViewRole |
030fd7f2 |
42 | |
030fd7f2 |
43 | AUTHOR |
4d766b14 |
44 | Toomas Doran, "t0m at state51.co.uk" |
45 | |
46 | Cinxgler Mariaca Minda, "cinxgler at ci-info.com" |
030fd7f2 |
47 | |
48 | COPYRIGHT |
4d766b14 |
49 | Copyright Oscar Music and Media 2011. |
030fd7f2 |
50 | |
51 | LICENSE |
52 | This sofware is free software, and is licensed under the same terms as |
53 | perl itself. |
54 | |