README.md
1# Interwiki Formatting Dokuwiki Plugin
2
3[](https://opensource.org/licenses/MIT)
4[](https://www.dokuwiki.org/dokuwiki)
5[](https://www.dokuwiki.org/plugin:interwikiformatting)
6[](https://gitlab.com/JayJeckel/interwikiformatting)
7[](https://gitlab.com/JayJeckel/interwikiformatting/issues)
8[](https://gitlab.com/JayJeckel/interwikiformatting/repository/archive.zip?ref=master)
9
10Interwiki links are a powerful and time saving tool in the belt of any Dokuwiki editor, especially on wikis that provide various custom shortcuts to often used sites. However, they do have one drawback, namely that you either have to accept the displaying of the URL part in whatever form is required for the related site or you have to constantly add titles that more often than not only differ from the URL part by their formatting.
11
12This plugin attempts to solve that issue by automating the formatting of interwiki links that don't have a title manually defined. For sites like Tv Tropes where page ids are composed of multiple words run together without spaces the plugin will reinsert them and on sites like Wikipedia where page ids are made of words separated by underscores or other delimiters the plugin will replace them with spaces. The displayed title will then have the capitalization of words standardized into common title case where all words except articles, conjunctions, prepositions, and uppercase acronyms start with a capital letter.
13
14This automation of formatting and the configurability provided by the plugin's settings should simplify the use of interwiki links, standardize their displayed appearance, and save time for any editor using them.
15
16## Installation
17
18Install the plugin using the [Extension Manager](https://www.dokuwiki.org/plugin:extension) with the download URL above, which points to latest version of the plugin. Refer to [Plugins](https://www.dokuwiki.org/plugins) on how to install plugins manually.
19
20## Usage
21
22This plugin requires no special syntax, simply use interwiki links, *[[shortcut>Some_Page#OptionalAnchor]]*, as normal and the automatic formatting will be applied unless the interwiki link already has a title defined, *[[shortcut>Some_Page#OptionalAnchor|No Formatting Applied Here Because I Already Have A Title]]*.
23
24## Configuration Settings
25
26The Interwiki Formatting Plugin has eight settings that can be set in the Dokuwiki Configuration Manager:
27
28 - **Ignored Shortcut List** (*ignored_shortcuts*) - A space separated list of interwiki shortcuts that should not receive any automatic formatting. The default list includes the *user* and *skype* shortcuts.
29 - ** Strip Query Toggle** (*strip_query*) - Whether or not the query part of the interwiki link should be stripped from the displayed title. This setting is enabled by default.
30 - **Strippable Extension List** (*strippable_extensions*) - A space separated list of extensions that should be removed from the end of interwiki link titles. The default list includes *asp*, *htm*, *html*, and *php*.
31 - **Word Separator List** (*word_separators*) - A space separated list of characters that should be replaced by a space when the title is formatted. The default list includes *_*, *:*, *.*, and *-*.
32 - **Anchor Replacement Text** (*anchor_replacement*) - The text that the anchor symbol (#) will be replaced by unless it is the first or last character of the string, in which case it will be remove entirely. The default value is a dash with a space on both sides (* - *).
33 - **Slash Replacement Text** (*slash_replacement*) - The text that the common path separator symbol (/) will be replaced by unless it is the first or last character of the string, in which case it will be remove entirely. The default value is a dash with a space on both sides (* - *).
34 - **Capitalize Words Toggle** (*capitalize_words*) - Whether or not all words in the display interwiki link title should be capitalized. This setting is enabled by default.
35 - **Capitalize Exceptions List** (*capitalize_exceptions*) - A space separated list of words that should not be capitalized. This setting is ignored if capitalizing of words is disabled. The words in this list will still be capitalized if they are the first or last word of the title, the first word after the anchor or slash replacement text, or the last word before the anchor of slash replacement text. The default word list includes *the*, *of*, *a*, *an*, *and*, *but*, *or*, *for*, *nor*, *are*, *in*, and *at*.
36
37## Security
38
39There are currently no know vulnerabilities related to normal use of the mod. The mod takes advantage of the built-in methods for creating interwiki links and simple provides them with a generated title in lieu of a user-defined one. This should be no more or less secure than any normal interwiki link. No extra measures have been implemented to secure or validate the values of plugin's configuration settings, but these should only be available to the wiki's admin and those user's who have trusted with access to the configuration manager, so they are no more or less secure than any other setting.
40
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}