<commit_before>= Helpify


Copyright (c) 2010 kiszal , released under the MIT license<commit_msg>readme updated<commit_after>= Helpify

=== installation

 ./script/plugin install <EMAIL>:kiszal/helpify.git

=== set up and usage

Run:

 ./script/generate helpify
 
Flie help_settings.yml should be generated in your /config folder. 

Open it and provide all page urls where help informations should be displayed. 
Next to each url provide name of a partial which you want to display in this page.

You will find examples in file help_settings.yml

After that: 
 
 rake db:migrate 
 ./script/generate help_templates

Now you should have new app/views/helps folder in which help templates are generated. 

Edit each template and customize it according to your needs.

Helpify will display help templates on provided urls specified in help_settings.yml 
unless user closes it. 
 
Once user closes help it won't be displayed for him anymore.
   
In order to display template go to the page and add show_help(object) in the place
you want the help template to by displayed. 

Assuming your object is a current_user. 

You should add 
  
 helpify 

in User model and in each page where help template should be displayed add

 show_help(current_user)

To add new help templates just go to /config/help_settings.yml and update it. 
Than run:

 ./script/generate help_templates

Old templates would not be overriten - the new once would be added. 

== Copyright

Copyright (c) 2010 kiszal , released under the MIT license
{'fraction_non_alphanumeric': 0.045665122435473195, 'fraction_numerical': 0.005294506949040371, 'mean_word_length': 3.9250814332247557, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6903798', 'n_tokens_mistral': 432, 'n_tokens_neox': 399, 'n_words': 211}