https://github.com/csidirop/omekaplugin_template
This is a barebones plugin for Omeka Classic that provides a simple example of a plugin structure.
https://github.com/csidirop/omekaplugin_template
omeka omeka-classic omeka-plugin
Last synced: about 1 year ago
JSON representation
This is a barebones plugin for Omeka Classic that provides a simple example of a plugin structure.
- Host: GitHub
- URL: https://github.com/csidirop/omekaplugin_template
- Owner: csidirop
- License: gpl-3.0
- Created: 2024-11-22T14:42:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-16T13:35:47.000Z (over 1 year ago)
- Last Synced: 2025-03-23T23:40:32.698Z (about 1 year ago)
- Topics: omeka, omeka-classic, omeka-plugin
- Language: PHP
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Template Plugin for Omeka Classic
This is a barebones plugin for Omeka Classic that provides a simple example of a plugin structure. It includes a configuration page and an admin view, offering a starting point for developing custom plugins. Its based on informations from the Omeka classic tutorials: https://omeka.readthedocs.io/en/latest/Tutorials/index.html
### Features
- A configuration page to set options.
- An admin view to display plugin-specific data or functionality.
- Ready-to-extend structure for custom Omeka plugin development.
### Installation
Download or clone this repository into the `plugins/` directory of your Omeka Classic installation:
```
git clone https://github.com/csidirop/omekaplugin_template.git plugins/Template
```
### File Structure
```
template/
├── TemplatePlugin.php # Main plugin class
├── views/ # Views for the plugin
│ ├── admin/
│ │ ├── index.php # Admin view template
│ │ ├── config-form.php # Configuration form template
│ └── public/ # (Optional) Public-facing views
│ └── index.php # Placeholder for public template
├── plugin.ini # Plugin metadata
```
## Development
This plugin is designed as a starting point for custom Omeka Classic plugin development. Developers can:
Add more hooks to the TemplatePlugin class.
Define additional routes for custom functionality.
Extend the configuration form and admin views.
For more information on Omeka plugin development, see the [Omeka Classic Developer Documentation](https://omeka.readthedocs.io/en/latest/).
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue if you encounter a bug or have a feature request.
## License
This plugin is released under the MIT License. See the LICENSE file for details.