Skip to content

ProfessionalWiki/PersistentPageIdentifiers

Repository files navigation

Persistent Page Identifiers

GitHub Workflow Status Latest Stable Version Download count

Stable unique identifiers for your wiki pages. Maintain persistent references across MediaWiki page changes. Read more in the Persistent Page Identifiers documentation.

Table of Contents

Professional Wiki created this extension and provides MediaWiki Development, MediaWiki Hosting, and MediaWiki Consulting services.

Usage Documentation

See the Persistent Page Identifiers usage documentation.

Installation

See the Persistent Page Identifiers installation instructions.

PHP Configuration

See the Persistent Page Identifiers configuration reference.

Development

Run composer install in extensions/PersistentPageIdentifiers/ to make the code quality tools available.

Running Tests and CI Checks

You can use the Makefile by running make commands in the PersistentPageIdentifiers directory.

  • make ci: Run everything
  • make test: Run all tests
  • make phpunit --filter FooBar: run only PHPUnit tests with FooBar in their name
  • make phpcs: Run all style checks
  • make cs: Run all style checks and static analysis

Updating Baseline Files

Sometimes PHPStan generate errors or warnings we do not wish to fix. These can be ignored by adding them to the respective baseline file. You can update these files with make stan-baseline.

Release Notes

Version 1.0.0 - TODO

  • Generate a unique persistent identifier for each page
  • Maintenance script to generate persistent identifiers for all pages without them
  • Parser function to display the persistent identifier
  • Include the persistent identifier in page information (&action=info)
  • API endpoint to get the persistent identifiers for pages
  • Configurable format for the persistent identifier
  • Compatibility with MediaWiki 1.39 up to 1.43
  • Compatibility with PHP 8.1 up to 8.3