Hello Mouse

Mouse is a free search engine for websites that run on Aneamal. It is a module written for Aneamal and can only be included in Aneamal-files.

It searches any website for content and downloads, stores and finds data on user's request, and displays them at your Aneamal website.

Prerequisites

Mouse requires Aneamal 27 as a minimum and PHP 7.1.. Some features only run in Aneamal 28 or higher, though.

That is all you need: Aneamal and Mouse. Download your copy at Download Mouse

Step by Step
Letting Mouse into your Aneamal world

Unzip Mouse-ZIP archive and upload it to your Aneamal directory on your server space at /aneamal/, so your path goes /aneamal/x-mouse/.

Now you are ready to include Mouse in your Aneamal website. You have two options to do that.

Option 1
Everything on one page

The first option has the search box, that is where users can type in keywords, and the list of results returned on the same page.

Include the following mark in your page at where you want it to be displayed.

[x-mouse]->https://your.home.page/

The domain tells to the module where to search for data. This can be your own website, but also anywhere on the internet.

To get some style to your search box, include the following Aneamal metadata mark in your page.

@style: ->/aneamal/x-mouse/style.css

Option 2
Box and results in different places

The second option has the search box and the results list in different places. Upon pushing the search button, users having typed in keywords will be redirected to another page where the list of results is displayed.

Include the following mark in the page you want the box to stay.

[x-mouse/goto]->link-to-your-search-page

Create the page that has the same name as your link in the mark.

Go to Option 1 to install your search page fully.

Feed Mouse
How to get content

You have several ways of filling Mouse with valuable food.

Go with JavaScript

The first and probably easiest one is to have your visitors bring some food.

Every time visitors come to your page, Mouse will be set off and go on a hunt for content food. You simply type in a question mark and push the button, and Mouse will return a meta declaration mark including a JavaScript link.

@javascript: ->/aneamal/x-mouse/crawl.php?rod3nt5

What you have to do now is to include this link in a prominent, frequently visited page of your Aneamal website.

Ask (Web) Cronjob for a helping hand

The second option needs a bit more of work. Again, you type in a question mark in the search box, and you will be returned a URL.

https://example.org/aneamal/x-mouse/crawl.php?rod3nt5

Copy this URL to your web-cronjob, adjust cronjob and Mouse will feed on your website.

Instead of asking a web-cronjob, you can activate cronjob on your server. Mouse provides you with the data necessary to set your cronjob. Mouse cannot provide all information on what cronjob exactly is or how to set cronjob though.

Cronjob requires two parts of the URL: the part before the question mark, and the part after the question mark. To make it easier for you to find the parts, I have put them in brackets below

(/aneamal/x-mouse/crawl.php)?(rod3nt5)

Drop the question mark and replace it by an empty space. Your path should now look like this.

/usr/bin/php /home/www/aneamal/x-mouse/crawl.php rod3nt5

Note If you don't feel confident enought to use cronjob, use JavaScript instead.

Higher Accessibility

To lower the hurdle to the blind, you may add 'search website' to the x-mouse mark.

[x-mouse:search website]->https://your.home.page/
[x-mouse/goto:search website]->https://your.home.page/

It helps the blind receive information by screen reader programs on what they find on the webpage they are at.

In The other News

To show your visitors the latest activities on your website, you may ask Mouse to list your freshest page first by the following mark.

[x-mouse/news]->https://your.home.page/

Be aware that this doesn't produce a search box at all. Its purpose is to list the latest activities so your visitors know what content you have created.

From Aneamal 28 onwards, the number of the latest page, listed from top to down, can be set: you only need to add the number of wish as a meta declaration mark - in this example, it is the number five.

@x-mouse: news=5

Note This feature is highly experimental. It is yet uncertain whether or not it will remain in Mouse or be dropped later, or experience same changes. If you stick to this version of Mouse, it will always be availaible to you. If you update Mouse, it can happend that it will be changed or removed altogether.

Asking Mouse for Food

Let us have a look at how Mouse deals with requests.

You may ask Mouse for webpages that contain words starting or ending with a given combination of letters, for instance 'be'. Mouse will recommend pages that have this combination at the beginning or at the end of words, like in bee, mybe, or in Belgium. If there is any page containing these combinations of letters in one or more words, Mouse will build a list of results consisting of title and URL for each page found.

If you want Mouse to consider multiple words combinations, add a white space between the words, such as 'bee free'. Mouse will find pages with words that contain one of them or both of them, like beear, beeach, beefree, or carefree.

To look for combinations of letters that match exactly your keyword, wrap your word in quotation marks, for instance be.

Mouse doesn't differentiate between upper- and lower-cases.