Mk Labs

EEasy Capture 1.0

Documentation

Summary

  1. Description
      1. What is EEasy Capture?
      2. How it works
  2. Notes
  3. System requirements
      1. EE2
      2. EE3
  4. Instalation
      1. EE2
      2. EE3
  5. Activation
      1. EE2
      2. EE3
  6. Tags
      1. Capture

Contents

  • Description

    - top
      • What is EEasy Capture?

        - top
        • EEasy Capture is an Expression Engine addon module that captures (saves) input data from a given area of html input controls.
        • This is usefull for example if you have a feedback form and you want to get as much feedback as you can from user. In case an user type data in the form but then he decides to leave the page, than the data will not be lost but will be saved by the module.
      • How it works

        - top
        • When the window 'beforeunload' event or the focused input control 'change' event is triggered for input controls that are being captured, the injected functionality performs an ajax request to the EEasy Capture back-end module to capture the data.
        • The addon module saves data to the server side in .json files in {modules directory}/eeasy_capture/{given name}/
        • The captured data can be viewed in the control panel in the addon module's page.

  • Notes

    - top
    • The application includes the jQuery v1.5 plugin via CDN.

  • System requirements

    - top

  • Instalation

    - top
      • EE2

        - top
        • Download EEasy Capture
        • Extract the .zip file on your computer.
        • Copy the extraced content in to the /system/expressionengine/third_party/ directory.
      • EE3

        - top
        • Download EEasy Capture
        • Extract the .zip file on your computer.
        • Copy the extraced content in to the /system/user/addons/ directory.

  • Activation

    - top
      • EE2

        - top
        • Log into your ExpressionEngine control panel.
        • Navigate to Add-Ons / Modules.
        • Select Install button in the row for EEasy Capture.
      • EE3

        - top
        • Log into your ExpressionEngine control panel.
        • Navigate to Develper / Addons.
        • Scroll down to the Third Party Add-Ons section.
        • Select Install button in the row for EEasy Capture.

  • Tags

    - top
      • Capture

        - top
          • Description - top
            • The capture tag captures data from html input controls that are sorounded by the tag.
            • This tag captures ONLY html inputs of type text and textarea.

          • Parameters - top
                  • name
                    The name parameters sets the name of the capturing directory.

          • Example - top
            <!-- this input is NOT captured by the tag -->
            <input type="text" name="outside_test_name" />
            
            <form>
              <!-- input elements captured by the tag -->
              {exp:eeasy_capture:capture name="test"}
                <input name="captured_input_name" type="text"></input>
            
                <textarea name="captured_textarea_name"></textarea>
            	
                <button id="btn" value="not_affected_button"></button>
              {/exp:eeasy_capture:capture}
              
              <input type="submit" value="post">
            </form>