Skip to content

Latest commit

 

History

History
34 lines (18 loc) · 1.82 KB

README.md

File metadata and controls

34 lines (18 loc) · 1.82 KB

HelloWorld

A bare-bones Omeka-S module. Intended as a tutorial and a starter template for people who are new to PHP, Laminas and Omeka-S Development.

Installation

See general end user documentation for Installing a module

To Use

Once installed, this module extends all of your omeka-sites with the hello controller which has 2 actions: Greet and Index. To see them in action, gpo to a site page and add "helloworld" to your site's URL string in your browser. for example:

... http://[server]/omeka-s/s/[siteslug]/helloworld ...

Where [server] is the web server for your Omeka-S installation and [siteslug] is the slug for your site.

If the module is installed correctly, you will be presented with a page generated by the views/hello/index.phtml template. The index page includes the view/common/hello-form.phtml form element. Enter a name in the form and push the Greet button. When the form is submitted, the URL is extended with the ?greet parameter, and a new page is generated using the views/hello/greet.phtml template that also includes the hello-form element.

If this functionality was useful for your sites, you could add the hello-form element to any of your pages by adding it to pages that are part of your site's custom theme.

Otherwise, you can modify the module with new controllers and actions.

Explore the Laminas Modules Tutorial and explore the documentation for the various laminas functions that are included in this module's files.

The Omeka-S developer documentation on Modules provides many essential elements for modules.

Copyright

The HelloWorld module is free to re-use for any purpose according to the MIT license.