WordPress.org
Get WordPress

Plugin Directory

Changeset 1885948


Ignore:
Timestamp:
06/02/2018 02:07:40 PM (8 years ago)
Author:
yutonet
Message:

Version 1.1.2

Location:
advanced-footnotes/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • advanced-footnotes/trunk/advanced-footnotes.php

    r1885933 r1885948  
    33        Plugin Name: Advanced Footnotes
    44        Description: Simple yet powerful footnotes integration on your WordPress site or theme itself.
    5         Version: 1.1.1
     5        Version: 1.1.2
    66        Author: Yunus Tabakoğlu
    77        Author URI: http://yunustabakoglu.com/

  • advanced-footnotes/trunk/readme.txt

    r1885933 r1885948  
    1313With its internal functions, you can also implement Advanced Footnotes on your own theme in any form you like.
    1414
    15 = Main Features: =
     15# Main Features:
    1616* Easy & flexible implementation.
    1717* Implemented WYSIWYG editor button.
    … …  
    2222* Dynamically changeable interface options (JS can be fully disabled)
    2323
    24 = Usage =
     24# Usage
    2525
    26 **Inserting a Footnote:**
     26## Inserting a Footnote:
    2727In order to insert a footnote, you can either use the "Insert Footnote" button added on your WYSIWYG editor, or use the [footnote]your-footnote-here[/footnote] shortcode.
    2828
    29 Shortcode Parameters:
     29### Shortcode Parameters:
    3030*"type":* Determines the type of the reference. **Options:** *numeric* / *non-numeric*.
    3131
    32 **Listing Footnotes:**
     32## Listing Footnotes:
    3333You can display the footnotes in two methods:
    3434
    35 *Listing by Shortcode:*
     35### Listing by Shortcode:
    3636By simply inserting the *[footnotes]* shortcode in your post content, you can display footnotes wherever you want in your posts.
    3737
    38 Shortcode Parameters:
     38#### Shortcode Parameters:
    3939
    4040*"title":* Determines the title for the footnotes list. Default value can be set through plugin settings.
    4141
    42 Shortcode Usage:
     42#### Shortcode Usage:
    4343
    44 `[footnotes title="My Custom Footnotes Title"]
    45 // or
    46 [footnotes title="false"]`
     44    [footnotes title="My Custom Footnotes Title"]
     45    // or
     46    [footnotes title="false"]
    4747
    48 *Listing by Theme Inclusion:*
     48### Listing by Theme Inclusion:
    4949
    50 You can print the footnotes by calling print_refs function from the advanced_footnotes class.
     50You can print the footnotes by calling *print_refs* function from the advanced_footnotes class.
    5151
    52 Simple Function Usage:
     52#### Simple Function Usage:
    5353
    54 `call_user_func(array('advanced_footnotes', 'print_refs'));`
     54    call_user_func(array('advanced_footnotes', 'print_refs'));
    5555
    56 Additional Parameters:
     56#### Additional Parameters:
    5757
    5858* First parameter: "Print", whether print or return the footnotes content. (Default: "true")
    5959* Second parameter: "Title", determines the title for the footnotes content. (Default: "false")
    6060
    61 Function Usage with Parameters:
     61#### Function Usage with Parameters:
    6262
    63 `$footnotes = call_user_func_array(array('advanced_footnotes', 'print_refs'), array(false, 'Custom Footnotes Title'));`
     63    $footnotes = call_user_func_array(array('advanced_footnotes', 'print_refs'), array(false, 'Custom Footnotes Title'));
    6464
    65 = Plugin Options: =
     65## Plugin Options:
    6666
    6767You can access the plugin options through "Options/Advanced Footnotes".
    … …  
    7676* **Footnote Scroll Speed:** Sets the animation speed when a footnote is clicked. Set 0 for no animation.
    7777
    78 = HTML Structure & Classes =
     78## HTML Structure & Classes
    7979
    80 ** Anchors: **
     80### Anchors:
    8181
    82 *Numeric Anchor:*
    83 `<a id="{unique id}" class="afn-footnotes-ref hook numeric" name="{unique id}" href="#{unique id of the reference}">{number - automatically incremented by the order}</a>`
     82#### Numeric Anchor:
     83   
     84    <a id="{unique id}" class="afn-footnotes-ref hook numeric" name="{unique id}" href="#{unique id of the reference}">{number - automatically incremented by the order}</a>
    8485
    85 *Non-numeric Anchor:*
    86 `<a id="{unique id}" class="afn-footnotes-ref hook non-numeric" name="{unique id}" href="#{unique id of the reference}">footnote symbol</a>`
     86#### Non-numeric Anchor:
     87   
     88    <a id="{unique id}" class="afn-footnotes-ref hook non-numeric" name="{unique id}" href="#{unique id of the reference}">footnote symbol</a>
    8789
    88 ** References: **
     90### References:
    8991
    9092Non-numbered references are listed before the numbered references on the list.
    9193
    92 `<!-- Main Container -->
    93 <div class="afn-footnotes">
     94    <!-- Main Container -->
     95    <div class="afn-footnotes">
    9496
    95     <!-- Title -->
    96     <h3 class="afn-footnotes-title">{Title}</h3>
     97        <!-- Title -->
     98        <h3 class="afn-footnotes-title">{Title}</h3>
    9799
    98     <!-- List of references -->
    99     <ul class="afn-footnotes-list">
     100        <!-- List of references -->
     101        <ul class="afn-footnotes-list">
    100102
    101         <!-- Reference item - non-numeric -->
    102         <li class="footnote-item afn-textarea">
    103             <a id="{unique id}" class="afn-footnotes-ref reference non-numeric" name="{unique id}" href="#{unique id of the anchor}">{footnote symbol}</a>
    104         </li>
     103            <!-- Reference item - non-numeric -->
     104            <li class="footnote-item afn-textarea">
     105                <a id="{unique id}" class="afn-footnotes-ref reference non-numeric" name="{unique id}" href="#{unique id of the anchor}">{footnote symbol}</a>
     106            </li>
    105107
    106         <!-- Reference item - numeric -->
    107         <li class="footnote-item afn-textarea">
    108             <a id="{unique id}" class="afn-footnotes-ref reference numeric" name="{unique id}" href="#{unique id of the anchor}">{number - automatically incremented by the order}</a>
    109         </li>
     108            <!-- Reference item - numeric -->
     109            <li class="footnote-item afn-textarea">
     110                <a id="{unique id}" class="afn-footnotes-ref reference numeric" name="{unique id}" href="#{unique id of the anchor}">{number - automatically incremented by the order}</a>
     111            </li>
    110112
    111     </ul>
     113        </ul>
    112114
    113 </div>`
     115    </div>
    114116
    115 = Known Issues =
     117# Known Issues
    116118
    117119* WYSIWYG Button doesn't work on the plugin [TinyMCE Advanced](https://wordpress.org/plugins/tinymce-advanced/) (and probably on some other -WYSIWYG editor modifying- plugins).
    118120
    119 = Contribution =
     121# Contribution
    120122
    121123<https://github.com/yutonet/wp_advanced_footnotes>
    … …  
    137139
    138140= 1.1 =
     141
     142* **1.1.2**
     143    * Fixes on the readme file.
    139144
    140145* **1.1.1**
Note: See TracChangeset for help on using the changeset viewer.