Changes between Version 28 and Version 29 of WikiGoodiesPlugin


Ignore:
Timestamp:
Jul 20, 2015, 1:22:55 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • WikiGoodiesPlugin

    v28 v29  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Wiki Goodies for Trac =
     3= Wiki Goodies for Trac
    44
    5 == Description ==
     5== Description
    66
    7 This plugin extends the Trac Wiki in several ways:
     7This plugin extends the Trac wiki in several ways:
    88 * Simplified markup for single words: `*this* /is/ _important_`
    99   becomes '''this''' ''is'' __important__ [[comment(replace by *this* /is/ _important_)]]
    … …  
    1919     * Replace <name@domain> with "mailto:" links (obfuscated if needed) (0.11 only - though that's now in Trac core)
    2020
    21 
    2221Each feature can be disabled individually if needed.
    2322
    24 == Install ==
     23Alternatives:
     24 * EmoticonsPlugin: provides support for smileys, and is a little bit more lightweight than this plugin.
     25 * EntityMacro: returns HTML 4.01 numeric character entity references from their corresponding names.
     26 * WikiExtrasPlugin: supersedes most of the features of this plugin, except for the simplified markup for single words and Mozilla features. You can disable all but those two modules and use both plugins together.
    2527
    26 See generic instructions in Trac:TracPlugins#InstallingaTracPlugin.
    27 
    28 === Enable ===
    29 
    30 If you need to enable the plugin in the trac.ini, use:
    31 {{{
    32 [components]
    33 goodies.* = enabled
    34 }}}
    35 
    36 == Usage ==
    37 
    38 There are 3 new macros that can be used to conveniently display all the newly introduced markup.
    39 
    40 Simply copy&paste the following wiki snippet somewhere into your Wiki (e.g. in WikiFormatting):
    41 
    42  Note:: the argument below - between '( )' - is the number of columns to be used in the displayed table.
    43 
    44 === Smileys ===
    45 {{{
    46 [[ShowSmileys(5)]]
    47 }}}
    48 
    49 === Entities ===
    50 {{{
    51 [[ShowEntities(4)]]
    52 }}}
    53 
    54 For the entities, only the named ones are shown.
    55 
    56 For help on using the numerical entities, see for example those [http://home.tiscali.nl/t876506/entitiesTips.html tips].
    57 
    58 === Symbols ===
    59 {{{
    60 [[ShowSymbols(5)]]
    61 }}}
    62 
    63 == Bugs/Feature Requests ==
     28== Bugs/Feature Requests
    6429
    6530Existing bugs and feature requests for WikiGoodiesPlugin are
    6631[report:9?COMPONENT=WikiGoodiesPlugin here].
    6732
    68 === Known Issues ===
     33If you have any new issue of feature request, create a
     34[/newticket?component=WikiGoodiesPlugin new ticket].
    6935
    70 [[TicketQuery(status!=closed&component=WikiGoodiesPlugin&type=defect)]]
     36[[TicketQuery(component=WikiGoodiesPlugin&group=type,format=progress)]]
    7137
    72 If you have any new issue of feature request, create a
    73 [http://trac-hacks.org/newticket?component=WikiGoodiesPlugin&owner=cboos new ticket].
    74 
    75 == More about UNC path support ==
    76 
    77 Turning off the UNC paths transformation might be seen as a
    78 [http://kb.mozillazine.org/Links_to_local_pages_don%27t_work security measure]
    79 and if someone can demonstrate that this feature presents
    80 a security risk, I'll disable it by default in future releases.
    81 But here, the "file:" links are user-oriented and can't possibly be embedded
    82 in a <img> tag or Javascript code, so I don't really see what could be the risk,
    83 and I think it's OK to enable this feature by default.
    84 
    85 Firefox doesn't do anything with the `file:` links, but
    86 users can use the [http://locallink.mozdev.org/ LocalLink] plugin
    87 ([https://addons.mozilla.org/en-US/firefox/addon/281 install]).
    88 
    89 Alternatively, I use the ''"Open Link in Ext.App."'' contextual menu entry provided
    90 by the [http://ietab.mozdev.org/ IETab] plugin
    91 ([https://addons.mozilla.org/en-US/firefox/addon/1419 install]),
    92 and this works great.
    93 
    94 Chrome has also its own [https://chrome.google.com/webstore/detail/jllpkdkcdjndhggodimiphkghogcpida LocalLinks] plugin, which was modeled after the Firefox extension.
    95 
    96 
    97 === Local Paths ===
    98 
    99 Using IETab within Firefox even allows you to use links local paths
    100 (say, `S:\Public\File.txt`) by using the equivalent UNC path `\\?\S:\Public\File.txt`,
    101 which is recognized as a link by the plugin and will be opened correctly by IETab
    102 ''"Open Link in Ext.App."''.
    103 Note that S:\Public\File.txt itself isn't recognized as a link (and probably
    104 will never be, as that will conflict with one letter InterTrac prefixes) and
    105 that the `file:///?/` file link produced by the plugin are ''not''
    106 understood by IE7 or IETab plugin ''"Open Link in IE Tab"'' (I haven't tested the !LocalLink plugin).
    107 
    108 == Source code & Download ==
     38== Download and Source
    10939
    11040A. You can download the zipped source:
    … …  
    11848C. or also [source:wikigoodiesplugin browse] the code from within Trac (recommended!).
    11949
    120 === Recent Changes ===
     50== Installation
     51
     52See generic instructions in Trac:TracPlugins#InstallingaTracPlugin.
     53
     54If you need to enable the plugin in the `trac.ini` file, use:
     55{{{#!ini
     56[components]
     57goodies.* = enabled
     58}}}
     59
     60== Usage
     61
     62There are 3 new macros that can be used to conveniently display all the newly introduced markup.
     63
     64Simply copy&paste the following wiki snippet somewhere into your Wiki (e.g. in WikiFormatting):
     65
     66 Note:: the argument below - between '( )' - is the number of columns to be used in the displayed table.
     67
     68=== Smileys
     69
     70{{{
     71[[ShowSmileys(5)]]
     72}}}
     73
     74=== Entities
     75
     76{{{
     77[[ShowEntities(4)]]
     78}}}
     79
     80For the entities, only the named ones are shown.
     81
     82For help on using the numerical entities, see for example those [http://home.tiscali.nl/t876506/entitiesTips.html tips].
     83
     84=== Symbols
     85
     86{{{
     87[[ShowSymbols(5)]]
     88}}}
     89
     90== More about UNC path support
     91
     92Turning off the UNC paths transformation might be seen as a [http://kb.mozillazine.org/Links_to_local_pages_don%27t_work security measure] and if someone can demonstrate that this feature presents a security risk, I'll disable it by default in future releases.
     93But here, the "file:" links are user-oriented and can't possibly be embedded in a <img> tag or Javascript code, so I don't really see what could be the risk, and I think it's OK to enable this feature by default.
     94
     95Firefox doesn't do anything with the `file:` links, but users can use the [http://locallink.mozdev.org/ LocalLink] plugin
     96([https://addons.mozilla.org/en-US/firefox/addon/281 install]).
     97
     98Alternatively, I use the ''"Open Link in Ext.App."'' contextual menu entry provided by the [http://ietab.mozdev.org/ IETab] plugin
     99([https://addons.mozilla.org/en-US/firefox/addon/1419 install]) and this works great.
     100
     101Chrome has also its own [https://chrome.google.com/webstore/detail/jllpkdkcdjndhggodimiphkghogcpida LocalLinks] plugin, which was modeled after the Firefox extension.
     102
     103=== Local Paths
     104
     105Using IETab within Firefox even allows you to use links local paths (say, `S:\Public\File.txt`) by using the equivalent UNC path `\\?\S:\Public\File.txt`, which is recognized as a link by the plugin and will be opened correctly by IETab ''"Open Link in Ext.App."''.
     106Note that S:\Public\File.txt itself isn't recognized as a link (and probably will never be, as that will conflict with one letter InterTrac prefixes) and that the `file:///?/` file link produced by the plugin are ''not'' understood by IE7 or IETab plugin ''"Open Link in IE Tab"'' (I haven't tested the !LocalLink plugin).
     107
     108== Recent Changes
    121109
    122110[[ChangeLog(wikigoodiesplugin, 3)]]
    123111
    124 == See Also ==
    125 
    126 The EmoticonsPlugin also provides support for smileys, and is a little bit more lightweight than this plugin.
    127 
    128 The EntityMacro package returns HTML 4.01 numeric character entity references from their corresponding names.
    129 
    130 The WikiExtrasPlugin supersedes most of the features of this plugin, except for the simplified markup for single words and mozilla features. You can disable all but those two modules and use both plugins together.
    131 
    132 == Author/Contributors ==
     112== Author/Contributors
    133113
    134114'''Author:''' [wiki:cboos] [[BR]]
    135 '''Maintainer:''' [wiki:mrelbe] [[BR]]
     115'''Maintainer:''' [[Maintainer]] [[BR]]
    136116'''Contributors:'''