Skip to content

Create README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jaohbib wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SearchTools
The SearchTools module enables easy integration of external components and services into the existing look and feel of Vufind without the need to develop a custom Laminas module.
The integration of the content is done via .phtml files in the theme.
The .phtml file to be displayed can be selected via a GET parameter.
The mapping of the parameter values to a specific .phtml file is done in the theme under `searchtools/home.phtml`.


## Usage
Integrate the module in the `modules` directory of VuFind and activate it by adding `SearchTools` to `VUFIND_LOCAL_MODULES`.
When adding the module manually make sure to copy/symlink the theme.