Skip to content

hexmode/mediawiki-el

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Table of Contents

mediawiki.el -- Edit mediawiki sites from emacs

This version of mediawiki.el represents a merging of wikipedia-mode.el (maintained by Uwe Brauer) from EmacsWiki for its font-lock code, menu, draft mode, replying and convenience functions to produce mediawiki.el 2.0.

The package has been reorganized into a modular structure for better maintainability and code organization, while maintaining full backward compatibility.

Installation

If you use MELPA, you can install via the M-x package-list-packages interface. This is preferrable as you will have access to updates automatically.

Otherwise, just make sure this file is in your load-path (usually ~/.emacs.d is included) and put (require 'mediawiki) in your ~/.emacs or ~/.emacs.d/init.el file.

Note: The modular structure is completely transparent to users. Simply require 'mediawiki as before and all functionality will be available. The reorganization maintains full backward compatibility.

Configuration and use

 M-x customize-group RET mediawiki RET
 *dink* *dink*
 M-x mediawiki-site RET Wikipedia RET

Open a wiki file: M-x mediawiki-open Save a wiki buffer: C-x C-s Save a wiki buffer with a different name: C-x C-w

About Security

Although there is a place to put your password when you customize this package, there is no need to store your password in plain text.

If mediawiki sees that the password is empty, then it will use the auth-source library to retrieve the password. This will allow you to use encryption to store your passwords.

Package Structure

The mediawiki.el package is now organized into the following modular components:

  • mediawiki.el - Main entry point with package metadata and requires
  • mediawiki-core.el - Core variables, constants, and fundamental utilities
  • mediawiki-faces.el - Font-lock face definitions for MediaWiki syntax
  • mediawiki-font-lock.el - Font-lock keywords and syntax highlighting rules
  • mediawiki-api.el - MediaWiki API interaction and data processing
  • mediawiki-auth.el - Authentication and login management
  • mediawiki-http.el - HTTP utilities and compatibility functions
  • mediawiki-page.el - Page editing, saving, and content management
  • mediawiki-draft.el - Draft functionality and temporary editing
  • mediawiki-site.el - Site configuration and management
  • mediawiki-utils.el - General utility functions
  • mediawiki-mode.el - Major mode definition and user interface
This modular structure improves code organization and maintainability while preserving all existing functionality and maintaining full backward compatibility.

TODO

  • Change customization to explicitly tell mediawiki.el to use the auth-source library.
  • Optionally use org-mode formatting for editing and translate that to mw
  • Move url-* methods to url-http
  • Use the MW API to support searching, etc.
  • Clean up and thoroughly test imported wikimedia.el code
  • Improve language support. Currently there is a toggle for English or German. This should probably just be replaced with the ability to use MediaWiki's i18n files in json format.

About

Emacs interface to edit any mediawiki site

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 6