UseMod Wiki: WikiPatches

Overview

See the WikiBugs to add any bugs or possible bugs.

The following pages are modifications to the wiki software. Some of these will be part of future releases.

UseModWiki/Ideas, ideas that could possibly be implemented someday. Much less definite than the items in UseModWiki/ToDo.
WikiSuggestions, any suggestions for UseModWiki features (see also: WikiSuggestionsResolved?, WikiSuggestionsResolved/OldSuggestions) WikiCodeSuggestions, suggestions about implementation and WikiProposalPatchs, if you don't have a good name for a patch
/Where, suggestions on where new code goes within wiki.pl and format of a patch.
PatchedScripts (if you are looking for already patched scripts) and UseModDescendant
FutureOfUseMod, collects pages about UseMod evolution comments and plans about others too.

1. Patches to version 1.0

1.1. Added above version 1.0

UseModWiki still further improved.

All these patches and bugfixes have been added by MarkusLude since July 2007 (See WikiBugs)

/TaintMode - allows script to run when taint checking is enabled [similar code was added for 1.1.0, taint checking enabled by default]
/RssLinkInHeader - A mini-patch that adds a <link> to the wiki's RSS feed. -- UngarPeter [Fixed for 1.0.5]
/DoPageLockMinorTweak - header according to parameter [Fixed for 1.0.5]
/DoEditLockMinorTweak - header according to parameter [Fixed for 1.0.5]
/MenuPage Turn a dedicated Menu page into a site wide menu bar, [developed on 0.92 and 1.0.4]
/RobotsNoFollow - prevent bots from exploring old revisions, search results, and other "helper" pages [I've chosen a simplified version of patch D -- MarkusLude] [Fixed for 1.0.2]
/XssFix - fixes XSS vulnerability from CAN-2004-1397 [Fixed for 1.0.1]
/UneditablePageBugFix - Prevents vandals from creating pages that can not be edited [Added in 1.0.1]
/ProperUriEscaping - This patch makes wikis that use an 8-bit encoding (e.g. latin-2) more accessible, and indexable by search engines -- UngarPeter [Fixed for 1.0.1]

: Bug Fixes

/NoDuplicateTOCAnchors - prevents anchors with duplicate names in the table of contents/page headers
/AnchorsInFreeLinkBugFix - approve the appearance when use link with anchor in FreeLinks
/UseNamedAnchorInTOC - give a choice to use numbered anchor only in <toc>
/SlashLinks - makes the $SlashLinks configuration setting work
/UploadUrlWithBracketText
/EmailLang - allows e-mail sending in other languages than english

1.2. Not a bug or won't change

/DontShowBordersOnUploadedImages - suppress borders on embedded upload:images.jpg images show borders when they are links

1.3. Additional Features to version 1.0

1.3.1. For the whole wiki to version 1.0

/LinkOptions - a trivial patch to allow options in freelinks with the the syntax of [[pagename|options|description]]
/UserGotoBarAsSub - makes the UserGotoBar a sub, so you can add links dependant of the current page. It is compatible with the traditional plain string format. --StefanTrcek
/MiniHelp - adds a table with some wiki-syntax when editing a page
/PerlDiff - Perl-based, side-by-side diff with a granularity of words. Patch file at PerlDiff
/EasyUploadUrl - don't require http: in $UploadUrl
/TableOfContentsForUnnumberedHeadings - Support unnumbered headings in the /TableOfContents
/BacklinksImproved
/WordSearch - adds a checkbox to toggle whole-word search
/NonBreakText - adds a subroutine to replace spaces with non-breaking spaces (with a usage example)
/ListOrphans - adds a "show orphans" link to the goto bar
/InterSiteIcons - adds favicon-style small image before InterWiki(InterSite) link (iff image filename is present and active in intermap file)
/LoginRework - the main menu does not have Preferences in it until you login. If you try to edit then you will be asked to login. Login page allows for a New Login to be created. User ID number is only shown through Preferences. User ID number is nearly on Transparent To The User mode.
/LoginAndPasswordsFromApache - uses Apache authentication, assorted other user things
/WikiFarm
/AlternateStyleSheets - add stylesheet (menu) selection to preferences and alternate stylesheet selection to each page
/ASCIIMathML - use the [ASCIIMathML] javascripts to display [MathML] using [LaTeX] like format
/AutoBackLinks - small change to always show an Backlink to page in the footer
/AutolinkNonExistent - add automatic search/intermap links on non-existent / empty pages
/RobotsMetaTag - update to /RobotsNoFollow and /NoIndex. Reduces PageRank? incentives for spammers
/UseBogoSpamNotify - allows admins to mark pages as "spam" or "ham" using WikiSpam/BogoFilter and shows spam rating on RecentChanges page
/NoWiki
/OpenProxy - bans open proxies from editing on the wiki. MeatBall:OpenProxy
/SelfBan - bans the IP loading this action. MeatBall:SelfBan
/DigestedSummary - MeatBall:DigestedSummary makes summaries persist across revisions; useful to build summaries of ongoing conversations
/LocalisedCalcDay - allows to localise the sub CalcDay
/Hungarian - fixes o-tilde vs o-doubleacute and similar problems. -- UngarPeter
/UserList - displays a user list on the logon screen. Also adds a new action, "userlist", which does the same. -- UngarPeter
/EmbeddedBacklinks - insert backlinks into the page text. -- UngarPeter
/EmbeddedSubpageList - insert the list of subpages into the page text. -- UngarPeter
/MicrosoftWordUpload - allows Microsoft Word documents to be uploaded as wiki pages. -- UngarPeter
/SourceHighlight and /SourceHighlight2 - In-page syntax-highlighted blocks of code in various programming languages. -- UngarPeter
/LoginLogoutByUsername - Login by Username and logout feature. -- JohannKlasek
/HierarchicalUsemodWiki - a big patch that allows pages to be organized into arbitrary-depth hierarchies, and navigated visually -- UngarPeter
/SpambotPoison - if you hate spammers, you want this patch. It adds bogus e-mail addresses to your wiki, invisible to normal users -- UngarPeter
/WikiTemplate - implements templates that can be inserted into any page -- UngarPeter
/Footnote - implements Footnote (by adaptation of a patch from GyPark)
/QuickRevertToLastRevision - quickly revert back a revision for the page
/WikiTalkSpace - talk space for comments on pages
/UserTalkSpace - talk space for own users through a link visible in RecentChanges a la MediaWiki
/Contributors - list contributors (of each contribution) of a page through a link visible in FooterText?
/Contributions - list contributions of a user through a link visible in RecentChanges a la MediaWiki
/OriginalAuthor - additional data about when a page is first created
/DoubleClick - edit a page by double-clicking on it (by adaptation of UseModKr code)
/Internationalisation - trying to build up a specific topic related German dictionary added to the config file
/WookeeMarkupFormatter - replaced the UseModWiki markup formatter
/WikiToHTMLCache - cache just the content of the page (what is returned from WikiToHTML)
/RevCloud - tag cloud sytle based on number or revisions
/PoweredByWithLinesOfCode - add "Powered by UseModWiki with nnnn lines of code" at the bottom
/PageEmbeddedTitleSearches - list pages with specific strings in the page title --PEZ
/UniversalEditButton - add RSS-like links to pages that let users edit the page -- UngarPeter
/ImprovedLogoInsert - for the logo, allows alignments right, left and center
/IndexAndPrinterOnBar - add the Site Index and a Printer Friendly version of the page (saw in CWICK too, see PatchedScripts)
/ExtendedActionVersion - more detailed information about the system and environment (based on OddMuse)
/EmbeddedLastMaintenDate - lets to check date of last action=maintain. So there's no attempt less than twelve hours
/LoadTime - returns LoadTime? for each page
/MaintainRCAtAdminBar - add action=maintainrc according to its option at GetAdminBar?
/AdminNote - HTML notice beside the GetAdminBar?, for convenience of admin, whatever.
/EditIntermap - By analogy with editbanned, this patch allow to keep the file InterMap from the own wiki site, via adminbar
/RawOutPutInFooterBar - straight link to render pages in raw mode at GetFooterText
/DivWikiAction - so there's no "without-divs" body-pages btw div.wikiheader and div.wikifooter.
/GetJumpForm - This patch adds beside GetSearchForm, a GetJumpForm? (with some of Javascript, completely optional)
/BulkLock - List of all pages in order to check or uncheck the lock parameter.

1.3.2. Features made prior to 1.0 which have been confirmed to still apply

/GetSubpages - extra option in the Edit / Rename page to get all subpages of a given page
/RenameSubpages - allows all subpages of a page to be moved at once, extension of /GetSubpages
/HTDigSearching - uses ht://Dig? as the provider for "search the wiki" functionality. much more powerful than built in search)
/RssInclusion - a new tag to include RSS feeds from other sites [updated to 1.0]
/NoFreeLinkUserNames - allows FreeLinks in user names to be turned on/off independently of main FreeLinks setting
/MarkupWithinParagraphs - allow <b> <i> etc to span lines within the same paragraph. Note: Really needs to be easier to apply to 1.0.
/PodStyleMarkup - allows b<Some Text> i<Some Text> and u<Some Text>
/EditFromTop - duplicates the "edit bar", normally only in the page footer, in page header
/UnderlineTag - a new tag for underlining text, requires CSS

1.3.3. For individual wiki pages to version 1.0

/AutoFocusEditText - automatically move the focus to the edit text-box upon entering a page in edit-mode
/PressCtrlSToSave - save upon pressing CTRL+S
/SubscribePage - allow users to add themselves to the mailing list of a given page

1.4. More patches

/NoAnonyms - do not let anonymous readers edit your pages --JW3
/RestrictPages - Allows pages to be restricted by regexps (
A WikiSuggestions/BrowserCaching patch
/LastModifiedHeader
/OrderedListNumbering - control over numbering style and starting number
/TableRowSpan - uses exclamation marks (!) to add rowspan to tables -- very simple patch.
/UseridApache - takes UserID from Apache -- very kludgy but maybe more helpful than /LoginAndPasswordsFromApache
/SearchNote - adds a HTML notice beside the search field

The following patches do work for me but may need a few changes and cleanups. --TilmannHolst, 2004-05-21

/AlternatePrintPageList - fancier index page/page lists
/Comments On - simple comments on this page feature
/BracketLinksWithAnchor - allow anchors in bracket links
/MoreConfigOptions - currently used for $ImageExtensions and $UrlProtocols?
/AmazonPatch - patch for ASIN links and a special Amazon page
/ExtraContent - include raw html on top and bottom
/ExtraContentOnHomePage - raw html to be included on top or bottom of $HomePage
/GoogleMaps - Link to MeatBall:GoogleMaps with Map:"address" syntax
/SearchAndEditTags - allows you to place <edit> and <search> inside the text and get youknowwhat ;)
/EmbeddedCode - this is truly ugly and dangerous, it allows you to insert a nameless sub (code ref) inside <perl>-tags, which will be executed. Useful together with /CustomAction
/CustomAction - being able to post values from one Wiki-site to another by inserting hidden textfields 'action' and 'id'
/UploadImageLinks - allows people to create links like [http://foo.bar.com upload:myPic.jpg] and [MyWiki:ExternalSite upload:myOtherPic.jpg]
/FileInclusion - to be able to include files inline into the wiki-text like include: file.html

2. Patches until version 1.0

Note: Quite a few of these patches can probably also be applied to the 1.0 release - with a little care and attention. So don't stop reading here if you have 1.0!. If you do make one of these patches to 1.0, please document what you did on the patch's page. then add a link in the section above.

2.1. Added until 1.0

/RcOldLog - [Added for 1.0 with some changes]
/FaviconSupport - put a shortcut icon / favicon in the head of each page. [Added for 1.0]
/GetAdminBar - gets a bar of links to administrator's actions) [in V1.0 set $AdminBar?? to 1]
/FooterWithAuthor - adds the name of Author beside the "last edited"-date like in the footer. --KnutK [A default-on option for 1.0 (changed the text to say "by" instead of "from"]
/InternationalDateTime - The 1.0 release will contain the $NumberDates? option, which will output dates like "2003-7-16" if enabled. --CliffordAdams
/ModWiki -the more "standard" RSS for wikis. (See MeatBall:ModWiki) [Included in the 1.0 release]
/DivTags - encloses sections of the page in DIV tags: wiki text, footer, recent changes list, edit area. [V1.0 has these built-in]
/MoveConfigFile - allows config file in any directory [in V1.0 set $ConfigFile? to the file name]
/PageDelete - allows administrators to automatically delete pages [included in V1.0]
/NumberedHeadings - automatically give the headings section numbers [added to 1.0]
/TableOfContents - building off of /NumberedHeadings, automatically generate a table of contents [added to 1.0]
/MetaKeywords - be more friendly to search engines trying to index your wiki. (Note, Google now downrates meta keywords, so you should disable it to increase your PageRank?) [This patch is included in 1.0]
/PageDeletion - MeatBall:PageDeletion [added to 1.0]
/FileReplacement - MeatBall:FileReplacement [This feature is implemented in 1.0, but is turned off by default]
/SearchButton - the search form at the bottom gets a button [added to 1.0: the $SearchButton?? config variable (defaulting to 0)]

2.2. Additional Features

2.2.1. For site admin & wiki admin until version 1.0

/Templates - control the appearance of your wiki site
/GetSubpages - extra option in the Edit / Rename page to get all subpages of a given page
/RenameSubpages - allows all subpages of a page to be moved at once, extension of /GetSubpages
/ListOrphans - List pages that have no referring links

2.2.2. For the whole wiki until version 1.0

LatexPatch - support for inline [LaTex]
/NoIndex - places a NOINDEX notice on undefined pages (useful to keep Google from indexing spam pages; etc.)
/GetReferersBar - gets links to referrers' and referee's pages Everything2 style)
Login
- /Login - creates a link to the login page on the GotoBar
- /LoginWithId - very minor adjustments to the script allows a bookmark to specify the user ID
- /RequireAUserName - this patch requires the username to be populated for editing
- /NoFreeLinkUserNames - this patch allows FreeLinks in user names to be turned on/off independently of main FreeLinks setting
- /LoginLogoutPatch - is massive but worth it.. :-) decouples preferences from login, from 'new login' and provides a logout that clears your cookie. The resulting scheme confirms to (our) users' expectations
- /UseSystemLogin - use http login and system users for user names
- /PrivateUserGroups - create private pages/subpages with restricted group access control
/Index - creates a link to the index page on the GotoBar
- /TwoColumnIndex - apply the above patch, then apply this one to show your index in two columns
/GoToBarLabels - adds labels to links on GotoBar
/ManPageLinks - support links to UNIX manual pages
C2-style Backlinking and default search text
- /BackLinks - Clicking on page title does BackLink? search a la Wiki:ReverseLink
- /DefaultSearch - the search text box in the footer defaults to the page title
/BodyColors - should specify all or none of bgcolor, text, link, vlink, and
/HtmlHeader
CSS features:
- WikiWithCascadingStyleSheet
- /GlobalCSS - allows you to set a global style sheet for the wiki
- /MultiCSS - allow multiple stylesheets to be used
- /CSSskins - allows users to choose from a selection of CSS stylesheets in preferences
- /UniversalFooter - makes it easier to deal with closing DIV, TABLE etc tags in the footer
- /ClassMarkup - adds Wiki markup for creating classed DIV blocks for CSS styling
- /EnableCSS - add class-attribute to nearly every element [Many of the changes in this patch have been added to 1.0]
/UriEscapeIds - uri_escape's id's to make pages with non-ASCII characters work in all browsers
/MonoSlashedFileLinks - allows file:/ links additionally to file:// (when NetworkFile is enabled)
/EDonkey2000Links - allows ed2k: links
/NationalDays - add national days to the navbar
/LinkJavaScript - <LINK to javascript source file on every page, cf $StyleSheet
/SearchResultsLimit - set a limit of number of pages to be printed on one screen on searches and index. For an example go to [NetVillage Index] -- GerardoBetancourt
/WordSearch - match whole words
/EmbedInheritance - Inherit the setting of the embed and the toplinkbar parameter
/TwentyFourHourFormat - support 24 hour time format display option in the user preference
/JavaScriptTimezoneHandling - Instead of cgi-script wiki.pl, display localtime using JavaScript so that the user doesn't have to set the timezone or care about summer time at all
/LikeLinks - show pages like the current one.
/SurgeProtector - protect against simple DenialOfService due to ill behaved bots slamming the wiki
/MultiLang - allow filtering of RecentChanges according to language used
/PermanentRevisionHistory - optionally prevent pages from being expired.
/PeriPerify - adds set-theoretic sub-subpages and a Shatter algorithm
/AutomaticLinkBack - link back to people that link to you
/UILanguageSelection - autoselect language for the UI from browser preferences
/Esperanto - ASCII<->Unicode transcoding for accented letters
/DynamicLinkSuggester - suggest possible wiki word links while browsing or in preview mode
/TouchGraphWikiBrowserStyleLinkDatabase? - Allows the name database to be directly loaded by MeatBall:TouchGraphWikiBrowser -- ManpreetSingh
/SSIPatch include the content of a wiki page in any html-page using SSI
/ExtendedSearchSyntax - add customised search links to wiki pages
/TemplatePages - define templates to use instead of blank pages when editing
/AnnoyingQuote - an implementation of the AnnoyingQuote feature of other Wikis

2.2.3. For individual wiki pages until version 1.0

ThinLine - see also /ThinLineHeadingsConflict
/TableSyntax - MeatBall:TableSyntax. MoinMoin-style tables.
/FullTables - fairly complete hack (probably processor intensive, though)
/SimpleTables - different syntax
- see also MeatBall:NamedAnchorsInWiki for numbered headings & table of contents
/TextColours
/SeparateCounters - allows several intermingled counters (and not just for lists)
/IsbnCleanup - makes it easier to change bookstore(s)
/OffsiteNewWindow - offsite links open in new browser window
/NamedAnchors - MeatBall:NamedAnchorsInWiki.
/RawMode - returns the page content source-text completely unadorned by html or page structure
- /RawWikiInclusion - include raw content from other web sites
/ForcedLineBreaks - force a line break
, handy for hanging multiple paragraphs into one <LI>
/AutoMailto - turn e-mail addresses like <brad@ltc.com> into mailto: links
/URLRewrite - support use of Apache Rewrite rules for "cleaner" URLs
/AIMlinks - allows href links to aim:goim
- See also: /TableOfContentsForUnnumberedHeadings
/ImageTags - wiki markup to insert local images in pages
/AutoSignature - adds a markup tag which inserts the writer's username
/AutoUserName - oneline - adds a markup tag $$$ which dynamically shows the current user name and links to user's page
/Hide - Oneline - adds a markup tag <hide> blah.. blah.. </hide> which hides the text from view
/PictureSmilies -- translating :-) to a real smiley
/LiveJournalLinkPattern -- livejournal links pattern to make mass-referencing to lj-posts easier
/GraphViz -- inline graphs (dot/neato)
/MarkupWithinParagraphs -- allow <b> <i> etc to span lines within the same paragraph
/PodStyleMarkup - allows b<Some Text> i<Some Text> and u<Some Text>

2.2.4. For special wiki pages until version 1.0

/ConfigurableDiffBgColor - with a fancy CSS (nice feature under 092) diff output can become illegible
/TaviStyleHistory - a better history interface + a bonus inter-revision diff patch.
/AccessibleDiffs - diff by word instead of by line (which usually makes this a diff by paragraph)
/RecentVisitorsFeature - list recent visitors to the site
/RichSiteSummary - generate an RSS file from the RecentChanges logging
- /XmlRss - produce RSS using the XML::RSS module
- /RssInclusion - a new tag to include RSS feeds from other sites
/BetterSearchOutput: UPDATE: Translation and better highlighting --KnutK
/BetterEditPage - clearer IMHO, verbose in the PhpWiki style
/CancelEditButton - adds a Cancel Edit button to the Edit screen
/NowPseudoLink - adds a convenient shorthand for today's date, at edit time
/SaveButtonAtBottomOfPreview
/ActionLinksBehaviour
/IndexWithSizes - add a display of the size of each page, in bytes, to the index listing
/IndexWithSortableSizes - incremental patch on the above, to add forward and reverse sorting by both size and page name
UseSendMail - using sendmail.pm instead of sendmail
/UseNetSmtp - allows usage of Net::SMTP instead of sendmail (optionally)
/MagicPages - allows modular scripts for pages with generated content
/GoogleTranslation - adds an automatic translation of pages with Google
/DirView - directory browsing, e.g. for uploaded files

2.2.5. Changing UseModWiki Behaviour

/UnBracketText - option to eliminate brackets from around $BracketText
/UnSlashSubPage - subpages without slashes
WikiSuggestions/LinkPatterns
/ChangesSinceLastVisit - shows RecentChanges since you last did RecentChanges
/TweakHistoryListing
/SimpleWiki - hides almost all "advanced" usemod behaviour (so that people new to wiki's don't get confused)
/AllowEditRedirects - allows linking to an off-site area after editing (it was useful to me! :^)

3. Patches until 0.92

3.1. Added to version 0.92

/UserAdditionsToGotoBar - additional text in the GotoBar [Added for 0.92]

3.2. Additional Features to version 0.92

/RecentVisitorsFeature

4. Comments

I suggest that we put votes for features we'd like to see made standard under these list items. Not that our host will be bound by our requests, but so he knows which features have attracted interest. See and add your comments to NextRelease.

: I actually put my opinion about the patches on my personal site: DavidAndel I liked the way David did this and have done the same -- SimonDavis
: I've tried now to organize the patches a bit and list them a little bit by (my subjective) importance as well... please improve :-)

What about features that we'd (I'd) like to see that are not listed here? There are a couple of things that I's like to see listed as "candidates" for the 1.0 release. For instance MeatBall:WantedPages, and an option to AllowExternalRedirects. MeatBall:WantedPages has several implementations floating around, AllowExternalRedirects is something that I've longed for but never got around to patching myself. Might I suggest that a 1.0 planning page be added as a page right off the home? Futhermore since things like MeatBall:WantedPages is not really a part of the wiki itself has anythought been give to "bundling" various UsefulScripts? together in the distribution? --JohnVolkar

A note on submitting patches

My experience is that patches on other servers end up being unavailable. Please post them on UseMod. -- SimonDavis

: I second that one with a slight change: keep them sync in both places. That way if one is down there will be the other. Cheers! -- DavidCollantes

I have a patch I made so you can have #anchors in FreeLinks that are not WikiWords, using the syntax [[Foo#My_Anchor]]. However, I'm not sure the best way to post my new patch - the above hierarchy is somewhat intimidating. So I'll just put it here for now (it is against 1.0.4): /FreeLinksWithAnchors

Of course I'd be interested in some feedback on this. Thanks for your attention, --UdoG�ngerich, 2005-08-22

Added /CorrectLocalisedTimes to resolve the arbitary nature of displayed times