https://github.com/colinferm/wiki-page-summaries

Uses the first paragraph of text in a MediaWiki article as a "summary" and adds it to the API and parser.
https://github.com/colinferm/wiki-page-summaries

mediawiki mediawiki-api php

Last synced: about 1 month ago
JSON representation

Uses the first paragraph of text in a MediaWiki article as a "summary" and adds it to the API and parser.

• Host: GitHub
• URL: https://github.com/colinferm/wiki-page-summaries
• Owner: colinferm
• License: bsd-3-clause
• Created: 2016-02-18T21:36:56.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-02-18T09:24:41.000Z (almost 5 years ago)
• Last Synced: 2024-10-31T14:05:43.289Z (3 months ago)
• Topics: mediawiki, mediawiki-api, php
• Language: PHP
• Homepage: https://unifiedrepublicofstars.com
• Size: 8.79 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PageSummariesAPI

Uses designated text or the first paragraph of MediaWiki article as a "summary" and adds it to the API and parser.

This extension was a solution to the problem that MediaWiki doesn't offer any kind of article abstract. However, based on the way articles are written on [The Unified Republic of Stars](https://unifiedrepublicofstars) and [Stats For Sharks](https://statsforsharks) it seemed pretty clear that first paragraph could be used for this purpose as they were generally written to summarize what was to follow.

Thus, this plugin was born.

It's extremely easy to use. When the `parse` API is used, it just adds the first paragraph or any text marked between `` tags to the returned data.

Additionally, it adds a `summaries` API to the MediaWiki API set.

`api.php?action=summaries&pages=Main_Page|Example` will return the "summaries" for every page included (separated by a "|") as a result set that can feed... whatever. It's fast too, as it takes advantage of a few internal MediaWiki APIs to cut out some bullshit. It even utilizes the `$wgArticlePath` configuration variable to include a fully resolved URL as well.

Text designated with a `` tag can take one option `show="[default:true|false]"`. Leaving it out or marking it as `true` will have the summary text display as any other text in a wiki entry might. Marking it as `false` means that it _will not_ appear in the standard wiki article display but it will appear in the APIs above as the summary.

Not much else to say about it. It's pretty much just a tool to help build other things.