EXT: YATSE¶

What does it do?¶

• This extension provides a new way of searching your website. It stores the content of each page into a special table. With a special MySQL- Query, this table is searched in milliseconds.
• Searchresults can be grouped by pages, e.g. all tt_news-results first, then all the rest.
• Working only with MySQL 5+
• Please be aware, this version is only developer-version. Make backups, backups and more backups.

Screenshots¶

Image 1: Config of fe_plugin

Image 2: Searchresults

Image 3: Adding the static template

Installing the fe_plugin¶

• Download and install the EXT from TER

• Go to the root template an include the static template “YATSE - Searchbox”

• Go to the page, where the searchbox should be displayed.

• Insert a pagecontent and select the plugin “YATSE”

  

• Configure the plugin

• Under 1. you set the rootpage of your website or the page from which the search should begin.
• In point 2. you can set pages which should show searchresults first.
• Finish.

FAQ¶

• Is this extension compatible with the flag “no index” in pagesettings?

  Yes. Of course!

• Will pages be stored, if page is not cached?

  Yes. It doesn't matter, if page is cached or not.

• Can asterisk be used?

  • Yes please! You can search for Exa* to get all results starting with Exa... like Examination or Example. If you type *exa* the result will contain words like hexadecimal.
  • See http://dev.mysql.com/doc/refman/5.0/en/fulltext-boolean.html for all possible searchoperators.

FAQ¶

Can I add a searchbox on every page. Will mean: can I add a searchbox via TypoScript?

Of course you can. Just add an HTML-object with value

<form id="tx_yatse_pi1" method="post" name="tx_yatse_pi1" action="{add here your pagelink, where searchresults are listed}">
        <input type="text" value="" name="tx_yatse_pi1[sword]"/>
        <input type="submit" value="Suchen"/>
</form>

FAQ¶

Reference¶

Configuration of pi1

plugin.tx_yatse_pi1 {
    template = EXT:yatse/res/tx_yatse_template.html
    result {
            chars {
                    before = 100
                    after = 100
            }
            strftime = %d.%m.%Y
            box {
                    wrap = <div class="tx_yatse_pi1_boxwrap">|</div>
                    titlewrap = <h2>|</h2>
            }
    }
    stats {
            saveIP = 1
    }
    _CSS_DEFAULT_STYLE (
            .tx_yatse_highlight { background-color: yellow; }
            a.yatse_helplink div.yatse_helpbox { display:none; }
            a.yatse_helplink:hover div.yatse_helpbox { display:block; position:absolute; width: 300px; margin-left: 10px;margin-top: -10px; padding: 4px; border: 1px solid black; background-color: white; font-size: 8pt; }
            h4.yatse_helpheader { font-size: 10pt; margin-bottom: 6px; }
    )
}

1. Indexing the content¶

After TYPO3 has rendered all the content and before it is sent to the browser, the plugin will do several steps

get the rendered content and remove all HTML-tags, linebreaks and tabs. So we get a pure text-version.

check if the page should be indexed or not. If yes

check for an entry in database:

with the same pid and

with the same cHash.

if exists: check the content . Is the new content different to the stored or has the pagetitle changed?

if yes: update the entry.

else: do nothing.

else: create a new entry.

So the whole pagecontent is stored in one field into the database. The table has a fulltext-index on this content field which can be used for a boolean fulltext-search.

2. Searching for results¶

The plugin (pi1) does nothing else than perform the query

SELECT *, MATCH (content) AGAINST (\''.utf8_decode($this->cObj->removeBadHTML($this->piVars['sword'], $this->conf)).'\'  IN BOOLEAN MODE) AS data FROM tx_noindexedsearch_content WHERE MATCH (content) AGAINST (\''.utf8_decode($this->cObj->removeBadHTML($this->piVars['sword'], $this->conf)).'\'  IN BOOLEAN MODE)...

3. Hooks in YATSE¶

The frontend-plugin offers some hooks for manipulation.