DOCSEARCHbyAlgolia
Submit Docs

InPageEdit Documentation

website·Indexed 30 days ago

https://ipe.js.org/

A JavaScript-based MediaWiki plugin featuring mobile optimization and tools such as Quick-edit, Quick-diff, Quick-rename, and Quick-redirect. The documentation covers installation as a Gadget, API references including window.InPageEdit, and details on InPageEdit Analytics (V2 through V5).

Tokens
9.8K
Snippets
63
Records
101
Agent score
52%

What's inside InPageEdit

  1. Overview of Quick-edit functionality

    Quick-edit allows users to edit a page, a specific section of a page, or a section from an old revision directly within the current view without opening a new tab. This functionality is accessible via the toolbox, section links beside headings, the page history view, and during quick-diff operations.

  2. Overview of InPageEdit Analytics V5

    InPageEdit Analytics V5 is currently in testing. It is deployed on Vercel using a serverless Node.js 14 API backend and utilizes MongoDB Atlas (AWS / Oregon us-west-2) as its data center.

  3. Overview of InPageEdit for MediaWiki

    InPageEdit is a JavaScript-based MediaWiki plugin designed to streamline wiki maintenance by allowing users to access various MediaWiki functions (such as editing) directly on the page without opening new tabs. It features mobile optimization, a modular design, and provides several SDKs for extensibility.

  4. Overview of InPageEdit for MediaWiki

    InPageEdit is a multi-functional MediaWiki plugin built with jQuery. Its primary goal is to accelerate wiki maintenance by allowing users to perform various MediaWiki tasks—such as editing pages and embedded templates—directly within the current view without opening new tabs or reloading the page. Key benefits include improved mobile device support and reduced page load overhead (CSS/JS/Ads), which helps maintain user focus and save bandwidth.

  5. Overview of inpageedit-next (Next-Generation InPageEdit)

    inpageedit-next is a complete rewrite of InPageEdit designed for modern browsers. It is a single-page application (SPA) built with Vue 3 and TypeScript, featuring a design language centered around 'tabs' (tab-view) for a multi-threaded editing experience. It uses the naive-ui component library for its interface. Note that this version is likely to be completely incompatible with the v2 API and removes the dependency on jQuery.

  6. Overview of Analysis V4 API

    v4
    Analysis V4 is a serverless-based API used for tracking and retrieving wiki analytics. Note that while the data structure remains consistent with previous versions, the API structure has undergone breaking changes.
    API Endpoint: https://analysis.ipe.wjghj.cn/api

  7. InPageEdit Analytics V5 API Overview

    v5
    InPageEdit Analytics V5 (formerly InPageEdit Analysis) provides endpoints for tracking and querying analytics data. Note that V5 contains breaking changes in API and data structures compared to V4, and V4 data is deprecated.
    API Endpoints:
- https://analytics.ipe.wiki/api
- https://inpageedit-analytics.vercel.app/api

  8. InPageEdit v14.1.0 Feature Updates

    Version 14.1.0 introduces a redesigned personal settings window using a Tabview for improved user experience. Key additions include a statistics display showing the number of times InPageEdit has been used on the Wiki and a new Plugins Store. Many existing and future features (such as quick inspection and quick rollback) are now delivered as plugins via the store.

  9. InPageEdit v14.0.0 architectural changes

    Version 14.0.0 introduces a modular design. The InPageEdit module now follows the CommonJS specification and is bundled using Webpack.

  10. Access the InPageEdit global object

    When InPageEdit is installed, it creates a global InPageEdit object (accessible via window.InPageEdit) that contains all available interfaces. This object is a Record, not a class, so it should be called directly without the new keyword.

  11. Extend InPageEdit functionality via APIs and devHooks

    InPageEdit is designed with a modular architecture that allows developers to build additional features on top of the plugin. It provides a set of APIs for general calls and devHook for passing context. This enables developers to implement custom enhancements, such as inserting quick-edit buttons in specific page locations or adding memo pads next to the editor window.

  12. Install InPageEdit MediaWiki plugin via CDN

    InPageEdit is a MediaWiki plugin that provides an all-in-one editing experience for quick-diffs, quick-redirects, and quick-renames. It can be loaded into a MediaWiki environment using either the jsdelivr or unpkg CDN.
    // Option 1: Load via jsdelivr
mw.loader.load('https://cdn.jsdelivr.net/npm/mediawiki-inpageedit');

// Option 2: Load via unpkg
mw.loader.load('https://unpkg.com/mediawiki-inpageedit');