Skip to content
/ wiki Public

Little D8 module that enables a search to wikipedia

Notifications You must be signed in to change notification settings

scodx/wiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wiki

Provides a form where you can search for the top 10 finds giving a query term. You can access the form at /wiki, you can also append the term to the url like: /wiki/italy

Steps and explanation

1. Loads a page at /wiki which explains what this page does.

This is done via routes in wiki.routing.yml, the existing route calls the controller.

2. The page should include a 'Search' form field.

The form is called from the controller: src/Controller/WikiController.php

3. A user can either enter a value in the form field or provide a url parameter (/wiki/[parameter]).

The search process is being done by consuming the Wikipedia public API, this is a simple GET request to a endpoint that returns some json data

4. If a URL parameter is provided then the page displays wikipedia articles containing the parameter in the title.

5. If no parameter is provided, then the page displays wikipedia articles for the term provided in the 'Search' form field.

The search process is in a service created at src/Services/Search.php. It does some simple processing and returns the results to the controller.

6. The page should display the term that is being searched.

7. Search results should include the Title, a link to the article, and the extract for the article.

The results are being passed to the twig theme, this markup is being done at templates/wiki.html.twig

Installation

This is not a contrib module so you will not find it at the drupal site nor install trough composer. You must download it and install it manually.

Limitations

The search only returns the top 10 results, so there is no pagination in place.

About

Little D8 module that enables a search to wikipedia

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published