<?php
/**
* SeekQuarry/Yioop --
* Open Source Pure PHP Search Engine, Crawler, and Indexer
*
* Copyright (C) 2009 - 2020 Chris Pollett chris@pollett.org
*
* LICENSE:
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* END LICENSE
*
* Default Public Wiki Pages
*
* This file should be generated using ExportPublicHelpDb.php
*
* @author Chris Pollett chris@pollett.org
* @license https://www.gnu.org/licenses/ GPL3
* @link https://www.seekquarry.com/
* @copyright 2009 - 2020
* @filesource
*/
namespace seekquarry\yioop\configs;
/**
* Public wiki pages
* @var array
*/
$public_pages = [];
$public_pages["en-US"]["400"] = <<< 'EOD'
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS==Bad Request==
Your request couldn't be processed by the server!
EOD;
$public_pages["en-US"]["404"] = <<< 'EOD'
title=Page Not Found
description=The page you requested cannot be found on our server
END_HEAD_VARS
==The page you requested cannot be found.==
EOD;
$public_pages["en-US"]["409"] = <<< 'EOD'
title=Conflict
description=Your request would result in an edit conflict.
END_HEAD_VARS
==Your request would result in an edit conflict, so will not be processed.==
EOD;
$public_pages["en-US"]["Syntax"] = <<< 'EOD'
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=Yioop+Wiki+Syntax
author=Chris+Pollett
robots=
description=Describes+the+markup+used+by+Yioop%26%23039%3B
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS=Yioop Wiki Syntax=
: Wiki syntax is a lightweight way to markup a text document so that
it can be formatted and drawn nicely by Yioop.
This page briefly describes the wiki syntax supported by Yioop.
==Headings==
: In wiki syntax headings of documents and sections are written as follows:
<nowiki>
=Level1=
==Level2==
===Level3===
====Level4====
=====Level5=====
======Level6======
</nowiki>
and would look like:
=Level1=
==Level2==
===Level3===
====Level4====
=====Level5=====
======Level6======
==Paragraphs==
: In Yioop two new lines indicates a new paragraph. You can control
the indent of a paragraph by putting colons followed by a space in front of it:
<nowiki>
: some indent
:: a little more
::: even more
:::: that's sorta crazy
</nowiki>
which looks like:
: some indent
:: a little more
::: even more
:::: that's sorta crazy
==Horizontal Rule==
: Sometimes it is convenient to separate paragraphs or sections with a horizontal
rule. This can be done by placing four hyphens on a line by themselves:
<nowiki>
----
</nowiki>
This results in a line that looks like:
----
==Text Formatting Within Paragraphs==
: Within a paragraph it is often convenient to make some text bold, italics,
underlined, etc. Below is a quick summary of how to do this:
===Wiki Markup===
{|
|<nowiki>''italic''</nowiki>|''italic''
|-
|<nowiki>'''bold'''</nowiki>|'''bold'''
|-
|<nowiki>'''''bold and italic'''''</nowiki>|'''''bold and italic'''''
|}
===HTML Tags===
: Yioop also supports several html tags such as:
{|
|<nowiki><del>delete</del></nowiki>|<del>delete</del>
|-
|<nowiki><ins>insert</ins></nowiki>|<ins>insert</ins>
|-
|<nowiki><s>strike through</s> or
<strike>strike through</strike> </nowiki>|<s>strike through</s>
|-
|<nowiki><sup>superscript</sup> and
<sub>subscript</sub></nowiki>|<sup>superscript</sup> and
<sub>subscript</sub>
|-
|<nowiki><tt>typewriter</tt></nowiki>|<tt>typewriter</tt>
|-
|<nowiki><u>underline</u></nowiki>|<u>underline</u>
|}
===Spacing within Paragraphs===
: The HTML entity
<nowiki>&nbsp;</nowiki>
can be used to create a non-breaking space. The tag
<nowiki><br></nowiki>
can be used to produce a line break.
==Preformatted Text and Unformatted Text==
: You can force text to be formatted as you typed it rather
than using the layout mechanism of the browser using the
<nowiki><pre>preformatted text tag.</pre></nowiki>
Alternatively, a sequence of lines all beginning with a
space character will also be treated as preformatted.
: Wiki markup within pre tags is still parsed by Yioop.
If you would like to add text that is not parsed, enclosed
it in <tt><`mbox{nowiki}`> </`mbox{nowiki}`></tt> tags.
==Styling Text Paragraphs==
: Yioop wiki syntax offers a number of templates for
control the styles, and alignment of text for
a paragraph or group of paragraphs:<br />
`{{`left| some text`}}`,<br /> `{{`right| some text`}}`,<br />
and<br />
`{{`center| some text`}}`<br /> can be used to left-justify,
right-justify, and center a block of text. For example,
the last command, would produce:
{{center|
some text
}}
If you know cascading style sheets (CSS), you can set
a class or id selector for a block of text using:<br />
`{{`class="my-class-selector" some text`}}`<br />and<br />
`{{`id="my-id-selector" some text`}}`.<br />
You can also apply inline styles to a block of text
using the syntax:<br />
`{{`style="inline styles" some text`}}`.<br />
For example, `{{`style="color:red" some text`}}` looks
like {{style="color:red" some text}}.
==Lists==
: The Yioop Wiki Syntax supported of ways of listing items:
bulleted/unordered list, numbered/ordered lists, and
definition lists. Below are some examples:
===Unordered Lists===
<nowiki>
* Item1
** SubItem1
** SubItem2
*** SubSubItem1
* Item 2
* Item 3
</nowiki>
would be drawn as:
* Item1
** SubItem1
** SubItem2
*** SubSubItem1
* Item 2
* Item 3
===Ordered Lists===
<nowiki>
# Item1
## SubItem1
## SubItem2
### SubSubItem1
# Item 2
# Item 3
</nowiki>
# Item1
## SubItem1
## SubItem2
### SubSubItem1
# Item 2
# Item 3
===Mixed Lists===
<nowiki>
# Item1
#* SubItem1
#* SubItem2
#*# SubSubItem1
# Item 2
# Item 3
</nowiki>
# Item1
#* SubItem1
#* SubItem2
#*# SubSubItem1
# Item 2
# Item 3
===Definition Lists===
<nowiki>
;Term 1: Definition of Term 1
;Term 2: Definition of Term 2
</nowiki>
;Term 1: Definition of Term 1
;Term 2: Definition of Term 2
==Tables==
: A table begins with {`|` and ends with `|`}. Cells are separated with | and
rows are separated with |- as can be seen in the following
example:
<nowiki>
{|
|a||b
|-
|c||d
|}
</nowiki>
{|
|a||b
|-
|c||d
|}
Headings for columns and rows can be made by using an exclamation point, !,
rather than a vertical bar |. For example,
<nowiki>
{|
!a!!b
|-
|c||d
|}
</nowiki>
{|
!a!!b
|-
|c||d
|}
Captions can be added using the + symbol:
<nowiki>
{|
|+ My Caption
!a!!b
|-
|c||d
|}
</nowiki>
{|
|+ My Caption
!a!!b
|-
|c||d
|}
Finally, you can put a CSS class or style attributes (or both) on the first line
of the table to further control how it looks:
<nowiki>
{| class="wikitable"
|+ My Caption
!a!!b
|-
|c||d
|}
</nowiki>
{| class="wikitable"
|+ My Caption
!a!!b
|-
|c||d
|}
Within a cell attributes like align, valign, styles, and class can be used. For
example,
<nowiki>
{|
| style="text-align:right;"| a| b
|-
| lalala | lalala
|}
</nowiki>
{|
| style="text-align:right;"| a| b
|-
| lalala | lalala
|}
==Math==
: Math can be included into a wiki document by either using the math tag:
<nowiki>
<math>
\sum_{i=1}^{n} i = frac{(n+1)(n)}{2}
</math>
</nowiki>
<math>
\sum_{i=1}^{n} i = frac{(n+1)(n)}{2}
</math>
or by enclosing the math in backticks:
<pre>
`[[1, -2],[3,4]]`
</pre>
`[[1, -2],[3,4]]`.
Rendering of math is done using [[https://www.mathjax.org/|MathJax]], making us of the [[https://en.wikipedia.org/wiki/ASCIIMathML|ASCIImathml]] extensions.
==Links and Relationships==
: A hypertext link to another document can be inserted into a wiki page using
the chain link icon in the GUI. Alternatively, there are several techniques
for inserting a link into a page depending on whether the link is to a page
within the same wiki group, is a link to a page on a different wiki
group, or is a link to a different website. In addition to normal
hypertext links, Yioop also supports relationship links.
'''Intra-Group Wiki Links''' use the syntax:
<nowiki>
[[name_of_wiki_page]]
or
[[name_of_wiki_page|text for the link]]
or
[[name_of_wiki_page#heading_or_id_on_page|text for the link]]
</nowiki>
for example, to make a link to this Syntax page one could write,
<nowiki>
[[Syntax|Yioop Wiki Syntax Page]]
</nowiki>
which would look like,
[[Syntax|Yioop Wiki Syntax Page]]
'''Inter-Group Wiki Links''' use the syntax:
<nowiki>
[[name_of-group@name_of_wiki_page|text for the link]]
</nowiki>
'''Different Website Links''' use the syntax:
<nowiki>
[[website_url|text for the link]]
</nowiki>
: Relationships are a generalized form of link. They are used to express
a more complicated linking between two wiki pages and have the syntax:
<nowiki>
[[relationship_type|wiki_page_name|text for the link]]
</nowiki>
: In the navigation dropdown for a Yioop wiki page there are items for
what links to the current page and what relates to the current page
based on the links and relationships a page belongs to.
==Recent Places Dropdowns==
: You can add a dropdown that can allow users to navigate to recently visited
wiki pages using the syntax:
<sub>`[`{recent_places}]</sub>
This looks like:
[{recent_places}]
==Adding Resources to a Page==
: Yioop wiki syntax supports adding search bars, audio, images, and video to a
page. The magnifying class edit tool icon can be used to add a search bar via
the GUI. This can also be added by hand with the syntax:
<nowiki>
{{search:default|size:small|placeholder:Search Placeholder Text}}
</nowiki>
This syntax is split into three parts each separated by a vertical bar |. The
first part search:default means results from searches should come from the
default search index. You can replace default with the timestamp of a specific
index or mix if you do not want to use the default. The second group size:small
indicates the size of the search bar to be drawn. Choices of size are small,
medium, and large. Finally, placeholder:Search Placeholder Text indicates the
grayed out background text in the search input before typing is done should
read: Search Placeholder Text. Here is what the above code outputs:
{{search:default|size:small|placeholder:Search Placeholder Text}}
: Image, video and other media resources can be associated with a page by dragging
and dropping them in the edit textarea or by clicking on the link click to select
link in the gray box below the textarea. This would add wiki code such as
<sub>((resource`:`myphoto.jpg|Resource Description))</sub>
to the page. Only saving the page will save this code and upload the resource to
the server. In the above ''myphoto.jpg'' is the resource that will be inserted and
Resource Description is the alternative text to use in case the viewing browser
cannot display jpg files. To add a resource
from a different wiki page belonging to the same group to the current wiki
page one can use a syntax like:
<sub>((resource`:`Documentation:ConfigureScreenForm1.png|The work directory form))</sub>
Here Documentation would be the page and ConfigureScreenForm1.png the resource.
You can also insert resources from a data-string using ''resource-data'' rather than
''resource''. For example:
<sub>((resource-data`:`image/jpeg;base64,/9j/4AAQSkZJRg...rest of image data...|Seekquarry Logo))</sub>
could be used to inline an image like:
((resource-data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4QBYRXhpZgAATU0AKgAAAAgAAgESAAMAAAABAAEAAIdpAAQAAAABAAAAJgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAtqADAAQAAAABAAAAewAAAAD/7QA4UGhvdG9zaG9wIDMuMAA4QklNBAQAAAAAAAA4QklNBCUAAAAAABDUHYzZjwCyBOmACZjs+EJ+/8AAEQgAewC2AwEiAAIRAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKC//EALUQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+v/EAB8BAAMBAQEBAQEBAQEAAAAAAAABAgMEBQYHCAkKC//EALURAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYSQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/bAEMAGhoaGhoaLRoaLUAtLS1AV0BAQEBXbVdXV1dXbYRtbW1tbW2EhISEhISEhJ6enp6enri4uLi4z8/Pz8/Pz8/Pz//bAEMBICIiNTE1WjExWtiTeJPY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2P/dAAQADP/aAAwDAQACEQMRAD8A0dS1L7GBHGAZGGeegFZCQavejzSzAHpubaPyFRX5H9rHz/ublznpt4rsRgjI6UAcqbDV4BvRycf3XJ/Q1Z0/VneQW1394nAbpz6GuirA1HS5ri58622jI5yccjvwKAN+imrnaN3XHNRz3ENunmTMFH8/pQBNRWC2vW4OFjYj3IH9at2uq2tywQEox6Bu/wBD0oA06KKY7pGheQhVHUmgB9FYcmu2qnEasw9eAP1qSDWrSVtr5j9zjH5igDYrn9cuJ4DF5Llc7s4Ppit/rzXNeIesP0b+lAG7Zsz2kTuckopJ/CrNVLD/AI8of+ua/wAqbd30FmB5uST0C8n60AXaKrW1yLqPzUVlU9N3Gas0AFFFFABRRRQAUUUUAf/Q0dS00XoEkZ2yKMc9DWGG1XT/AJfnCj23L/X+ldNFfWk8vkxPubGeAf51coA5aHX5h/ro1b3U4/xrZtNStrs7UO1/7rdfw9ammsrW4/1sak+uOfzrl9SsPsMiSQk7WPGeoI5//VQB2VcXdytqF/syQgJA9gOv511NrMbizSY9WXn61xdlb3E8xW2IDBc9ccU15id7aG/GtvEu2NQBWdf28OwzxAKR1A6EVI1jqSffdVz6sB/SlbTNUdSrEEH3H+FaOUWrWMlCad7mzpV01zagucsh2k+vofyrG1i5kmuhaIflUgf8CPf8K1NJs7izWRZgAGwRg56VzsiTzam6RffMjYz/AJ9KyNma0EVvbrhQCe5PU1BeW8MyF0AVxyCO/saZLa6jCu6aRUHTJYD+lSCw1YjIYEH3H+Fa88drGPJLe5b0K6aSJrdjnZgr9D2/CoPEPWH6N/SpdL025tLkyygbSpHBz3FReIesP/Av6VkbF37dHZabCTy5jXav4dfpVGxsZL6T7beZKnkA/wAX/wBb/P1zlsLua0N22SFA2g9So9PYVv6Pe/aIfIkPzxjj3X1oA2AABgUtFFABRRRQAUUUUAFFFFAH/9GpdCXTNR81BkZLL6EHqP8APtXS22oWtyoKOA3908Gpp7eG5Ty5l3D+X0rDl0BScwy4Howz/hQBvvNEi7ndQB3JrltVvkvHSC2+YKevqTxgVMNAkzzKo+i//XrWtNMtrQ7wN7/3m7fT0oAsWkJt7WOA9VXB+veuXRjpepncPkyf++W/z+ldjVS7soLxAsw5HQjqKAMfVbea9aOe1HmpjHGKmur1tPs47cMDPtA9cep/wqH+w5UJ8mfAPsR/I1Lb6HEj77h/M5zgDA/HuaAL2mzXNxb+dcY+Y/LgY49awtSSWz1EXSDhiHH1HUV1gAAwOAKingiuI/LmXI/l9KAMK/jbVEinsiH25BGQCCcetXPPXTNPRJSDIFwFz1P+Aqo2hMj7reYj6jn8wRSx6EC++4lLfQcn8Tk0AWNKury63PPjYvAOMZNUvEPWH6N/SuiiijhQRxAKo6AVSv8AT1vihZyuzPQZ60ATWP8Ax4w/9c1/lXN3sEmmXizwcITlfT3H+e30rqoIhDCkIOdihc/So7u1ju4TDJ9QfQ+tADredLmFZo+jDp6e1T1nWNgbHcFkLK3YjHNaNABRRRQAUUUUAFFFFAH/0unooooAKjkljhTfKwVR3NNuJ0t4Wmk6KM//AFq5HF1q9wWJwF/JR7UAbkmt2afc3v8AQf44pY9asn+9uT/eH+FRRaXZxj5l3n1akl0q0kHyDyz6r/hSuVym0jpIoeMhgehFPri45bnSbnY3KnkgdGH+NdhHIksayxnKsMimSSUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFAH//T6eiiigDntflKxxwj+Ilj+HT9TU2mRCKzQ93+Y/jVLxDnfH/un+YrUs/+PSL/AHB/Kky4lmimSSJEhkkOFHU1yt3qE9zMFhJVc4UA4P4+9IpuxsavCJLXzMcxnP4Hg1JoUpa1aI/wNx9Dz/Oi63jTG845fZz9areHw2Z27fL/AFpoiR0tFU7q+t7PHnE5PQDk1PDNHcRiWI5U0ySlqN+LKIbRl2+6D0+prIjj1i/QS+YUVjkZO3I9gOf1rbudPtrtg8wOQMcEjipXurSH5XkRcdsigDnJoNXsUM3mMyjqQxOPwNbGl37XsbCTAdDzjuD0NR3GrWHlOoYvxjgHHPv0rP8AD5zJJ/uj+ZoA0dZuJba3R4WKkvg49MGstr29vY0gtNxIQFyOCT9ewq74g/49Y/8AroP5Gp9EjVbEOvV2JP4HH9KAIdKj1FJWW7LbQOjc5J9D7VQGrTwXM3msWC7gq9s54rrK421iEur4YZHmMfyJP86AHFNaY/aB5nqOQP8Ax3P9KtahcX1lLH+9JDKDjjkjqOneumrK1iDzbNnHWP5h9O/6UAaUciyxrInRgCPxpJZFhiaV+igk/hWTok/mWphJ5jOB9DyKTXJ/LthAOsh5/wB0cmgCHS5ry8kd5ZGCKOnuef0FbXkt/wA9GqrpcBgs0DD5n+Y/j/8AWrRoA//U6eiiigDE1yAyWwmUZMZ5+hqHSbhZLfyCfmj4/DtW+yhlKsMg8EVyl3ptzZS+fZ5Kjpjkj6juKBp2LWrQXMyoIRlRnIHr2NYtxp09rGsp5HfHatKPWmAxMgJ9QcfoaZPq7SqY4owN3HJz+gpFOxUl1F5rMWz8tkZJ7gVqWk6abpwkfmSU7lX26D8K5+a1nt0V5V27ugPXH0oZ5ruTdIST3Jo2Ek5OyCWSa7kaRzknk1q6JeeTN9nf7sn6N2/PpVZECLtWqcgMc25eM8j6/wD66iM7ux01cPyQUjf1e8maf7FAT2BxwST0FTwaFCqgzuS3cLwP8azr+OUtHqcY+WRVYn0YetaUevW2z96rBgOcYIrQ5C02nWFvE8nlg4UnLc9PrWXoH+tk/wBxf5mnzXV1qv8Ao9ohSM/eY9/xH9Kh0NvKu3hbqVI/FTQBe1//AI9o/wDroP5GrWkf8g6L8f5mquv/APHtH/10H8jVrSP+QdF+P8zQBp1yen/8hdv96T+ddZXJ6fj+12/3pP50AdZSEAgg9DS0UAcnYk2OqNbseCSn9Vpbn/T9XEI5VTtP0Xlv8Km1yJo5I7yPg9Cfccin6HEzGS7k5JO0fzP60AdDS0UUAf/V6eiiigAooooAhkt7eX/Wxq31ANUrqa002LcqKGP3VUAZP+FWbu6jtITNJ9APU+lcNNNNezl5Dlj+QHoPagaTbsglkmvZjJIck9+wH+FWkRUXatCIqLgU6ueUrnrUKCgrvcKp3DAyADtViWQRr79qfplk15cbnHyLyx9fb8aqnHqZYuqrciOssEKWUSOOQoyKkNpal95iTd67Rmp+nFLWx5ogAAwOKTauc4GadRQAhAPUZoAA4FLRQAU0KoOQBTqKACkyKWsvU7GS8VDEwVkz1z3+lAGfrV0HKWcJ3HOWA9ew/Otu0gFtbJCP4Rz9e9Zdho4tpBNOwZh0A6A+vvW7QAUUUUAf/9bp6KKKACiiigCnfWaXsPlMcEHII9a5W40a7g+ZBvHqOv5V21FAHnQlmjO1uo7HrTzctjhcGu4uLa3lX94it9RWcmn2W/8A1S1PKjZV5pWTOes7Ce+kz0Xuxrtbe3jtohFEMAVKqqg2qMD2p1UYthRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQB//9k=|The Seekquarry Logo))
be aware though that the default maximum wiki page size is 512Kb (this can be set in src/configs/Config.php).
: Sometimes it is useful to edit the basic resource link
above to make a link which is a thumbnail of the resource which points to a
separate page containing that resource. This can be done using the syntax:
<sub>((resource-thumb`:`myphoto.jpg|Resource Description))</sub>
: Similarly, by default for resources like PDFs, epub's, etc., the resource tag inlines
the whole resource into the page, if instead one wants a clickable link to a page where
the resource is displayed one can use the syntax:
<sub>((resource-link`:`my_document.pdf|Resource Description))</sub>
: Comma separated value files (.csv or CSV files) are inlined into a page as a table. Which rows and columns of the CSV to present in this table can be controlled by the resource line. The general format for including
a CSV resource is:
<sub> ((resource`:`resource_name.csv#config#top_left_cell#bottom_right_cell|Resource Description))</sub>
For example,
<sub>((resource`:`resource_name.csv##B2#C3|Resource Description))</sub>
might output
((resource-data:text/csv;base64,LCwsLAosLTIsMywsCiw1LDQsLAosLCwsCiwsLCwK##B2#C3|Example CSV with Headings))
I.e., just the portion of the CSV given by the rectangle between the cells B2 and C3. Using a config directive we can omit the spreadsheet row and column headings as follows:
<sub>((resource`:`resource_name.csv#noheadings#B2#C3|Resource Description)) </sub>
which might output
((resource-data:text/csv;base64,LCwsLAosLTIsMywsCiw1LDQsLAosLCwsCiwsLCwK#noheadings#B2#C3|Example CSV without Headings))
CSV spreadsheet files can also be used to output a variety of charts. The general format for the command to insert a chart resource is:
<sub>((resource-chart_type`:`resource_name.csv#char_config#x_start#x_end#y_start#y_end|Resource Description))</sub>
Here ''chart_type'' can be one of ''bargraph'', ''linegraph'', or ''pointgraph''. For example, one might have a line like:
<sub>((resource-bargraph`:`resource_name.csv##B1#B4#C1#C4|Quadratic Function)) </sub>
which could produce a chart like
((resource-bargraph:##(1,1)#(2,4)#(3,9)#(4,16)|Quadratic Function))
In the above example, the values for the `x` coordinates would come from the cells B1, B2, B3, B4 from
''resource_name.csv '' and the values for the `y` coordinates would come from cells C1, C2, C3, C4 from
''resource_name.csv ''. Alternatively, rather than use a CSV to get out data we can just list the points we want to plot with a command like:
<sub>((resource-bargraph`:`##(1,1)#(2,4)#(3,9)#(4,16)|Quadratic Function))</sub>
==Manipulating Page Resources==
: A list of media that have already been associated with
a page appears under the Page Resource heading below the textarea. This
table allows the user to rename and delete resources as well as insert the
same resource at multiple locations within the same document.
: The resources section of the edit page can be thought of as similar to
a folder in Windows or MacOS. One can have subfolders of the resource folder.
: The '''Places''' dropdown at the top of the '''Page Resource''' section allows one to navigate
these folders.
: The '''Filter''' textfield lets you enter a search string.
Clicking '''Go''' then shows only those resources
which contain that search string in their title.
: The '''Clip Folder''' dropdown is used to copy files between folders and pages.
Its current value is the folder that the '''Clip Copy''' buttons next to resources
will copy their resource to when clicked. You can set the '''Clip Folder''' to
the current folder using the dropdown, then move to the page and folder that
you would like to copy stuff from and click the '''Clip Copy''' button of the
desired resource.
: The '''Name''', '''Size''', '''Modified''' header links above the resources list
control the sort order for the resource list. If a page is a media list page,
then even in read mode, the sort order selected is remembered when drawing the
media list.
: The '''Actions''' drop can be used to create new folders, new text files, and new csv
text files within the current page resource folder. These are initial named beginning
with ''untitled'' followed by some number, and if applicable a file extension.
: Resources entries for the resources list consist first of an icon, followed by a textfield
with a name for the resource, followed by buttons for actions that can be done to that resource
(Rename, Add to Page, Clip Copy), followed by a link [X], which can be used to delete the resource.
If a resource is editable the icon will look like a plus sign together with a pencil. Clicking
on the icon will then let you edit the resource.
===Text and CSV Resources===
: For normal text files clicking edit will bring up a textarea with the context of the text to edit.
For CSV (comma separated value) files this will present the file as an editable spreadsheet.
Yioop spreadsheets can have equation much like Excel spreadsheets. Clicking on a cell lets one
edit its contents. For example, if in the cell A3
one entered the equation:
= A1+A2
then clicking out of the cell would cause it to refresh with the value of the sum of the contents of
cells A1 and A2. In addition, to the standard arithmetic operators ['*', '/', '+', '-', '%'], the
spreadsheet expressions can use float or integer literals, and can make use of the following table
of built-in functions:
{| class="wikitable"
!Function Name!!Description
|-
!avg(x1,...,xn), avg(x1:xn)|| computes average of values of cells listed as arguments
|-
!ceil(x)|| rounds the value of x up to nearest integer
|-
!cell(i,j)|| returns the contents of the cell with column name of letter j, and row name i. For example, cell(2,'B') would return the contents of cell B2.
|-
!col(value, search_row, start_col, end_col)|| searches the row ''search_row'' between the columns
''start_col'', ''end_col'' for ''value''. Returns the column name where this value was found or -1 if not found.
For example, col(3, 2, "B", "D") might return C if the cell C2 had value 3.
|-
!exp(x)|| computes `e^x`
|-
!floor(x)|| rounds the value of x down to the nearest integer
|-
!log(x)|| computes `log x`
|-
!min(x1,...,xn), min(x1:xn)|| computes minimum value of cells listed as arguments
|-
!max(x1,...,xn), max(x1:xn)|| computes maximum value of cells listed as arguments
|-
!pow(x,y)|| computes `x^y`
|-
!row(value, search_col, start_row, end_row)|| searches the column ''search_col''
between the rows ''start_row'', ''end_row'' for ''value''.
Returns the row name where this value was found or -1 if not found.
For example, row(3, "C", "1", "5") might return 2 if the cell C2 had value 3.
|-
!sqrt(x)|| computes `sqrt(x)`
|-
!sum(x1,...,xn), sum(x1:xn)|| computes sum of values of cells listed as arguments
|-
!username()|| returns username of the person using this CSV file
|}
===HTML, PDF and EPub Resources===
: How HTML, PDF, EPub resources included on a page render depends on how the Yioop wiki software
has been configured. If no special configuration has been done, then HTML and PDF documents
will bbe rendered in an <iframe> tag within the current wiki page. In the EPub, case a link
to download the resource will be given. If the wiki software detects the presence of the
file APP_DIR/scripts/pdf.js ([[https://en.wikipedia.org/wiki/PDF.js|PDF.js]])
or APP_DIR/scripts/epub.js ([[https://github.com/futurepress/epub.js|epub.js]]), the wiki
system will render the resource in a Javascript viewer and will do things like remember reading
position.
===Video and Audio Resources===
: Not all browsers support the same video and audio formats for playback. For this reason
it sometimes is useful to have multiple video resources for the same video. For example,
you might have a .ogv and .vp8 version of the same video recording. In read (non-edit)
mode, the Yioop wiki system displays only one link for video or audio files that have
the same name except for extension. It then includes the grouped file as separated <source>
tags within either the <video> or <audio> html tag used to render the item in the browser.
In this way, you can make your media take best advantages to whatever capabilities your
client's browser has. If you don't feel like recoding your media in such a fancy way, a safe
rule of thumb is that .mp3 audio will playback in all modern browser, and that .mp4 video
will playback in all modern browser.
: For video it is sometimes useful to add a subtitle or caption track. Yioop wiki supports
[[https://en.wikipedia.org/wiki/WebVTT|WebVTT]] format subtitles and captions. To see how
Yioop wiki makes use of these files, suppose you included a resource ''foo.mp4'' in your
wiki pages, and you also had a file named ''foo-captions-en-US.vtt'' then when the HTML
page is generated from your wiki page, a <track> tag for the caption file would be added
to the <video> tag. A user seeing this page would then see in the video player a closed caption
symbol and be able to turn on/off (defaults off) the English captions. If you wanted
named the file ''foo-subtitles-en-US.vtt'' instead, then Yioop wiki would include it as a
subtitles track (defaults on). You can add captions/subtitle files for as many languages as
desired.
: When viewing the page resources for a page in edit mode, one can see one file/resource and
no grouping of resources by name is done. In this way you can keep track of exactly what
resources are available for a page.
==Page Settings, Page Type==
: In edit mode for a wiki page, next to the page name, is a link [Settings].
Clicking this link expands a form which can be used to control global settings
for a wiki page. This form contains a drop down for the page type, another
drop down for the type of border for the page in non-logged in mode,
a checkbox for whether a table of contents should be auto-generated from level 2
and level three headings and then text
fields or areas for the page title, author, meta robots, and page description.
Beneath this one can specify another wiki page to be used as a header for this
page and also specify another wiki page to be used as a footer for this page.
: The contents of the page title is displayed in the browser title when the
wiki page is accessed with the Activity Panel collapsed or when not logged in.
Similarly, in the collapsed or not logged in mode, if one looks as the HTML
page source for the page, in the head of document, <meta> tags for author,
robots, and description are set according to these fields. These fields can
be useful for search engine optimization. The robots meta tag can be
used to control how search engine robots index the page. Wikipedia has more information on
[[https://en.wikipedia.org/wiki/Meta_element|Meta Elements]].
: The '''Standard''' page type treats the page as a usual wiki page.
: '''Page Alias''' type redirects the current page to another page name. This can
be used to handle things like different names for the same topic or to do localization
of pages. For example, if you switch the locale from English to French and
you were on the wiki page dental_floss when you switch to French the article
dental_floss might redirect to the page dentrifice.
: '''Media List''' type means that the page, when read, should display just the
resources in the page as a list of thumbnails and links. These links for the
resources go to a separate pages used to display these resources.
This kind of page is useful for a gallery of
images or a collection of audio or video files.
: '''Presentation''' type is for a wiki page whose purpose is a slide presentation. In this mode,
....
on a line by itself is used to separate one slide. If presentation type is a selected a new
slide icon appears in the wiki edit bar allowining one to easily add new slides.
When the Activity panel is not collapsed and you are reading a presentation, it just
displays as a single page with all slides visible. Collapsing the Activity panel presents
the slides as a typical slide presentation using the
[[www.w3.org/Talks/Tools/Slidy2/Overview.html|Slidy]] javascript.
EOD;
$public_pages["en-US"]["ad_program_terms"] = <<< 'EOD'
page_type=standard
page_alias=terms
page_border=none
toc=true
title=Advertisement+Program+Terms
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS==Terms and Conditions==
EOD;
$public_pages["en-US"]["advertise"] = <<< 'EOD'
page_type=standard
page_alias=
page_border=none
toc=true
title=Advertise using Yioop
author=Chris Pollett
robots=
description=A Description of Advertising Available at Yioop
page_header=
page_footer=
END_HEAD_VARS==What Ad Services We Offer==
EOD;
$public_pages["en-US"]["bot"] = <<< 'EOD'
title=Bot
description=Describes the web crawler used with this
web site
END_HEAD_VARS
==My Web Crawler==
Please Describe Your Robot
EOD;
$public_pages["en-US"]["captcha_time_out"] = <<< 'EOD'
title=Captcha/Recover Time Out
END_HEAD_VARS
==Account Timeout==
A large number of captcha refreshes or recover password requests
have been made from this IP address. Please wait until
%s to try again.
EOD;
$public_pages["en-US"]["presentation"] = <<< 'EOD'
page_type=presentation
page_alias=
page_border=solid-border
toc=true
title=Test Presentation
author=
robots=
description=
alternative_path=
page_header=
page_footer=
END_HEAD_VARS=Title=
* Slide Item
* Slide Item
* Slide Item
....
=Title=
* Slide Item
* Slide Item
* Slide Item
....
EOD;
$public_pages["en-US"]["privacy"] = <<< 'EOD'
title=Privacy Policy
description=Describes what information this site collects and retains about
users and how it uses that information
END_HEAD_VARS
==We are concerned with your privacy==
EOD;
$public_pages["en-US"]["register_time_out"] = <<< 'EOD'
title=Create/Recover Account
END_HEAD_VARS
==Account Timeout==
A number of incorrect captcha responses or recover password requests
have been made from this IP address. Please wait until
%s to access this site.
EOD;
$public_pages["en-US"]["suggest_day_exceeded"] = <<< 'EOD'
EOD;
$public_pages["en-US"]["terms"] = <<< 'EOD'
=Terms of Service=
Please write the terms for the services provided by this website.
EOD;
//
// Default Help Wiki Pages
//
/**
* Help wiki pages
* @var array
*/$help_pages = [];
$help_pages["en-US"]["Account_Registration"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=Account+Registration
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe Account Registration field-set is used to control how user's can obtain accounts on a Yioop installation. The dropdown at the start of this fieldset allows you to select one of four
possibilities:
* '''Disable Registration''', users cannot register themselves, only the root
account can add users. When Disable Registration is selected, the Suggest A Url form and link on
the tool.php page is disabled as well, for all other registration type this
link is enabled.
* '''No Activation''', user accounts are immediately activated once a user
signs up.
* '''Email Activation''', after registering, users must click on a link which
comes in a separate email to activate their accounts. If Email Activation is chosen, then the rest of this field-set can be used to specify the email address that the email comes to the user. The checkbox Use
PHP mail() function controls whether to use the mail function in PHP to send the mail, this only works if mail can be sent from the local machine. Alternatively, if this is not checked like in the image above, one can
configure an outgoing SMTP server to send the email through.
* '''Admin Activation''', after registering, an admin account (an account having the admin role) must activate
the user before the user is allowed to use their account.
EOD;
$help_pages["en-US"]["Ad_Server"] = <<< EOD
EOD;
$help_pages["en-US"]["Add_Locale"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=Add+Locale
author=
robots=
description=Help+article+describing+how+to+add+a+Locale.
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS==Adding a Locale==
This form allows you to create a new &quot;Locale&quot;
-- an object representing a language and a region that can be used in translating Yioop
to a new language.
* The '''Name''' field should be filled in with a name for the locale in the language of the locale.
* So for French you would put Fran&ccedil;ais.
* The '''Locale tag''' field should be the IETF language tag. For example, fr-FR for French
from France.
* The '''Writing Mode''' dropdown is used to specify the direction that text is written in for the given
locale.
* The '''Locale Enabled''' checkbox says whether or not users of this Yioop installation can select this
locale from various language dropdown that appear on the Yioop site.
EOD;
$help_pages["en-US"]["Add_or_Edit_Pattern"] = <<< EOD
EOD;
$help_pages["en-US"]["Adding_Examples_to_a_Classifier"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSTo train a classifier one needs to add positive and negative examples of the concept that is to be learned. One way to add positive (negative) examples is to select an existing crawl and then marking that all (respectively, none) are in the class using the drop down below.
<br />
Another way to give examples is to pick an existing crawl, leave the dropdown set to label by hand. Then type some keywords to search for in the crawl you picked using the '''Keyword''' textfield and click '''Load'''. This will bring up a list of search results together with links '''In Class''', '''Not in Class''', and '''Skip'''. These can then be used to add positive or negative examples.
<br />
When you are done adding example, click '''Finalize''' to have Yioop actually build the classifier based on your training.
EOD;
$help_pages["en-US"]["Allowed_to_Crawl_Sites"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARS'''Allowed to Crawl Sites''' is a list of urls (one-per-line) and domains that the crawler is allowed to crawl. Only pages that are on sub-sites of the urls listed here will be crawled.
<br />
This textarea is only used in determining by can be crawled if '''Restrict Sites By Url''' is checked.
<br />
A line like:
<pre>
http://www.somewhere.com/foo/
</pre>
would allow the url
<pre>
http://www.somewhere.com/foo/goo.jpg
</pre>
to be crawled.
<br />
A line like:
<pre>
domain:foo.com
</pre>
would allow the url
<pre>
http://a.b.c.foo.com/blah/
</pre>
to be crawled.
EOD;
$help_pages["en-US"]["Arc_and_Re-crawls"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARS'''Crawl or Arc Folder to Re-index''' dropdown allows one to select a previous Yioop crawl or an archive to do another crawl of. Possible archives that can be index include Arc files, Warc Files, Email, Database dump, Open Directory RDF dumps, Media Wiki dumps etc. Re-crawling an old crawl might be useful if you would like to do further processing of the records in the index. Besides containing previous crawls, the dropdown list is populated by looking at the WORK_DIRECTORY/archives folder for sub-folders containing an arc_description.ini file.
<br />
{{right|[[https://www.seekquarry.com/?c=static&p=Documentation#Archive%20Crawl%20Options| Learn More.]]}}
EOD;
$help_pages["en-US"]["Authentication_Type"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=Authentication+Type
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Authentication and Access''' field-set is used to control people log into Yioop and how their sessions are maintained once logged in.
<br>
The '''Authentication Type''' dropdown controls the protocol used for logging in:
* Below is a list of Authentication types supported.
** '''Normal Authentication''', passwords are checked against stored as
salted hashes of the password; or
** '''ZKP (zero knowledge protocol) authentication''', the server picks
challenges at random and send these to the browser the person is logging in
from, the browser computes based on the password an appropriate response
according to the Fiat Shamir protocol. The password is never sent over the
internet and is not stored on the server. These are the main advantages of
ZKP, its drawback is that it is slower than Normal Authentication as to prove
who you are with a low probability of error requires several browser-server
exchanges.
* You should choose which authentication scheme you want before you create many
users as if you switch everyone will need to get a new password.
<br>
The '''Timezone''' field controls the timezone used for dating posts and other events once a
user is logged in.
<br>
The '''Token Name''' field controls the name of the token variable which appears in URLs that is used in conjunction
with cookies to determine if a user is logged. It is there to prevent cross-site request forgery attacks
on a Yioop website.
<br>
The '''Session Name''' field controls the name of the cookie that will be stored in a user's browser to maintain a session once logged into Yioop.
<br>
The '''Autologout''' dropdown specifies how long a session can be inactive before a user will be logged out.
EOD;
$help_pages["en-US"]["Bot_Configuration"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe Bot Configuration field-set is used to control whether user's of this Yioop instance can be chat bots.
<br/>
If enabled, under '''Manage Accounts''' a Yioop user can check a checkbox to declare to be a chat bot. Chat bot user can then give a callback url where the bot functionality will be implemented.
<br/>
Suppose a chat bot user has a name user name, ''user1''. If that chat bot user belongs to a group, and in an already existing thread, someone posts a follow up comment containing ''user1'', then that message will be sent in a post field together with a bot_token field to the Bot user's callback url. The response from the url will then be used in a response to the comment (if any).
EOD;
$help_pages["en-US"]["Bot_Story_Patterns"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSHow a Chat Bot in Yioop behaves is determined by how it is configured in its Bot Story activity.
A Bot Story is a set of patterns that control how a chat bot reacts to group threads posts
for groups to which it belongs. A bot story pattern consists of the following components which are
configurable in the Bot Story activity:
; '''Request Expression''' : This and the trigger state are used to determine if a bot will react to a post. If a post contains @name_of_the_bot followed by some phrase or phrases which match the expression and the trigger state matches the trigger state of the bot for that user, then the pattern will apply. Request expressions are allowed to contain variables. They are strings beginning with $ followed by a sequence of word characters. For example, the expression:<br />''What is the weather in $location?''<br />would match the string<br />''What is the weather in San Jose?''<br /> and the value of $location would get bound to San Jose in this match.
; '''Trigger State''' : A chat bot has a particular state it is in with respect to each user in a group. This state can be any string, but it starts at being the string "0". If the current state of the bot for a user matches a pattern's trigger state and the last post of a user matches the request expression for the pattern then the pattern is activated. In the add pattern/edit pattern forms one can use simple strings or strings containing variables in defining a trigger state. For example, "0", "asleep" are simple trigger states. One can also have "1$location". If the request expression for a pattern was "What is the weather in $location?" and the user was in state "1San Jose" and posted a message "What is the weather in San Jose?" then this pattern would activate.
; '''Remote Message''' : If a bot url has been configured for a chat bot, then when a pattern is activated a request will be made to that url as part of computing the response the chat bot makes to the message which was just posted. The url request will have as part of its query string a variable ''remote_message'' which comes from this field of the Bot Pattern. The Remote Message can be any string and is allowed to have variables in it. So for example, a pattern's Remote Message might be getWeather,$location. When the value of $location is substituted with might become getWeather,San Jose. This tells the bot url site what action to perform with what value.
; '''Result State''' : This is the state the chat bot should enter for that user after the pattern is applied. It is allowed to be an arbitrary string and can have variables in it. These will be interpolated when the pattern is applied.
; '''Response''' : This is the text that the chat bot will post back to the thread in question in response to a user request. It is a string and can have variables. In addition, to variables bound from the Request Expression, it can make use of $REMOTE_RESPONSE which has the string returned from the Bot url call (if there was one), and it can make use of $USER_NAME, the name of the user that the post was in response to.
EOD;
$help_pages["en-US"]["Bot_User"] = <<< EOD
EOD;
$help_pages["en-US"]["Browse_Groups"] = <<< EOD
page_type=standard
page_border=solid-border
toc=true
title=Browse Groups
END_HEAD_VARS==Creating or Joining a group==
You can create or Join a Group all in one place using this Text field.
Simply enter the Group Name You want to create or Join. If the Group Name
already exists, you will simply join the group. If the group name doesn't
exist, you will be presented with more options to customize and create your
new Group.
==Browse Existing Groups==
You can use the [Browse] hyper link to browse the existing Groups.
You will then be presented with a web form to narrow your search followed by
a list of all visible groups to you beneath.
{{right|[[https://www.seekquarry.com/?c=static&p=Documentation#Managing%20Users,%20Roles,%20and%20Groups| Learn More..]]}}
EOD;
$help_pages["en-US"]["CMS_Detectors"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS'''CMS Detectors''' are used to help Yioop get to the most important content on a web page.
<br /><br />
You must enter the '''Name'''. The Header Regex and Important Content XPath are optional but will have no effect if they are not entered.
<br />
'''The Header Regex''' is used to detect the CMS. The header of most CMS created sites are very common. A specifically crafted regular expression can be used to detect the CMS you are looking for. It looks in the href value in a rel='stylesheet' tag or the src value in a type='text/javascript' tag.
<br /><br />
The '''Important Content XPath''' is used to target the most important content for summarizing. The first entry is where to target the important content. Any subsequent entry will be used to remove content within the important content. Append each removal XPath to the end of the value delimited by three pound signs (###).
<br />
'''Example:'''
<br /><br />
<table border='1'>
<th>Setting</th> <th>Value</th>
<tr><td>Name</td><td>Wordpress</td></tr>
<tr><td>Header Regex </td><td>wp-(?:content|includes)</td></tr>
<tr><td>Important Content XPath</td><td>//div[@id="content"]###<br />//div[@id="comments"]###<br />//div[@id="respond"]</td></tr>
</table>
<br />
EOD;
$help_pages["en-US"]["Captcha_Type"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=Captcha+Type
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe Captcha Type field set controls what kind of
[[https://en.wikipedia.org/wiki/CAPTCHA|captcha]] will be used during account
registration, password recovery, and if a user wants to suggest a url. The choices for captcha are:
* '''Hash captcha''', the user's browser (the user doesn't need to do anything)
needs to extend a random string with additional characters to get a string
whose hash begins with a certain lead set of characters.
* '''Graphic Captcha''', the user needs to enter a sequence of characters from
a distorted image;
Of these, Hash Captcha is probably the least intrusive but requires
Javascript and might run slowly on older browsers.
The graphic captcha is probably the one people are most familiar with.
EOD;
$help_pages["en-US"]["Changing_the_Classifier_Label"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSThe label of a classifier determines what meta-words will be added to pages that have that concept.
<br />
If the label is foo, and the foo classifier is used in a crawl, then pages which have the foo property
will have the meta-word class:foo added to the list of words that are indexed.
EOD;
$help_pages["en-US"]["Configure_Media_Jobs"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Configure Media Jobs''' activity let's one specify which media jobs should be run and how they should be run. Media jobs are periodic jobs which are run by a Yioop installation.<br><br>
The '''Mode''' toggle let's one choose if the media updater is only run on the name server or if it is also run on all of the machines associated with a name server (distributed mode). The former is easier to manage, the later can improve the performance of some of media updater jobs such as video conversion and news feed download. Even in distributed mode some jobs will still only run on the name server if they weren't programmed to take advantage of the distributed setting.<br><br>
The '''Jobs List''' table contains a list of all jobs that either came with the Yioop software or were programmed by someone and added to the WORK_DIRECTORY/app/library/media_jobs folder (the folder does not exist unless created by that someone). Next to each job is an On/Off dropdown used to control if the job will be run when the MediaUpdater is running. Below is a brief description of the jobs that come with the Yioop software:
* '''Analytics''' computes hourly, daily, monthly, etc statistics for search queries and group feed, tread, and page views. It also is used to compute statistics about the kinds of pages downloaded during a crawl.
* '''BulkEmail''' is used to send email notifications from Yioop (registration, thread posts, etc.) when ''Send Mail From Media Updater'' is checked in the '''Server Settings''' activity.
* '''FeedsUpdate''' is used to periodically down feed sources (rss, json, html, regex) to be included in the IndexDataFeed bundle used for news, sports, etc feeds. It also computes trending word statistics for these feeds.
* '''Recommendation''' is used to compute group and thread suggestions for users.
* '''TrendingHighlights''' is used to update trending value search sources (values on a web page that change frequently that a user wants to track) and to compute hourly, daily, monthly, etc statistics for them. It also computes the landing page highlights for trending term, and feed subsearches that are being used for highlights.
* '''VideoConvert''' is used to convert videos that have been uploaded to wiki pages into mp4 videos that work in all browsers.
* '''WikiMedia''' is used to download feed podcasts to group wiki pages.
EOD;
$help_pages["en-US"]["Crawl_Mixes"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSA '''Crawl Mix''' allows one to combine several crawl indexes into one to greater customize search results. This page allows one to either create a new crawl mix or find and edit an existing one.
<br />
Clicking '''Set as Index''' on a crawl mix means that by default the given crawl mix will be used to serve search results for this site.
EOD;
$help_pages["en-US"]["Crawl_Order"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARS'''Crawl Order''' controls how the crawl determines what to crawl next.
<br />
'''Breadth-first Search''' means that Yioop first crawls the seeds sites, followed by those
sites directly linked to the seed site, followed by those directly linked to sites directly linked
to seed sites, etc.
<br />
'''Page Importance''' gives each seed site an initial amount of cash. Yioop then crawls the seed sites. A given crawled page has its cash splits amongst the sites that it link to based on the link quality and whether it has been crawled yet. The sites with the most cash are crawled next and this process is continued.
EOD;
$help_pages["en-US"]["Crawl_Robot_Set-up"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Crawl Robot Set-up''' fieldset is used to provide websites that you crawl with information about who is crawling them.
*The field '''Crawl Robot Name''' is used to the USER-AGENT header sent by your robot. It has the format:<br>
<code>
Mozilla/5.0 (compatible; NAME_FROM_THIS_FIELD; YOUR_SITES_URL/bot)
</code><br>
The value sent will be common to all fetcher traffic from the same queue server on the site when downloading webpages.<br>
If you are doing crawls using multiple queue servers you should give the same value to each queue server. The value of YOUR_SITES_URL comes from the Server Settings - Name Server URL field.
*The '''Robot Instance''' field is used for web communication internal to a single yioop instance to help identify which queue server or fetcher under that queue server was involved. This string should be unique for each queue server in your Yioop set-up. The value of this string is written when logging requests between fetchers and queue servers and can be helpful in debugging.
*The '''Robot Description''' field is used to specify the Public bot wiki page. This page can also be accessed and edited under Manage Groups by clicking on the wiki link for the Public group and then editing its Bot page. This wiki page is what's display when someone goes to the URL:<br>
YOUR_SITES_URL/bot
<br>
The point of this page is to give web owners both contact info for your bot as well as a description of how your bot crawls web sites.
EOD;
$help_pages["en-US"]["Create_Group"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=Create+Group
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS''This form appears when the Group Name is available to create a new Group. ''
----
'''Name'''
* Is used to specify the name of the new Group.
'''Register'''
* Says how other users are allowed to join the group:
* <u>No One</u> means no other user can join the group (you can still invite
other users).
* <u>By Request</u> means that other users can request the group owner to join
the group.
* <u>Anyone</u> means all users are allowed to join the group.
'''Access'''
* Controls how users who belong/subscribe to a group
other than the owner can access that group.
* <u>No Read</u> means that a non-owner member of the group cannot read or
write the group news feed and cannot read the group wiki.
* <u>Read</u> means that a non-owner member of the group can read the group
news feed and the groups wiki page.
* <u>Read Comment</u> means that a non-owner member of the group can read the
group feed and wikis and can comment on any existing threads, but cannot start
new ones.
* <u>Read Write</u> means that a non-owner member of the group can start new
threads and comment on existing ones in the group feed.
* <u>Read Write Wiki</u> means that a non-owner member of the group can start new
threads, can comment on existing ones in the group feed, and can edit and create
wiki pages for the group's wiki.
'''Voting'''
* Specifies the kind of voting allowed in the new group.
* + Voting allows users to vote up posts and users,
* - Voting allows users to vote down posts and users.
* +/- Voting allows users to vote up and down posts and users..
'''Post Life time'''
* Specifies How long the posts should be kept.
'''Encryption'''
* Says whether the posts in this group should be encrypted on the server.
It does not enable encryption of wiki pages or media uploaded to a group.
Enabling encryption means that posts will no longer be searchable. Once
you choose a group as encrypted, you are not able to change it to be unencrypted.
Similarly, you can't change an unencrypted group into a encrypted one. Yioop
maintains two databases a private and public one. Encrypted posts are stored
in the public database, group keys needed to decrypt and display them are stored
in a private database. Each post is encrypted using the group key and a unique per
post random salt vector. The idea is if an intruder steals only one of the
two databases it will be difficult for them to decrypt the posts.
EOD;
$help_pages["en-US"]["Database_Setup"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=Database+Setup
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe database is used to store information about what users are allowed to use the admin panel and what activities and roles these users have.
* The Database Set-up field-set is used to specify what database management
system should be used, how it should be connected to, and what user name and
password should be used for the connection.
* Supported Databases
** PDO (PHP's generic DBMS interface).
** Sqlite3 Database.
** Mysql Database.
* Unlike many database systems, if an sqlite3 database is being used then the
connection is always a file on the current filesystem and there is no notion of
login and password, so in this case only the name of the database is asked for.
For sqlite, the database is stored in WORK_DIRECTORY/data.
* For single user settings with a limited number of news feeds, sqlite is
probably the most convenient database system to use with Yioop. If you think you
are going to make use of Yioop's social functionality and have many users,
feeds, and crawl mixes, using a system like Mysql or Postgres might be more
appropriate.
EOD;
$help_pages["en-US"]["Debug_Display"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Debug Display''' fieldset consists of checkboxes which control the debugging features of Yioop that are enabled.
*The '''Error Info''' checkbox controls whether or not PHP errors, warnings and notices that are output from Yioop. Whether the output is then displayed in the browser or to a log file is controlled by the php.ini of your php install.
*The '''Query Info''' checkbox controls whether or not Yioop appends to each page information about how long each database and search query took.
*The '''Test Info''' checkbox controls whether or not Yioop unit tests are visible from the Yioop site. If checked, the '''Test Info''' link takes one to the unit tests.
EOD;
$help_pages["en-US"]["Disallowed_and_Sites_With_Quotas"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARS'''Disallowed to Crawl Sites''' are urls or domains (listed one-per-line) that Yioop should not crawl.
<br />
A line like:
<pre>
http://www.somewhere.com/foo/
</pre>
would disallow the url
<pre>
http://www.somewhere.com/foo/goo.jpg
</pre>
to be crawled.
<br />
A line like:
<pre>
domain:foo.com
</pre>
would disallow the url
<pre>
http://a.b.c.foo.com/blah/
</pre>
to be crawled.
<br />
'''Sites with Quotes''' are urls or domains that Yioop should at most crawl some fixed number of urls from in an hour. These are listed in the same text area as Disallowed to Crawl Sites. To indicate the quota one lists after the url a fragment #some_number. For example,
<pre>
http://www.yelp.com/#100
</pre>
would restrict crawling of urls from Yelp to 100/hour.
EOD;
$help_pages["en-US"]["Discover_Groups"] = <<< EOD
page_type=standard
page_border=solid-border
toc=true
title=Discover Groups
END_HEAD_VARS'''Name''' Field is used to specify the name of the Group to
search for.
'''Owner''' Field lets you search a Group using it's Owner name.
<br />
'''Register''' dropdown says how other users are allowed to join the group:
* <u>No One</u> means no other user can join the group (you can still invite
other users).
* <u>By Request</u> means that other users can request the group owner to join
the group.
* <u>Anyone</u> means all users are allowed to join the group.
<br />
''It should be noted that the root account can always join any group.
The root account can also always take over ownership of any group.''
<br />
The '''Access''' dropdown controls how users who belong/subscribe to a group
other than the owner can access that group.
* <u>No Read</u> means that a non-owner member of the group cannot read or
write the group news feed and cannot read the group wiki.
* <u>Read</u> means that a non-owner member of the group can read the group
news feed and the groups wiki page.
* <u>Read</u> Comment means that a non-owner member of the group can read the
group feed and wikis and can comment on any existing threads, but cannot start
new ones.
* <u>Read Write</u>, means that a non-owner member of the group can start new
threads and comment on existing ones in the group feed and can edit and create
wiki pages for the group's wiki.
<br />
The access to a group can be changed by the owner after a group is created.
* <u>No Read</u> and <u>Read</u> are often suitable if a group's owner wants to
perform some kind of moderation.
* <u>Read</u> and <u>Read Comment</u> groups are often suitable if someone wants
to use a Yioop Group as a blog.
* <u>Read</u> Write makes sense for a more traditional bulletin board.
EOD;
$help_pages["en-US"]["Edit_Search_Results"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThis pane is used to edit how a url is displayed in search results.
<br><br>
To edit a url give the full url (including http:// or https://) in the Url field and click the Load button. This will take you to a screen where you can see and change how that url is currently edited, or if the URL has never been edited, it will allow you to edit it.
<br>
On this page, you will see an Action drop down with two choices:
* '''Filter Host'''
* '''Edit Search Results'''
<br>
'''Filter Host''' will remove any url with the same hostname as the input url from the search results. For example, if one loaded the url: http://a.com/b/c, then filtering it would add an entry for the host http://a.com/ into the results to be filtered. Anytime, when a url with this host would have appeared in search results, it will be removed.
<br>
'''Edit Search Results''' option will reveal Title and Description fields in which a user can enter the title text and snippet descriptions they would like to have when the URL is displayed in search results. This does not usually filter results from search, but instead just changes them. However, if one wants to filter a single URL rather than a host name one can select the '''Edit Search Results''' option and leave both fields blank and click Save.
EOD;
$help_pages["en-US"]["Editing_Locales"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Edit Locale''' form can be used to specify how various message strings in Yioop are translated in different languages.<br><br>
The edit locale table has two columns: a column of string identifiers and a column of translations. A string identifier refers to a location in the code marked as needing to be translated, the corresponding translation in that row is how it should be translated for the current locale. Identifiers typically specify the code file in which the identifier occurs. For example, the identifier<br>
<code>
serversettings_element_name_server
</code><br>
would appear in the file views/elements/server_settings.php . To see where this identifier occurs one could open that file and search for this string.<br><br>
If no translation exists yet for an identifier the translation value for that row will appear in red. Hovering the mouse over this red field will show the translation of this field in the default locale (usually English). <br><br>
The '''Show Dropdown''' allows one to show either all identifiers or just those missing translations. The filter field let's one to see only identifiers that contain the filter as a substring.
EOD;
$help_pages["en-US"]["Editing_a_Crawl_Mix"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSA crawl mix is built out of a list of '''search result fragments'''.
<br />
A fragment has a '''Results Shown''' dropdown which specifies up to how many results that given fragment is responsible for. If one that had three fragments, the first with this value set to 1 the next with it set to 5 and the last set to whatever. Then on a query the Yioop will try to get the first result from the first fragment, up to the next five results from the next fragment, and all remaining results from the last fragment. If a given fragment doesn't produce results the search engine skips to the next fragment.
<br />
The '''Add Crawls''' dropdown can be used to add a crawl to the given fragment. Several crawl indexes can be added to a given fragment. When search results are computed for the fragment, the search is performed on all of these indexes and a score for each result is determined. The '''Weight''' dropdown can then be set to specify how important a given indexes score of a result should be in the total score of a search result. The top totals scores are then returned by the fragment. If when performing the search on a given index you would like additional terms to be added to the query these can be specified in the '''Keywords''' field.
EOD;
$help_pages["en-US"]["Filtering_Search_Results"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARS==Filter Websites From Results Form==
The textarea in this form is used to list hosts one per line which are to be removed from any search result page in which they might appear. Lines in the textarea must be hostnames not general urls. Listing a host name like:
<pre>
http://www.cs.sjsu.edu/
</pre>
would prevent any urls from this site from appearing in search results. I.e., so for example, the URL
<pre>
http://www.cs.sjsu.edu/faculty/pollett/
</pre>
would be prevented from appearing in search results.
EOD;
$help_pages["en-US"]["Indexing_Plugins"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARS'''Indexing Plugins''' are additional indexing processors that a document can be made to go through during the indexing process. Users who know how to code can create their own plugins using the plugin API. Plugins can be used to extract new "micro-documents" from a given document, do clustering, or can be used to control the indexing or non-indexing of web pages based on their content.
<br />
The table below allows a user to select and configure which plugins should be used in the current crawl.
<br />
{{right|[[http://www.seekquarry.com/?c=static&p=Documentation#Page%20Indexing%20and%20Search%20Options|Learn More..]]}}
EOD;
$help_pages["en-US"]["Kinds_of_Summarizers"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSYioop uses a '''summarizer''' to extract from a downloaded, or otherwise acquired document, text that it will add to its index. This text is also used for search result snippet generation. Only terms which appear in this summary can be used to look up a document. Text region scores, such as sentence scores, determined when a summary is made are used in calculating the order of search results.
<br />
The <b>Basic</b> summarizer computes a summary by proceeding top to bottom through the document looking for block level tags such as h1, div, p, etc. Based on the distance from the top of the document, the tag type, and the length of the tag's contents, a score for its contents is calculated. The highest scoring regions in the whole document up to the summary length are then returned in the order they appeared in the document as the summary.
<br />
The <b>Centroid</b> summarizer computes a summary by stripping all tags from the document and then splitting the document into "sentence" units. For each sentence, a vector is made with components the terms appearing in the sentence, and with values the term frequency times the inverse sentence frequency of that term. Using the scores for each sentence, an average sentence vector is computed. Sentences are then ranked by their normalized inner product with the average sentence. Top scoring sentence up to the summary length are then returned in the order they appeared in the document as the summary.
<br />
The <b>Centroid-Weighted</b> summarizer computes a summary by stripping all tags from the document and then splitting the document into "sentence" units. Then for each sentence it makes a normalized vector of term frequencies (no inverse sentence frequencies). It then computes a weighted average of these vectors where the weighting is based on distance from the start of the documents. The sentence closest to the average sentence based on inner product is determined. The components of this sentence are deleted from the average, and then the next best sentence is determined using the residual average. This process is continued until up-to-summary-length text has been extracted. Sentences found up to the summary length are then returned in the order they appeared in the document as the summary.
<br />
The <b>Graph-Based</b> summarizer computes a summary by stripping all tags from the document and then splitting the document into "sentence" units. An weighted adjacency matrix between sentences is then computed. The distance between two sentences is calculated using a distortion measure. Using this adjacency matrix, a sentence rank is computed using the power method (similar to Google's Page rank). Top scoring sentence up to the summary length are then returned in the order they appeared in the document as the summary.
EOD;
$help_pages["en-US"]["Knowledge_Wiki_Results"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSKnowledge Wiki (Kwiki) Results appear as display boxes at the top of search results for a query. For example, one might search on Canada and have a display box to the side at the top of the search results with a brief description of the country Canada together with a like to the Wikipedia page for Canada.
To create or edit a Kwiki Result, enter the query one would like to create or edit a display box for. Then use the Knowledge Wiki Page field to edit the entry and click save.
EOD;
$help_pages["en-US"]["Locale_List"] = <<< EOD
EOD;
$help_pages["en-US"]["Locale_Writing_Mode"] = <<< EOD
page_type=standard
page_border=solid-border
title=Locale Writing Mode
END_HEAD_VARSThe last field on the form is to specify how the language is
written. There are four options:
# lr-tb -- from left-to-write from the top of the page to the bottom as in
English.
# rl-tb from right-to-left from the top the page to the bottom as in Hebrew
and Arabic.
# tb-rl from the top of the page to the bottom from right-to-left as in
Classical Chinese.
# tb-lr from the top of the page to the bottom from left-to-right as in
non-cyrillic Mongolian or American Sign Language.
''lr-tb and rl-tb support work better than the vertical language support. As of
this writing, Internet Explorer and WebKit based browsers (Chrome/Safari) have
some vertical language support and the Yioop stylesheets for vertical languages
still need some tweaking. For information on the status in Firefox check out
this writing mode bug.''
EOD;
$help_pages["en-US"]["Machine_Information"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Machines''' section of the Manage Machines activity allows one to control and see the status of queue server, fetcher, and mirror processes associated with the current instance of Yioop. If one is running the media updater in distributed mode one can also see the status of this process for each machine. The '+' button next to Machines can be used to add a new machine. Each machine corresponds to the url of one location where an instance of Yioop is running that one wants to associate with the current name server. By default, the name server itself is only machine listed and it has one queue server and two fetcher statuses listed. Be aware tat in addition to adding the machine through this form, to properly associate a Yioop instance with a name server, you must also log in to the instance's web interface and configure its server settings to match the current name server.<br>
<br />
For each machine listed under Machines, there is a delete link to remove it from te list of managed machines, and then there are On/Off toggles for each process (such as queue server or fetcher) that it contains. These toggles are green if the process is currently running, yellow if the process was started but is not currently running correctly, and red, if the process is stopped. For each process, there is also a link to a log file which can be used to see recent activity (from most recent at top to less recent as one scrolls down) of that process.
<br />
{{right|[[https://www.seekquarry.com/?c=static&p=Documentation#GUI%20for%20Managing%20Machines%20and%20Servers| Learn More.]]}}
EOD;
$help_pages["en-US"]["Manage_Advertisements"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSThe '''Advertisement Name''', '''Text Description''', '''Destination URL''' fields can be used to create a text-based advertisement. What this ad will look like appears in the '''Preview''' area.
<br />
The '''Duration''' dropdown controls how many days the ad campaign will run for. The campaign starts on the date of purchase and this first day till midnight Pacific Time counts as one day of duration.
<br />
'''Keywords''' should consist of a comma separated list of words or phrases. Each word or phrase has a minimum bid for each day based on demand for that keyword. If no one so far has purchased an ad for any of the keywords, then this minimum is $1/day/word or phrase. Otherwise, it is calculated using the total of the bids so far.
<br />
The '''Calculate Bid''' button computes the minimum cost for the campaign you have chosen, add presents a form to receive your credit card information.
On this form the static field '''Minimum Bid Required''' field gives the minimum amount required to pay for the advertisement campaign in question. The '''Expensive word''' static field says for your campaign which term contributes the most to this minimum bid cost. The Budget fields allows you to enter an amount greater than or equal to the minimum bid that you are willing to pay your ad campaign. If there have been no other bids on your keywords then the minimum bid will show you ad 100% of the time any of your keywords are search for. If, however, there have been other bids, your bid amount as a fraction of the total bid amount for that day for the search keyword is used to select a frequency with which your ad is displayed, so it can make sense to bid more than the minimum required amount.
<br />
If you need to edit the keywords or other details of your ad before purchasing it, you can click the '''Edit Ad''' button; otherwise, clicking the '''Purchase''' button completes the purchase of your Ad campaign.
<br />
The '''Advertisement List''' beneath the form lists details for all of the ads you have created from most recent to least recent as well as impression and click information. You can edit the text of your ad (but not the keywords) by clicking an ad's edit column. You can also Deactivate a campaign to stop it from displaying. This does not refund your money.
EOD;
$help_pages["en-US"]["Manage_Credits"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARS'''Purchase Ad Credits''' form can be used to purchase ad credits which can then be spent under '''Manage Advertisements'''.
<br /><br />
The '''Quantity''' dropdown specifies the number of credits one wants to purchase at what price.
<br />
The '''Card Number''' field should be filled in with a valid credit card.
<br />
The '''CVC''' field you should put the three or four digit card verification number for your card.
<br />
The '''Expiration''' dropdown is used to set your cards expiration date.
<br />
The '''Purchase''' button is used to complete the purchase of Ad credit.
<br />
Beneath the Purchase form is the list of '''Ad Credit Transactions''' that have been made with your account.
EOD;
$help_pages["en-US"]["Manage_Machines"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS'''Add Machine''' allows you to add a new machine to be controlled by this Yioop instance.
<br />
The '''Machine Name''' field lets you give this machine an easy to remember name.
<br />
The '''Machine URL''' field should be filled in with the URL to the installed Yioop instance.
<br />
The '''Type/Channel''' controls, if set to a natural number, the channel that the queue servers and fetchers of this machine will use. The given machine will then only participate in crawls assigned to this channel number. If '''Type/Channel''' is set to '''Replica Server''', then a Parent Dropdown will appear where one can select the machine that the given machine will mirror. Mirroring is only supported for now for query results.
If a Mirror server is created and turned on, then query results needed from the parent server will alternately come from the Mirror server or its parent.
<br />
Finally, if '''Type/Channel''' is set to a natural number, the '''Number of Fetchers''' drop down allows you to say how many fetcher instances you want to be able to manage for that machine.
<br />
{{right|[[https://www.seekquarry.com/?c=static&p=Documentation#GUI%20for%20Managing%20Machines%20and%20Servers|Learn More..]]}}
EOD;
$help_pages["en-US"]["Max_Depth"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Max Depth''' dropdown is used to limit what urls are allowed to be crawl by the number of hops they are from a seed site. For example, if the Max Depth was set to 2, then seed sites would be crawled, sites linked to seed sites would be crawled, and sites linked to sites linked to seed sites would be crawled. A depth 0 crawl only crawls the seed sites.
EOD;
$help_pages["en-US"]["Media_Sources"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS'''Media Sources''' are used to specify how Yioop should handle news feeds, podcast, and trending value sites. The '''Add Media Source''' form lets you add new media sources. What this form looks like depends on the '''Type''' dropdown chosen. Below we describe the form for each of the possible choices of type:
<br />
An '''RSS media source''' can be used to add an RSS or Atom feed (it auto-detects which kind) to the list of feeds which are downloaded hourly when Yioop's Media Updater is turned on. Besides the name you need to specify the URL of the feed in question. The Category field search usually be left at news. If you want to specify additional categories such as weather or sports, you typically want to create a mix that searches the default index with the keyword media:your_category injects, and then make a new subsearch with that mix.
This will allow your new category to show up on the Tools/More/Other Searches page.
<br />
An '''HTML media source''' is a web page that has feed articles like an RSS page that you want the Media Updater to scrape on an hourly basis. To specify where in the HTML page the news items appear you specify different XPath information. For example,
<pre>
Name: Cape Breton Post
URL: http://www.capebretonpost.com/News/Local-1968
Language: English
Category: news
Channel: //div[contains(@class, "channel")]
Item: //article
Title: //a
Description: //div[contains(@class, "dek")]
Link: //a
</pre>
The Channel field is used to specify the tag that encloses all the news items. Relative to this as the root tag, //article says the path to an individual news item. Then relative to an individual news item, //a gets the title, etc. Link extracts the href attribute of that same //a .
<br />
A '''JSON media source''' is a used to scrape feed articles from JSON data as may be provided by a websites API. To handle a JSON media source you provide the same information as with an HTML media source. Internally, Yioop converts all JSON sources to xml before processing. The root objects maps to /html/body.
A property ''foo'' of the root object would get mapped to a tag <foo>. Array elements are mapped to a sequence of elements enclosed in <item> tags. The process is recursively applied until the JSON object is completely converted to an xml page. Once this is done the XPaths that a user provides are used to extract the feed items in the same way as how HTML feeds are extracted. As an example, Yioop search results and discussion groups can be output as JSON. To take Yioop's news feed and use it as a JSON media source in your search engine, you could use the settings:
<pre>
Name: Yioop News
URL: https://www.yioop.com/s/news?f=json
Language: English
Category: news
Channel: //channel
Item: //item
Title: //title
Description: //description
Link: //link
</pre>
<br />
A '''Regex media source''' is a source of feed articles presented in some kind of non-tag based text format.
For example, the US National Weather Service has a text-based page for weather forecasts of major US cities
at
<pre>
http://forecast.weather.gov/product.php?site=NWS&
issuedby=04&product=SCS&format=txt&
version=1&glossary=0
</pre>
changing the 04 above to 03, 02, 01 varies the group of cities. Most of the data on this page appears in a pre tag as text. ''Channel'' in this case would be a regex whose first capture group corresponds to the contents of this pre tag. We might want to get one item per line from the pre tag as that would correspond to the weather for one city. The ''Item Separator'' is a regex used to split the results of the Channel operation into items. Finally, ''Title'', ''Description'', and ''Link'' are regexes each with one capture group used to get these respective feed item components out of an item given after the splitting process above. Hence, a reasonable choice of values for the weather service page might be:
<pre>
Name: National Weather Service 04
URL: http://forecast.weather.gov/product.php?
site=NWS&issuedby=04&product=SCS&format=txt&
version=1&glossary=0
Language: English
Category: weather
Channel: /<pre(?:.+?)>([^<]+)/m
Item: /
/
Title: /^(.+?)\s\s\s+/
Description: /\s\s\s+(.+?)$/
Link: http://www.weather.gov/
</pre>
Notice in the above that the Link element is http://www.weather.gov/. If you have a feed
and it doesn't provide links for individual items. You can always provide a link to some
fixed site by directly entering a URL in the Link field.
<br />
Not all feeds use the same tag to specify the image associated with a news item. The Image XPath allows you to specify relative to a news item (either RSS or HTML) where an image thumbnail exists. If a site does not use such thumbnail one can prefix the path with ^ to give the path relative to the root of the whole file to where a thumb nail for the news source exists. Yioop automatically removes escaping from RSS containing escaped HTML when computing this. For example, the following works for the feed:
<pre>
https://feeds.wired.com/wired/index
//description/div[contains(@class, "rss_thumbnail")]/img/@src
</pre>
<br />
A '''Feed Podcast source''' is an RSS or Atom source where each item contains a link to a podcast or video podcast. For example,
http://feed.cnet.com/feed/podcast/all/hd.xml
The '''Alternative Link Tag''' field is used to say the XPath within the feed item to the link for the audio or video file. For the CNet example, this is:
enclosure
If it is blank the default link tag is used. The media updater job when run checks if any items in the feed are new. If so, it downloads them to the wiki resource folder of the wiki page provided in the '''Wiki Destination''' field. This page is given in the format GroupName@PageName. If you give just PageName, the Public group is assumed. The '''Expires''' field controls how long a feed item is kept before it is deleted.
For example, if we wanted to download the popular Ted talk podcasts into the Ted subfolder of the resource folder of the Example Podcast wiki page of the Public group, where we have podcasts expire after after 1 month, we could do:
<pre>
Name: Ted
URL: https://pa.tedcdn.com/feeds/talks.rss
Language: English
Expires: One Month
Alternative Link Tag: enclosure
Wiki Destination: Library@News and Podcasts/Ted/%Y-%m-%d %F
</pre>
Notice the string has "%Y-%m-%d %F" in it. This portion of the destination gives the format of the filename to use when storing a downloaded podcast file. It says name the file as the current year hyphen month hyphen day space the filename as given in the URL. %F is for the filename, other % modifiers can be standard date formatting instructions.
<br />
Yioop supports the downloading of single video or audio file sources, as well as more complicated stream sources such as m3u8 streams.
<br />
A '''Scrape podcast source''' is like a '''Feed Podcast source''', but where one has a HTML or XML page which has a periodically updated link to a video or audio source. For example, it might be an evening news web site.
The '''URL''' field should be the page with the periodically updated link. The '''Aux Url XPaths''' field, if not blank, should be a sequence of XPaths or Regexes one per line. The first line will be applied to the page to obtain a next url to download. The next line's XPath or Regex is applied to this file and so on. The final url generated should be to the HTML or XML page that contains the media source for that day. Finally, on the page for the given day, '''Download XPath''' should be the XPath of the url of the video or audio file to download.
If a regex is used rather than an XPath, then the first capture group of the regex should give the url. A regex can be followed by json| to indicate the first capture group should be converted to a json object. To reference a path of through sub-objects of this object to a url. As an example, consider the following, which at some point, could download the Daily News Scrape Podcast to a wiki group:
Type: Scrape Podcast
Name: Daily News Podcast
URL: https://www.somenetwork.com/daily-news
Language: English
Aux Url XPaths:
/(https\:\/\/cdn.somenetwork.com\/daily-news\/video\/daily-[^\"]+)\"/
/window\.\_\_data\s*\=\s*([^\]+\}\;)/json|video|current|0|publicUrl
Download XPath: //video[contains(@height,'540')]
Wiki Destination: My Private Group@Podcasts/%Y-%m-%d.mp4
The initial page to be download will be: https://www.somenetwork.com/daily-news. On this page, we will use the first Aux Path to find a string in the page that matches /(https\:\/\/www.somenetwork.com\/daily-news\/video\/daily-[^\"]+)\"/. The contents matching between the parentheses is the first capture group and will be the next url to download. SO for example, one might get a url:
https://cdn.somenetwork.com/daily-news/video/daily-safghdsjfg
This url is then downloaded and a string matching the pattern /window\.\_\_data\s*\=\s*([^
]+\}\;)/ is found. The capture group portion of this string consists of what matches ([^
]+\}\;) is then converted to a JSON object, because of the json| in the Aux Url XPath. From this JSON object, we look at the video field, then the current subfields, its 0 subfield, and finally, the publicUrl field. This is the url we download next. Lastly, the download XPath is then used to actually get the final video link from this downloaded page.
Once this video is downloaded, it is stored in the Podcasts page's resource folder of the the My Private Group wiki group in a file with a name in the format: %Y-%m-%d.mp4.
A '''Trending value source''' is a value on a web page that one would like to track using Yioop's trending search mechanism. The Name field is the name to use for the trending value. The URL field should be the page with the periodically updated value. '''Category''' should be the trends category (a collection of trending values) one would like to track this value with. '''Group Within Category''' is the default name of the key that will be associated with the value found on this page. '''Trend Value Regex''' is a regular expression to match against the downloaded URL. If it matches and the expression has one capture group, then tat capture group will be used as the value for a particular download time. If it has two or more capture groups, the first two capture groups are used to give a key name, value pair for a particular download time. As an example,
Name: Yioop Ticker
URL: https://my-great-stock-quotes/yioop
Language: English
Category: stocks
Group Within Category: Yioop Price
Trend Value Regex: /Yioop\:\s+(\d+\.\d+)/
Here there is only one capture group (\d+\.\d+), so searching on trending:stocks, one would see all the hour, weekly, etc values for the trending values with that category. One such row would be Yioop Price whose values would be computed based on the numbers extracted according to this regex's (\d+\.\d+) capture group.
EOD;
$help_pages["en-US"]["Media_Updater"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Media Updater''' section of the Manage Machines activity let's one control the media updater and see, when the updater is not being run in distributed mode, the status of this updater on the name server. The Media Updater is responsible for handling periodic jobs carried out by Yioop. Examples of periodic jobs include updating its RSS (or Atom) search sources on an hourly basis, downloading podcasts to wiki pages, computing query and view analytics, convert videos that have been uploaded into mp4 and webm if ffmpeg is installed, and sending out notification emails. <br><br>
The '''Configure Media Job''' link takes one to a page were one can control which media jobs are currently running. Beneath there is On/Off toggle for the media updater together with a color indicator (green on/red off) for whether the Media Updater is currently running. Finally, there is a '''Log''' file link whic can be used to see the log entries (most recent at top) of Media Updater process.
EOD;
$help_pages["en-US"]["Monetization"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Monetization''' field-set controls what kind of monetization features are used by Yioop. The default is that no monetization features are enabled.
* '''External Ad Server''' allows one to add a script for an external ad server to search result pages. Selecting this option lets you choose the placement of the external ad server's results and to cut and paste the necessary Javascript code.
* '''Group Fees''' enables the Manage Credits activity for all users. This allows users to purchase credits. By default credits are free, however, if the payment script is bought from seekquarry.com and installed then credits can be purchased via a credit card for a dollar value. Besides enabling the Manage Credits activity, '''Group Fees''' also allows owner's of groups on your site to charge a fee in credits to join a group.
* '''Keyword Advertising''' enables the Manage Credits activity mentioned above and also enables a Manage Advertisements activity. This latter activity allows user's to purchase keyword advertisements for search results.
* '''Group Fees and Keyword Ads''' enables both charging credits for joining groups and allows user's to purchase keyword advertisements.
EOD;
$help_pages["en-US"]["Name_Server_Setup"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSYioop can be run in a single machine or multi-machine setting. In a multi-machine setting, copies of Yioop software would be on different machines. One machine called the '''Name Server''' would be responsible for coordinating who crawls what between these machines. This fieldset allows the user to specify the url of the Name Server as well as a string (which should be the same amongst all machines using that name server) that will be used to verify that this machine is allowed to talk to the Name Server. In a single machine setting these settings can be left at their default values.
<br />
When someone enters a query into a Yioop set-up, they typically enter the query on the name server. The '''Use Filecache''' checkbox controls whether the query results are cached in a file so that they don't have to be recalculated when someone enters the same query again. The file cache is purged periodically so that it doesn't get too large. Sometimes it is useful, however, to know the file cache has just been cleared. The '''Clear Cache''' link clears both the file cache as well as the local domain name to IP address cache.
EOD;
$help_pages["en-US"]["Page_Byte_Ranges"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARS'''Byte Range to Download''' determines the maximum number of bytes that Yioop will download for a given page when crawling. Setting a maximum is important so that Yioop does not get stuck downloading very large files.
<br />
When Yioop shows the cached version of a URL it shows only what it downloaded.
EOD;
$help_pages["en-US"]["Page_Classifiers"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSClassifiers are used to say whether a page has or does not have a property. The '''Manage Classifiers''' activity let's you create and manage the classifiers for this Yioop system. Creating a classifier will take you to a page that let's you train the classifier against existing data such as a crawl indexed. Once you have a classifier you can use it to add meta words for that concept to pages in future crawls by selecting in on the Page Options activity. You can also use classifiers to score documents for ranking purposes in search results, again this can be done under the Page Options Activity.
EOD;
$help_pages["en-US"]["Page_Grouping_Options"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Search Results Grouping''' controls allow you to control on a search query how many qualifying documents from an index to compute before trying to sort and rank them to find the top k results (here k is usually 10). In a multi-queue-server setting the query is simultaneously asked by the name server machine of each of the queue server machines and the results are aggregated.
<br />
'''Minimum Results to Group''' controls the number of results the name server wants to have before sorting and grouping of results is done.
EOD;
$help_pages["en-US"]["Page_Ranking_Factors"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSIn computing the relevance of a word/term to a page the fields on this form allow one to set the relative weight given to the word depending on whether it appears in the title, a link, or if it appears anywhere
else (description).
EOD;
$help_pages["en-US"]["Page_Rules"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARS'''Page Field Extraction Rules ''' are statements from a Yioop-specific indexing language which can be applied to the words in a summary page before it is stored in an index. Details on this language can be found in the [[http://www.seekquarry.com/?c=static&p=Documentation#Page%20Indexing%20and%20Search%20Options|Page Indexing and Search Options]] section of the Yioop Documentation.
<br />
The textarea below this heading can be used to list out which extraction rules should be used for the current crawl.
EOD;
$help_pages["en-US"]["Privacy"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe privacy fieldset controls a variety of options with respect to how analytics from individual users is collected by a Yioop instance.
* '''Differential Privacy''' controls whether group and thread view statistics which are displayed under the Manage Groups and Feeds and Wikis activities are fuzzified to try to prevent individual users from being identifiable by change in counts.
* '''Group Analytics''' controls whether information about group and thread views is collected and whether statistics about these views are visible to group owners. If this is disabled, it does not delete statistics that were previously collected, however, they will no longer be viewable and no future views will be recorded.
* '''Search Analytics''' controls whether information about search queries is collected and aggregated. If this is disabled, it does not delete statistics that were previously collected, however, they will no longer be viewable and no future collection will occur. Also, if this is disabled, but keyword advertisements are enabled, then impressions with respect to advertised keywords will still be collected.
EOD;
$help_pages["en-US"]["Proxy_Server"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=Proxy+server
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSYioop can make use of a proxy server to do web crawling. This fieldset is used to configure the proxies to be used.<br>
<br>
The '''Tor Proxy''' field is used to specify the onion router proxy used to crawl TOR web pages (Dark Web). The default is <code>127.0.0.1:9150</code>. This corresponds to the proxy on your machine which would be active by default if you have the Tor Browser running. If you instead install a tor relay service (on a MacOS you could do <code>brew install tor</code>), then start this service in the default way, the proxy would be <code>127.0.0.1:9050</code>. If you do not intend to crawl tor pages you can safely ignore this field.
<br><br>
Except for onion urls, Yioop does not make use of the Tor Proxy for crawling. You can configure Yioop to make use of a proxy for crawling general web pages by checking the '''Crawl via Proxies''' checkbox. This reveals a textarea were you can enter one proxy/line. The format for a line is either:
* <code>address:port</code>
* <code>address:port:type</code>
* or <code>address:port:type:username:password</code>
<br><br>
As an example, one might have a line like:<br>
<code>
45.192.173.164:1080:socks5_hostname
</code>
<br>
Other possibilities for the proxy type are: <code>http</code> (default), socks4, socks4a, socks5, or the cURL flag number for the desired protocol. For example, the number 5 corresponds to socks5, 7 to socks5_hostname.
EOD;
$help_pages["en-US"]["Query_Result_Mappings"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSA '''Query Map''' associates a particular query with a list of urls. These urls will be the
first urls shown when a user searches on the given query.<br><br>
Entering a query and clicking '''Load''' will reveal a textarea containing the current list of
urls associated with the query (if any). One can then edit/modify this area to list the desired
urls, one url/line. Clicking '''Save''' will then record the changes.
EOD;
$help_pages["en-US"]["Recovery_Type"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
END_HEAD_VARSThe Recovery Type field set controls whether and how user account recovery can be handled in an automated fashion. The available choices are:
* '''No User Password Recovery Link''', no "Forgot Password?" link is provided and a user cannot recover
their password on their own;
* '''Email Link Password Recovery''', a user can specify their login and get emailed a password change link;
* '''Email Link and Check Questions Recovery''', a user can specify their login and get emailed a password change link. The password change page requires the user correctly answers previously provided recovery questions.
EOD;
$help_pages["en-US"]["Repeat_Type"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Repeat Type''' dropdown controls whether a crawl is a repeating crawl or not, and if so, what is its repeat duration. A non-repeating crawl has one index and crawling continues adding to this index until all allowed urls have been crawled or until the administrator stops the crawl. In a non-repeating crawl one has a double index, that consists of a index to serve search results from and an index to crawl into. Once the repeat time has been exceeded the index that was being crawled into becomes the index to serve results from, the previous search index is reset to empty and is then used to crawl into for the next repeat time amount of time. The '''Two Minute''' repeat type can be used to experiment with this behavior.
EOD;
$help_pages["en-US"]["Robots_Behaviors"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Robots Behaviors''' dropdown controls the degree to which your Yioop crawler respects '''robots.txt''' files. A '''robots.txt''' is a file placed by a site operator in the document root of their web site. I.e., it would typically have a url like:
https://some_host_name/robots.txt<br>
or<br>
http://some_host_name/robots.txt.
It is used to specify the files that a particular kind of crawler is allowed to download from a site and at what rate. So for example it might have instructions for how the GoogleBot is allowed to crawl the site, how the BingBot is allowed to crawl the site, etc. The available options are:
* '''Always Follow''' which always follows to the best of Yioop's abilities the robots.txt instructions.
* '''Allow Landing Page Crawl''' which allows Yioop to download urls of the form
https://some_host_name/<br>
or<br>
http://some_host_name/ but otherwise respects the robots.txt file.
* '''Ignore''' which allows Yioop to completely ignore the robots.txt file. This option should only be used at your own risk. There might be some use cases such as where you want to crawl part of a site that you yourself own, but where you don't have control of the robots.txt. For the most part, you should not use this option.
EOD;
$help_pages["en-US"]["Scrapers"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS'''Web Scrapers''' are used to help Yioop get to the most important content on a web page during. When Yioop crawls it tries to extract the most important content of a page into a succinct summary. It then indexes just this summary. Web pages generated by a content management system such as Wordpress have a reasonably standard format and a web scraper can be used to isolated the sub-portion of a web page which is more likely to have useful content. Below we describe how to use Web Scraper activity to make a new scraper or view existing one.
'''Name''' is what to call the scraper that is being defined. A Web Scraper must have a Name, the Signature and Scrape Rules fields are optional but at least one of them must be present for the web scraper to have effect while crawling.
'''Signature''' is used to detect when a particular Web Scraper should be used. It should consist of an XPath query which would evaluate to a non-empty set of elements in the case of a page the scraper might work for.
'''Priority''' is used to determine which scraper to apply to a web page when a page matches multiple scraper signatures. Yioop chooses the highest (larger) priority scraper that matches. If two scrapers have the same priority it would choose the first one it found matching. The priority dropdown allows one to set the priority of a scraper.
'''Text XPath''' is used to specify an xpath to the most important content of a page for summarization.
'''Delete XPaths'''is used to specify xpaths, one per line, of content under the Text Xpath portion of the web page, that should be non considered for summarizations.
'''Extract Fields''' is used to specify a sequence of rules to extract to specific fields in the summary. Each rule should be on a line by itself and have the format: NAME_OF_SUMMARY_FIELD = SOME_XPATH. The meaning of such a rule compute the xpath on the original document and concatenate the text contents of the resulting nodes into NAME_OF_SUMMARY_FIELD in the summary. For example,
SITE_NAME=//meta[@property='og:site_name']/@content
would take the value of the content attribute of all meta tags with property attribute having value og:site_name, concatenate them as a string, and store the key SITE_NAME with value this string in the pages summary when it is indexed.
EOD;
$help_pages["en-US"]["Search_Access"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Search Access''' fieldset has checkboxes that control which interfaces can be used to get search query results from Yioop.
* The '''Web''' checkbox controls whether or not a traditional web search through the Yioop instance's landing page can be done.
* The '''RSS''' checkbox controls whether or not search queries in RSS format are available. If so, then a query string of the form<br>
<code>
?q=some_search_query&f=rss
</code><br>
will output search results in rss format, a query string in RSS format will be output. This checkbox needs to be checked if you are using Yioop in a situation with multiple queue servers. This switch also enables queries of the form<br>
<code>
?q=some_search_query&f=json, ?q=some_search_query&f=json&callback=some_function,
</code><br>
and<br>
<code>
?q=some_search_query&f=serial.
</code><br>
The above queries demonstrate respectively JSON format output, JSONP format output, and serialized PHP object format output.
* The '''API''' checkbox controls whether or not Yioop can be used as PHP library using the Yioop Search Function API to return search results. This is described in the [[https://www.seekquarry.com/p/Documentation#Embedding%20Yioop%20in%20an%20Existing%20Site|Embedding Yioop]] section of the Yioop Documentation.
EOD;
$help_pages["en-US"]["Search_Results_Editor"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSThe '''Edit Result Page''' form can be used to change the title and snippet text associated with a given url if it appears in search results. The Edited Urls dropdown let's one see which URLs have been previously edited and allows one to load and re-edit these if desired. Edited words in the title and description of an edited URL are not indexed. Only the words from the page as originally appearing in the index are used for this. This form only controls the title and snippet text of the URL when it appears in a search engine result page.
EOD;
$help_pages["en-US"]["Search_Results_Page_Elements"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThese checkboxes control whether various links and drop downs on the search result and landing
pages appear or not.
; '''Word Suggest''': Controls whether the suggested query drop down appear as a query is entered in the search bar.
; '''Subsearch''' : Controls whether the links to subsearches such as Image, Video, and News search appear at the top of all search pages
; '''Signin''' : Controls whether the '''Sign In''' link appears at the top of the Yioop landing and search result pages.
; '''Cache''', '''Similar''', '''Inlinks''', '''IP Address''': Control whether the corresponding links appear after each search result item.
EOD;
$help_pages["en-US"]["Seed_Sites_and_URL_Suggestions"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS'''Seed Sites''' are a list of urls that Yioop should start a crawl from.
<br />
If under Server Settings : Account Registration user's are allowed to register for Yioop accounts at some
level other than completely disabled, then the Tools: Suggest a Url form will be enabled. URLs suggested through this form can be added to the seed sites by clicking the '''Add User Suggest data''' link. These URLS will appear at the end of the seeds sites and will appear with a timestamp of when they added before them. Adding this data to the seed sites clears the list of suggested sites from where it is temporarily stored before being added.
<br />
Some site's robot.txt forbid crawl of the site. If you have your crawler configured to always follow the robots.txt file, but would like to create a placeholder page for such a forbidden site so that a link to that site might still appear in the index, yet so that the site itself is not crawled by the crawler, you can use a syntax like:
<nowiki>
http://www.facebook.com/###!
Facebook###!
A%20famous%20social%20media%20site
</nowiki>
This should all be on one line. Here ###! is used a separator and the format is url##!title###!description.
EOD;
$help_pages["en-US"]["Server_Channel"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSEach machine in a cluster of Yioop instances with the same Name Server has a channel, defaulting to 0. The '''Server Channel''' drop down is populated with a list of channels of currently configured machines in the cluster. If there are no configured machines and empty message is displayed. The Server Channel of a crawl is used to specify which machines in the cluster will participate in the crawl -- only machine with the same channel as that of the crawl will participate. Using this mechanism it is possible to set up several ongoing simultaneous crawls provided they are on different channels.
EOD;
$help_pages["en-US"]["Session_Parameters"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThese parameters control properties of the sessions of authenticated (logged-in) users.
* '''Time Zone''' controls the time zone with respect to which times for this instance of Yioop are calculated. This will affect the display of dates and times throughout the Yioop instance.
* '''Token Name''' controls the name of the cross-site request forgery prevention token that appears in urls on this site when a user is logged-in.
* '''Session Name''' is the name of the HTTP cookie used to identify the current session.
* '''Autologout''' is how long an inactive session is maintained before a user is automatically logged out.
It does not remove the user's cookie from their browser, it just logs them out of the current session.
* '''Cookie Consent Expires''' controls how long from when a user clicks their consent to allow cookies, until the next time a request for consent is required. Cookie consent is often one piece of complying with privacy legislation such as the California Consumer Privacy Act (CCPA) which requires allowing user's to opt out the of selling their information and the European Union's General Data Protection Regulation (GDPR), which requires user's to give their consent to the use of cookies. The Yioop system does not set cookies unless consent has been granted, but if you are using Yioop together with an external ad server, it migt be possible for the latter to set cookies. Also, Yioop support's MathJax (for math formatting on Wiki pages) via a CDN by default which might set a cookie. You can always install MathJax on your site and use this directly to avoid this potentiality.
EOD;
$help_pages["en-US"]["Start_Crawl"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSEnter a name for your crawl and click start to begin a new crawl. Previously completed crawls appear in the table below.
<br />
Before you start your crawl be sure to start the queue servers and fetchers to be used for the crawl under '''Manage Machines'''.
<br />
The '''Options''' link let's you specify what web sites you want to crawl or if you want to do an archive previous crawls or different kinds of data sets.
EOD;
$help_pages["en-US"]["Subsearches"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS'''Subsearches''' are specialized searches hosted on a Yioop site other than the default index. For example, a site might have a usual web search and also offer News and Images subsearches. A list of links to all the current subsearches on a Yioop site appear under the hamburger menu on the search landing page provided the Pages Options : Search Time : Subsearch checkbox is checked. The '''Add a Subsearch''' form let's you set up such a subsearch. The components of this form are as follows:
<br>
The '''Folder Name''' of a subsearch is the name that appears as part of the query string when doing a search restricted to that subsearch. After creating a subsearch, the table below the form will have a '''Localize''' link next to its name. This lets you give names for your subsearch with respect to different languages.
<br>
The '''Source''' dropdown on the form let's you choose one of the previously crawled indexes, defined crawl mixes, or defined trend categories to use for the subsearch. If '''Trendf Category''' is chosen the appearance of the form is slightly different. We first cover the remainder of the form for the selection of a crawl index or a mix asa a type.
<br>
The '''Results Per Page''' dropdown on the form controls the number of search results that are displayed per page for the search results for the subsearch. For standard search this is usually 10, but for other kinds of searches such as images or news it is often convenient to have a larger number.
<br>
The '''Landing Priority''' priority dropdown controls whether top five link highlight of the default subsearch search is displayed on the landing page under the search bar, and if so, its placement. If ''No Highlight'' is selected then no highlight is shown; otherwise, subsearches with highlights are presented in descending order of their priority. In the case the subsearch is a Trending Category subsearch, than rather then select the top five link as the highlight, a selection of nine or so randomly chosen trending terms for thhat category are used.
The '''Default Query''' field controls the query that should be run by default if the user hasn't entered a query. For example, for a news feed one might have <code>lang:default-major</code>. This says if the user doesn't enter a query search <code>lang:default-major</code> to get the most recent news in the default language.
When '''Trend Category ''' is selected as the search source, the Add Subsearch form has two additional dropdowns: '''Category''' and '''Sort'''. The former allows the user to select from the available trend categories a trend category for this subsearch, Sort lets the user specify whether the trends should be sorted according to the names of the terms for that trend or the scores for terms, and if so, whether the sort should be ascending to descending.
EOD;
$help_pages["en-US"]["Suffix_Phrases"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThis checkbox controls whether suffix phrases are extracted from document summaries at crawl time and whether suffix phrases are used at search time. Using suffix phrases allows for faster, by building a complete suffix tree of the corpus, but often less relevant, search results for multi-term queries in the spin hard drive setting for a very large index (> 100 million pages). The resulting index will be substantially larger.
EOD;
$help_pages["en-US"]["Summary_Length"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSThis determines the maximum number of bytes that can appear in a summary generated for a document that Yioop has crawled. To have any effect this value should be smaller that the byte range downloaded. yo
EOD;
$help_pages["en-US"]["Test_Indexing_a_Page"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Test Page''' form is used to test how Yioop would process a given web page. To test a web page one
first selects the '''Method of Submission'''. This can either be by giving the URI of the webpage you would like to test, or by choosing a file to upload and test or by direct input. For direct input one
copies and pastes the source of the web page (obtainable by doing View Source in a browser) into the textarea. Then one selects the mimetype of the page (usually, text/html) and submits the form to see the processing results.
EOD;
$help_pages["en-US"]["Using_a_Classifier_or_Ranker"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
page_header=
page_footer=
END_HEAD_VARSA <b>binary classifier</b> is used to say whether or not a page has a property (for example, being a spam page or not). Classifiers can be created using the Manage Classifiers activity.
<br/>
The classifiers that have been created in this Yioop instance are listed in the table below and can be used for future crawls. Given a classifier named foo, selecting the '''Use to Classify''' check box for it tells Yioop to insert some subset of the following labels as meta-words when it indexes a page:
<pre>
class:foo
class:foo:10plus
class:foo:20plus
class:foo:30plus
class:foo:40plus
...
class:foo:50
...
</pre>
When a document is scored against a classifier foo, it gets a score between 0 and 1 and if the score is greater than 0.5 the meta-word class:foo is added. A meta-word class:foo:XXplus indicates the document achieved at least a score of XX with respect to the classifier, and a meta-word class:foo:XX indicates it had a score between 0.XX and 0.XX + 0.9.
<br />
The '''Use to Rank''' checkbox indicates that Yioop should take the score between 0 and 1 and use this as one of the scores when ranking search results.
EOD;
$help_pages["en-US"]["Work_Directory"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSThe '''Work Directory''' is a folder used to store all the customizations of this instance of Yioop. This field should be a complete file system path to a folder that exists. It should use forward slashes. For example:
<br>
/some_folder/some_subfolder/yioop_data
(more appropriate for Mac or Linux) or
c:/some_folder/some_subfolder/yioop_data
(more appropriate on a Windows system).
<br>
If you decide to upgrade Yioop at some later date you only have to replace the code folder
of Yioop and set the Work Directory path to the value of your pre-upgrade version.
EOD;
$help_pages["fr-FR"]["Account_Registration"] = <<< EOD
page_type=page_alias
page_alias=Enregistrement+de+compte
page_border=solid-border
toc=true
title=Account+Registration
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARS
EOD;
$help_pages["fr-FR"]["Enregistrement_de_compte"] = <<< EOD
page_type=standard
page_alias=
page_border=solid-border
toc=true
title=Enregistrement+de+compte
author=
robots=
description=
alternative_path=
page_header=
page_footer=
sort=aname
END_HEAD_VARSLe jeu de champ d'enregistrement de compte est utilisé pour contrôler la façon dont l'utilisateur peut obtenir des comptes sur une installation Yioop.
Le déroulant au début de ce jeu de champ vous permet de sélectionner l'un des quatre
possibilités:
''Enregistrement désactiver'': les utilisateurs ne peuvent pas s'enregistrer eux-mêmes, seule la racine
compte peut ajouter des utilisateurs. Lorsque l'enregistrement de désactiver est sélectionné, le formulaire ''Suggest A Url'' et le lien sur la page tool.php est également désactivée, pour tous les autres types d'enregistrement lien est activé.
''Pas d'activation'': les comptes utilisateur sont immédiatement activés une fois qu'un utilisateur
s'inscrit.
''Activation des courriels'': après inscription, les utilisateurs doivent cliquer sur un lien qui
vient dans un e-mail séparé pour activer leurs comptes. Si l'activation par e-mail est choisie, la réinitialise de cet ensemble de champs peut être utilisée pour spécifier l'adresse e-mail que l'e-mail vient à l'utilisateur. La fonction PHP mail() contrôle l'utilisation ou non de la fonction de courrier dans PHP pour envoyer le courrier, cela ne fonctionne que si le courrier peut être envoyé à partir de la machine locale.
Alternativement, si ce n'est pas vérifié comme dans l'image ci-dessus, on peut
configurer un serveur SMTP sortant pour envoyer l'e-mail.
''Activation de l'administration'': après inscription, un compte d'administrateur doit s'activer
l'utilisateur avant que l'utilisateur ne soit autorisé à utiliser son compte.
EOD;