Plugin Directory

Changeset 611913


Ignore:
Timestamp:
10/13/2012 11:47:07 AM (13 years ago)
Author:
ti2m
Message:

Shortcode doc

Location:
edge-suite/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • edge-suite/trunk/admin/usage.php

    r608321 r611913  
    1010    <li>Make sure /wp-content/uploads/edge_suite was created and is writable.
    1111    </li>
    12     <li>Backup your complete theme folder.</li>
    13     <li>Find the header.php file in your theme.</li>
    14     <li>Insert the following snippet in the header section where the
    15       compositions should appear:
     12    <li>Publish your project in Adobe Edge with option "Animate Deployment Package". It will generate a single OAM file.</li>
     13    <li>Go to <a href="/wp-admin/admin.php?page=edge-suite/edge-suite.php">Manage</a>,
     14        select the oam file in the "publish/animate package" folder and upload it.
     15    </li>
     16    <li>Upload as many composition as you want.</li>
     17
     18    <li>After uploading, the compositions can be placed in multiple ways on the website:</li>
     19    <ol>
     20        <li><strong>Shortcodes:</strong>
     21            <ul>
     22                <li>Take a look at the manage page drop down and remember the id of the composition you want to integrate. E.g. for "3 - My first edge compositions" the id is 3.</li>
     23                <li>Edit a page and include [edge_animation id="3"] where 3 is of course your composition id.</li>
     24                <li>Save the post, the composition shows up.</li>
     25                <li>You can also use [edge_animation id="3" left="auto"] to center the stage on the page.</li>
     26                <li>If you want to define a pixel base left an top offset of e.g. 10px from the left and 20px from the top, try [edge_animation id="3" left="10" top="20"]</li>
     27            </ul>
     28        </li>
     29        <li><strong>Template based:</strong>
     30            <ul>
     31
     32                <li>Here you insert a PHP snippet in your theme files:</li>
     33                <li>Backup your complete theme folder.</li>
     34                <li>Find e.g. the header.php file in your theme.</li>
     35                <li>Insert the following snippet where the compositions should
     36                    appear:
    1637      <pre>
    1738        &lt;?php
     
    2142        ?&gt;
    2243      </pre>
    23       Placing the code within in a link tag (&lt;a href=""...) can cause
    24       problems when the composition is interactive.
    25       You might also want to remove code that places other header images e.g.
    26       calls to header_image() or get_header_image() in
    27       case the composition should be the only thing in the header.
    28     </li>
    29     <li>Publish your project in Adobe Edge with option "Animate Deployment Package". It will generate a single OAM file.</li>
    30     <li>Go to <a href="/wp-admin/admin.php?page=edge-suite/edge-suite.php">Manage</a>,
    31       select the oam file in the "publish/animate package" folder and upload it.
    32     </li>
    33     <li>Upload as many composition as you want.</li>
    34     <li><p>After uploading, the compositions can be placed in multiple ways on
    35       the website:</p>
    36       <ol>
    37         <li>Default: A composition that should be shown on all pages can be
    38           selected on the <a
    39             href="/wp-admin/admin.php?page=edge-suite/edge-suite.php">settings
    40             page</a> "Default composition".
     44                    Placing the code within in a link tag (&lt;a href=""...) can cause
     45                    problems when the composition is interactive.
     46                    You might also want to remove code that places other header images e.g.
     47                    calls to header_image() or get_header_image() in
     48                    case the composition should be the only thing in the header.
     49                </li>
     50
     51
     52                <li><p>You now have three options to tell wordpress which composition to show
     53                    where the PHP snippet was placed.</p>
     54                    <ol>
     55                        <li>Default: A composition that should be shown on all pages can be
     56                            selected on the <a
     57                                    href="/wp-admin/admin.php?page=edge-suite/edge-suite.php">settings
     58                                page</a> "Default composition".
     59                        </li>
     60                        <li>Homepage: A composition that is only meant to show up on the
     61                            homepage can also be selected there.
     62                        </li>
     63                        <li>Page/Post: In editing mode each post or a page has a composition
     64                            selection that, when chosen, will overwrite the default composition.
     65                        </li>
     66                    </ol>
     67                </li>
     68            </ul>
    4169        </li>
    42         <li>Homepage: A composition that is only meant to show up on the
    43           homepage can also be selected there.
    44         </li>
    45         <li>Page/Post: In editing mode each post or a page has a composition
    46           selection that, when chosen, will overwrite the default composition.
    47         </li>
    48       </ol>
    49     </li>
    50   </ol>
     70    </ol>
     71
    5172
    5273  Please report any bugs to the <a
    5374  href="http://wordpress.org/support/plugin/edge-suite">Edge Suite support
    54   queue</a>.
     75  queue</a>.<br>
     76  More resources on <a href="http://edgedocks.com/edge-suite">Edgedocks - Edge Suite</a>
    5577
    5678  <h3>Features</h3>
  • edge-suite/trunk/readme.txt

    r608321 r611913  
    3434== Frequently Asked Questions ==
    3535
     36= General things to check when problems occur =
     37
     38* Open the debug console in Chrome (mac: alt + cmd + j) or Firefox and check for JavaScript errors.
     39
    3640= Animations don't show up =
     41
    3742Uploading worked but nothings shows up on the page. Things to check:
    3843
     
    4651
    4752* If "stage" or "_preloader" are not found, disable other plugins for testing to check if they might interferer.
    48 
    49 * Open the debug console in Chrome (mac: alt + cmd + j) or Firefox and check for JavaScript errors.
    5053
    5154* For testing remove all other fancy JavaScript like galleries, slideshows, etc. that are placed alongside the animation, the JS might collide.
     
    67701. Make sure /wp-content/uploads/edge_suite was created and is writable.
    68711. Backup your complete theme folder.
    69 1. Find the header.php file in your theme.
    70 1. Insert the following snippet in the header section where the compositions should appear (inside php tags):
    71       if(function_exists('edge_suite_view')){echo edge_suite_view();}   
    72    
    73 1.  Placing the code within in a link tag (<a href=""...) can cause problems when the composition is interactive.
    74 1.  You might also want to remove code that places other header images e.g. calls to header_image() or get_header_image() in case the composition should be the only thing in the header.
    75721. Publish your project in Adobe Edge with option "Animate Deployment Package". It will generate a single OAM file.
    76731. Go to "Edge Suite > Manage", select the oam file and upload it.
    77741. Upload as many composition as you want.
    78751. After uploading, the compositions can be placed in multiple ways on the website:
     761. Shortcodes:
     77    * Take a look at the manage page drop down and remember the id of the composition you want to integrate. E.g. for "3 - My first edge compositions" the id is 3.
     78    * Edit a page and include [edge_animation id="3"] where 3 is of course your composition id.
     79    * Save the post, the composition shows up.
     80    * You can also use [edge_animation id="3" left="auto"] to center the stage on the page.
     81    * If you want to define a pixel base left an top offset of e.g. 10px from the left and 20px from the top, try [edge_animation id="3" left="10" top="20"]
     821. Template based:
     83    * Here you insert a PHP snippet in your theme files:
     84    * Find e.g. the header.php file in your theme.
     85    * Insert the following snippet where the compositions should appear (inside php tags):
     86
     87      if(function_exists('edge_suite_view')){echo edge_suite_view();}
     88
     89    * Placing the code within in a link tag (<a href=""...) can cause problems when the composition is interactive.
     90    * You now have three options to tell wordpress which composition to show where the PHP snippet was placed.
    7991    * Default: A composition that should be shown on all pages can be selected on the "Edge Suite > settings" page under "Default composition".
    8092    * Homepage: A composition that is only meant to show up on the homepage can also be selected there.
Note: See TracChangeset for help on using the changeset viewer.