Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
Igor Brai committed Feb 5, 2024
0 parents commit 0e0cb0a
Show file tree
Hide file tree
Showing 27 changed files with 283 additions and 0 deletions.
Binary file added .DS_Store
Binary file not shown.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/edit-focus-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Edit Focus Template
about: This Issue Template is for editing a Focus
title: "EDIT: "
labels: ''
assignees: ''

---

**Focus Title:** *tell us which Focus template are you proposing edits to*
**Reason for Edits:** *tell us why you are proposing these edits*

### Edits:
*delete as a appropriate*
**title:** *suggest a new name for this Focus*
**description:** *suggest a new description for this Focus*

*remove these*
<Replace this text with your i= and e=, one per line>

*add these*
<Replace this text with your i= and e=, one per line>
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/submit-focus-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Submit Focus Template
about: This is the Issue Template to submit a Focus for consideration.
title: ''
labels: ''
assignees: ''

---

**# title:** *suggest a name for your Focus*
**# description:** *suggest a description for your Focus*
**# author:** *attribute your Focus to a handle or group*
**# icon:** *link the .svg or other icon file for your Focus*

<Replace this text with your i= and e=, one per line>
95 changes: 95 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# Focus Contributing Guide

To submit a Focus you can either open an Issue, for whcih there will be a set of boxes to fill out, or you can submit a Pull Request. If you are submitting a Pull Request then please look at the [focus folder](https://github.com/PrivacyDingus/focus-templates/blob/main/focus) which contains ```.focus``` file formats as a reference guide.

### The following items will be required in order to submit a Focus:
- a suggested name for the Focus, we will not be able to use the same name twice
- a suggested description for the Focus i.e. *Dictionary search, Tech Blogs, No Pinterest*
- a set of inclusions, sites that will be included in the Focus
- any exclusions (optional) which might be specific subdomains i.e. search ```.twitter.com``` but not ```ads.twitter.com```
- a link to, or attachment of, an icon - preferably an svg file

## Criteria for Acceptance
In order to be a candidate for the global Mojeek Focus Template Library, a Focus must:
- not replicate like-for-like the functionality of a Focus already in the library
- have a unique name i.e. not be given the same title as a pre-existing Focus template
- have a name and description which are clear and not misleading, or representing a value judgement i.e. a search across Apple properties called *Crap technology*
- not search across x-rated adult content
- not offer functionality which would violate Mojeek's unbiased stance i.e. if a search is created for an election, it should encompass all relevant parties OR if a search is specifically to only look at 'left-wing' news, this must be called out in the title and description.

**This list is not necessarily comprehensive, and will be revisited as the Library grows.**

## Creating a Focus
Before submitting a Focus, you'll need to create one, and make sure that it does what you want it to do. To do this you'll need to visit your [Focus Dashboard](https://www.mojeek.com/focus/dashboard) and click the *Create new* button.

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/focus_dashboard.png">

You will then be asked to name your Focus, please choose something that is clear, descriptive, and that relates to the purpose that your Focus will have. You can go back and edit this at any time, so if your idea is not quite *there* yet, you can give it a placeholder name. Just remember to edit this before submitting.

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/focus_name.png">

In the *Sites to Search* box you enter in all the sites the Focus is intended to search across, one per line up to a limit of 25 in the *Dashboard*.

You can add any of the following:
Subdomain: ```www.example.com```
Domain: ```.example.com```

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/sites_to_search.png">

In the *Exceptions* box you put sites which the Focus should exclude. This step mainly exists to allow you to exclude subdomains from a Focus, so if you have ```.example.com``` included, but you want to not search across pages from ```developers.example.com``` then this subdomain would go in this box.

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/exceptions.png">

Once you're happy with your Focus, press *Save* to return to the Dashboard.

## Testing a Focus
In order to check the utility and functionality of your newly-created Focus, we'd suggest testing it out a bit before submitting. If you have questions or things that don't seem quite right, you can get in touch via our [Contact Page](https://www.mojeek.com/about/contact), [Community](https://community.mojeek.com/), or by submitting an Issue.

## Submitting a Focus
Once created a Focus lives in your Dashboard; by clicking near the Focus' Name you can expand its box.

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/completed_focus.png">

You then click the button labelled *Backup this Focus*; this tool can also be used to backup your creations if you use other browsers, or regularly clear cookies.

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/backup.png">

Your created Focus contains most of the information needed for submitting it here between ```{``` and ```}```

- The ```" "``` is your title
- The items after ```i=``` are your inclusions
- The items after ```&e=``` are your exclusions (if you have none then this will not be featured)

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/backup_highlighted.png">

This text can now be used to raise an Issue to submit your Focus, you can find the currently-available templates in the [focus folder](https://github.com/PrivacyDingus/focus-templates/blob/main/focus), here is an example:

```# title: Dictionary```
```# description: Dictionary search```
```# author: Mojeek```
```# icon: dictionary```

```i=dictionary.com```
```i=thefreedictionary.com```
```i=urbandictionary.com```
```i=vocabulary.com```
```i=merriam-webster.com```
```i=synonym.com```
```i=thesaurus.com```

## Icons
A Focus Template will display like the ones below, and so your submission is easier to add if it has an icon with it.

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/default_templates.png">

These icons are best as single-colour 16x16 svg files, if this is not possible then please get in touch via our [Contact Page](https://www.mojeek.com/about/contact), [Community](https://community.mojeek.com/) or flag this in your Issue. You can also use websites like [svgrepo](https://www.svgrepo.com/) to find commercial-friendly and royalty free icons, use the *monochrome* search option to take out icons which might display badly when added to the templates.

If the Focus you're creating would suit an icon that is already in this repo, then grab the name of it from the [icons folder](https://github.com/PrivacyDingus/focus-templates/blob/main/icons) and use that when you submit your issue.

## Editing a Focus
Through using a template you might find a way that it could be improved, through a better description and title, or through adding in more inclusions or exclusions. For example, if your usage of a template consistently returned an irrelevant subdomain, then you might want to help out by proposing a change which excludes this.

**If you are doing this through an Issue** please use the Issue template for editing a Focus.
**If you are doing this through a Pull Request** please directly edit the ```.focus``` file in the [focus folder](https://github.com/PrivacyDingus/focus-templates/blob/main/focus).

As with submissions, not all edits will be actioned when it comes to templates. Please be clear in your reasoning as to why the change would improve the user experience of the Focus in question.
56 changes: 56 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# FAQ

**What is Focus for?**
Focus allows you to build your own search tools using a genuine web index. It’s an update of something that we previously called Personal Search, [first released in 2006](https://web.archive.org/web/20060220233451/http://www.mojeek.com/mps).

From the easy-to-use interface you can:

- choose which sites to search across.
- choose parts of these sites you don’t want to see results from, such as particular subdomains.
- choose sites you don’t want to see results from.
- set up Focus search tools for different types of search tasks.
- save and restore your Mojeek Focus creations, easily moving them to another computer or browser.
- share your Mojeek Focus creations with others.
- use and edit a set of templates provided by both the Mojeek team and other users through this repo.

**How do I submit without a Github account?** Github and other similar developer platforms can be very useful for this kind of collaborative work, but we understand that they are not for everyone. If you've created something you really think would be better of shared with others, please get in contact via the [contact page](https://www.mojeek.com/about/contact) or [Community](https://community.mojeek.com/).

**What is Site Clustering and how does it affect Focus?**
Site Clustering refers to the grouping of results from the same host in order to create a greater variety of websites in results. In a regular Mojeek web search, hosts are clustered; when using Focus, clustering is off by default. You can modify how much or little clustering happens by changing settings in your Focus Dashboard.

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/result_clustering.png">

Your Dashboard clustering settings will not be carried across to other users, so please bear this in mind when submitting.

**Can I use Focus like !bangs?**
There is not currently a way to do this through Mojeek, but with both Gecko (Firefox, LibreWolf, Mullvad) and Chromium (Chrome, Brave, Vivaldi) browsers you can add *keywords* for searches, which allow for a key press, or series of key presses, to trigger the use of a specific search engine. You can use this functionality with Focus, and this is how some people have told us they've incorporated Focus engines into their setup. You can also use the *Search bar* option in your [Focus Dashboard](https://www.mojeek.com/focus/dashboard) to have your Focus engines appear on both the homepage and search engine results page in the bar itself.

<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/focus_search_bar.png">

**Can I use Focus through a search box?**

Yes, the ```?foc=``` parameter means that a Focus can be used as a part of a site-hosted search box, or through the search bar in your browser if you see benefit from that. In order to do this you need to make sure that, as well as ```%s``` to indicate where a query goes in a string, you also add ```&foc=``` and then the name or parameter of the Focus in question, for example ```&foc=Dictionary```.

**Why 25 sites?**

For the initial release of Focus creations were limited to 25 sites as they need to be stored as a cookie. Uncapping this limit would be difficult, with there being a hard limit of 4096 bytes across browsers, and other problems arising if cookies are extremely long in terms of handling a Focus. This does not mean that this limit is permanent, and if there are sufficient requests then we will look into how this could be addressed to provide more functionality.

**Can I use Focus just to exclude sites?**

You can do this, it is not really what exclusions are for, but will work that way. Exclusions are really for pulling out a subdomain or similar which is irrelevant i.e. searching across ```example.com``` but not ```developer.example.com```.

**Why isn't example.com appearing in my Focus? I added it in**

Focus is limited to searching across websites and pages that we currently have in the index, so this probably explains why you're not seeing the site in question, but please do [get in touch](https://www.mojeek.com/about/contact) to troubleshoot further. You can also check yourself by performing a ```site:``` search as [outlined here](https://blog.mojeek.com/2015/03/how-to-submit-your-site-to-mojeek.html).

**Can you crawl it then?**

Mojeek automatically discovers websites during its crawl of the web, for this reason there is currently no way to manually submit a site to Mojeek. If you think there is a glaring omission then please let us know, sometimes there are issues with crawling sites such as robots.txt blocks.

**Can you add feature X?**

Propose it to us via Issues, the [contact page](https://www.mojeek.com/about/contact) or [Community](https://community.mojeek.com/), let's see!

**What is unlikely to be accepted?**

Focus creations which are likely to violate our unbiased stance or cause other issues due to their inclusion will not be added into the preset templates. These are tools built by the wider Mojeek community, but when someone looks at the bank of templates without prior knowledge they will think they came from us. We hope that polite discussion here on Github or in the Community will mean that interventions of this nature are few and far between.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<img src="https://github.com/PrivacyDingus/focus-templates/blob/main/assets/focus_header.png">

# Mojeek Focus

[Mojeek Focus](https://www.mojeek.com/focus/) gives you the freedom to search the parts of the web you define, creating subsets of sites for specific interests, research areas, or any other reason you can think of. This repository is a place where you can submit your creations to be considered as templates, accessible by all those using Focus.

Want to learn more about Focus? You can visit the [Mojeek Focus](https://www.mojeek.com/focus/) page, [search the web you want](https://blog.mojeek.com/2022/08/mojeek-focus-search-the-web-you-want.html) blog post introducing Focus, or dive right in by heading to your [Focus Dashboard](https://www.mojeek.com/focus/dashboard) to get a better idea of what this functionality is for.

Please read the eligibility guidelines in [CONTRIBUTING.md](https://github.com/PrivacyDingus/focus-templates/blob/main/CONTRIBUTING.md) before raising an Issue or submitting a Pull Request in order to add your Focus. **Not all submissions will make it onto the templates list.**

If you have any further questions about Focus then please check out [FAQ.md](https://github.com/PrivacyDingus/focus-templates/blob/main/FAQ.md), you can also help out by raising an Issue or submitting a PR if there is any useful information you believe is missing from this repository.

If you're looking to collaborate, discuss, or sound out ideas, the best place for this is the [Mojeek Community](https://community.mojeek.com/).
Binary file added assets/backup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/backup_highlighted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/completed_focus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/default_templates.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/exceptions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/focus_dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/focus_header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/focus_name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/focus_search_bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/result_clustering.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/sites_to_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions focus/dictionary.focus
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# title: Dictionary
# description: Dictionary search
# author: Mojeek
# icon: dictionary

i=dictionary.com
i=thefreedictionary.com
i=urbandictionary.com
i=vocabulary.com
i=merriam-webster.com
i=synonym.com
i=thesaurus.com
13 changes: 13 additions & 0 deletions focus/recipes.focus
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# title: Recipes
# description: Recipes search
# author: Mojeek
# icon: recipes

i=theskullery.net
i=chowdown.io
i=bbcgoodfood.com
i=allrecipes.com
i=recipefy.com
i=foodnetwork.co.uk
i=justthefuckingrecipe.net
i=thepioneerwoman.com
15 changes: 15 additions & 0 deletions focus/time.focus
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# title: Time
# description: Time search
# author: Mojeek
# icon: time

i=everytimezone.com
i=greenwichmeantime.com
i=thetimenow.com
i=time.is
i=timeanddate.com
i=time-time.net
i=worldtimebuddy.com
i=worldtimeserver.com
i=vclock.com
i=24timezones.com
13 changes: 13 additions & 0 deletions focus/weather.focus
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# title: Weather
# description: Weather search
# author: Mojeek
# icon: weather

i=accuweather.com
i=metcheck.com
i=metoffice.gov.uk
i=weather.com
i=weather.gov
i=wunderground.com
i=worldweatheronline.com
i=worldweather.wmo.int
Binary file added icons/.DS_Store
Binary file not shown.
5 changes: 5 additions & 0 deletions icons/design.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions icons/dictionary.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions icons/recipes.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0e0cb0a

Please sign in to comment.