Changeset 1885500
- Timestamp:
- 06/01/2018 01:54:51 PM (8 years ago)
- Location:
- advanced-footnotes/trunk
- Files:
-
- 2 edited
-
advanced-footnotes.php (modified) (1 diff)
-
readme.txt (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
advanced-footnotes/trunk/advanced-footnotes.php
r1885485 r1885500 3 3 Plugin Name: Advanced Footnotes 4 4 Description: Simple yet powerful footnotes integration on your WordPress site or theme itself. 5 Version: 0.11 25 Version: 0.114 6 6 Author: Yunus Tabakoğlu 7 7 Author URI: http://yunustabakoglu.com/ -
advanced-footnotes/trunk/readme.txt
r1885485 r1885500 13 13 With its internal functions, you can also implement Advanced Footnotes on your own theme in any form you like. 14 14 15 #Main Features:# 15 = Main Features: = 16 16 * Implemented WYSIWYG editor button. 17 17 * Footnotes can be implemented with shortcode or function. … … 21 21 * Dynamically changeable interface options (JS can be fully disabled) 22 22 23 #Usage# 23 = Usage = 24 24 25 ##Inserting a Footnote## 25 **Inserting a Footnote:** 26 26 In 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. 27 27 28 ##Listing Footnotes## 28 **Listing Footnotes:** 29 29 You can display the footnotes in two methods: 30 30 31 ###Shortcode:### 32 By simply inserting the * *[footnotes]** shortcode in your post content, you can display footnotes wherever you want in your posts.31 *Shortcode:* 32 By simply inserting the *[footnotes]* shortcode in your post content, you can display footnotes wherever you want in your posts. 33 33 34 **__Shortcode Parameters__** 34 Shortcode Parameters: 35 35 36 __"title":__Determines the title for the footnotes list. Default value can be set through plugin settings.36 *"title":* Determines the title for the footnotes list. Default value can be set through plugin settings. 37 37 38 * *__Shortcode Usage:__**38 *Shortcode Usage:* 39 39 40 ``` 41 [footnotes title="My Custom Footnotes Title"] 40 `[footnotes title="My Custom Footnotes Title"] 42 41 // or 43 [footnotes title="False"] 44 ``` 42 [footnotes title="False"]` 45 43 46 ###Theme Inclusion:### 44 **Theme Inclusion:** 47 45 48 46 You can print the footnotes by calling print_refs function from the advanced_footnotes class. 49 47 50 __Simple Function Usage:__ 48 *Simple Function Usage:* 51 49 52 ``` 53 call_user_func(array('advanced_footnotes', 'print_refs')); 54 ``` 50 `call_user_func(array('advanced_footnotes', 'print_refs'));` 55 51 56 * *__Additional Parameters:__**52 *Additional Parameters:* 57 53 58 First parameter: "Print", whether print or return the footnotes content. (Default: "true")59 Second parameter: "Title", determines the title for the footnotes content. (Default: "false")54 * First parameter: "Print", whether print or return the footnotes content. (Default: "true") 55 * Second parameter: "Title", determines the title for the footnotes content. (Default: "false") 60 56 61 __Function Usage with Parameters:__ 57 *Function Usage with Parameters:* 62 58 63 ``` 64 $footnotes = call_user_func_array(array('advanced_footnotes', 'print_refs'), array(false, 'Custom Footnotes Title')); 65 ``` 59 `$footnotes = call_user_func_array(array('advanced_footnotes', 'print_refs'), array(false, 'Custom Footnotes Title'));` 66 60 67 ###Plugin Options:### 61 = Plugin Options: = 68 62 69 63 You can access the plugin options through "Options/Advanced Footnotes". 70 64 71 -Include Plugin CSS: Determines whether to include the default plugin css files. Disable this if you want to re-style the plugin within your theme.72 -Custom CSS: Provides a field for custom CSS styling.73 -Include Plugin JS: Determines whether to include the plugin javascript files on the theme output. Disable this if you want to customize plugin interactions or just to use native HTML anchors.74 -Default Title for Footnotes: Sets the default title used on the "[footnotes]" shortcode.75 -Disable JS Options: Determines whether to apply options to the plugin JS files or not.76 -Footnotes Scroll Gap: This sets the scroll margin when clicked on a footnote. Set this when you have a fixed header or any other element blocking some part of the window area.77 -Footnote Scroll Speed: Sets the animation speed when a footnote is clicked. Set 0 for no animation.65 * Include Plugin CSS: Determines whether to include the default plugin css files. Disable this if you want to re-style the plugin within your theme. 66 * Custom CSS: Provides a field for custom CSS styling. 67 * Include Plugin JS: Determines whether to include the plugin javascript files on the theme output. Disable this if you want to customize plugin interactions or just to use native HTML anchors. 68 * Default Title for Footnotes: Sets the default title used on the "[footnotes]" shortcode. 69 * Disable JS Options: Determines whether to apply options to the plugin JS files or not. 70 * Footnotes Scroll Gap: This sets the scroll margin when clicked on a footnote. Set this when you have a fixed header or any other element blocking some part of the window area. 71 * Footnote Scroll Speed: Sets the animation speed when a footnote is clicked. Set 0 for no animation. 78 72 79 73 80 **__HTML Structure & Classes__** 74 = HTML Structure & Classes = 75 76 *This section will be updated later, meanwhile I encourage you to use the dom inspector.* 81 77 82 78 == Installation == … … 84 80 85 81 == Frequently Asked Questions == 86 - Can I implement Advanced Footnotes on my theme? 82 83 = Can I implement Advanced Footnotes on my theme? = 84 87 85 Yes you can. You can either get the footnotes as an object array, or simply print it with the Advanced Footnotes\' functions. 88 86 89 - Can I use it without editing my theme files? 87 = Can I use it without editing my theme files? = 88 90 89 Yes, you can simply use [footnote]*your note here*[/footnote] shortcode for each footnote you want to place, and [footnotes] shortcode to use put the footnotes wherever you want them to be. 91 90 91 = Contribution = 92 <https://github.com/yutonet/wp_advanced_footnotes> 93 92 94 == Changelog == 93 - **0.1** - Initial Release 94 - **0.11** 95 - Documentation 96 - Title display bug fixed. 95 = 0.1 = 96 **Initial Release** 97 98 * **0.11** 99 * Documentation 100 * Title display bug fixed.
Note: See TracChangeset
for help on using the changeset viewer.