viewgit/inc/functions.php:22 Function utf8_encode() is deprecated [8192]
| Filename | |
|---|---|
| src/configs/PublicHelpPages.php | |
| src/controllers/components/CrawlComponent.php | |
| src/data/default.db | |
| src/models/CrawlModel.php |
diff --git a/src/configs/PublicHelpPages.php b/src/configs/PublicHelpPages.php index 815ae44bd..fecf48311 100644 --- a/src/configs/PublicHelpPages.php +++ b/src/configs/PublicHelpPages.php @@ -77,620 +77,620 @@ 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 +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' @@ -896,7 +896,7 @@ page_footer= sort=aname -END_HEAD_VARSThe Ad Server field-set is used to control whether, where, +END_HEAD_VARSThe Ad Server field-set is used to control whether, where, and what external advertisements should be displayed by this Yioop instance. EOD; $help_pages["en-US"]["Add_Locale"] = <<< EOD @@ -1083,13 +1083,13 @@ 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 declare themselves a chat bot and give a callback url. -<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 callback url. The response from the url will then be used in a response to the comment (if any). +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 declare themselves a chat bot and give a callback url. +<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 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_User"] = <<< EOD @@ -1311,37 +1311,41 @@ page_footer= sort=aname -END_HEAD_VARS''This form appears when the Group Name is available to create a new Group. '' ----- - -'''Name''' Field is used to specify the name of the new Group. -<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. - - -'''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. - - -'''Voting''' -* Specify the kind of voting allowed in the new group. + Voting allows users to -vote up, -- Voting allows users to vote down. +/- allows Voting up and down. +END_HEAD_VARS''This form appears when the Group Name is available to create a new Group. '' +---- + +'''Name''' Field is used to specify the name of the new Group. +<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. + + +'''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. + + +'''Voting''' +* Specify the kind of voting allowed in the new group. + Voting allows users to +vote up, -- Voting allows users to vote down. +/- allows Voting up and down. '''Post Life time''' - Specifies How long the posts should be kept. + +'''Encryption''' +* Whether the posts in this group should be encrypted on the server. Drawback is +in future group will not be as searchable as a non-encrypted group. EOD; $help_pages["en-US"]["Database_Setup"] = <<< EOD page_type=standard @@ -2154,10 +2158,10 @@ 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 identified by change in counts. -*'''Group Analytics''' controls whether information about group and thread views is collected and aggregated. +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 identified by change in counts. +*'''Group Analytics''' controls whether information about group and thread views is collected and aggregated. *'''Search Analytics''' controls whether information about search queries is collected and aggregated. EOD; $help_pages["en-US"]["Proxy_Server"] = <<< EOD @@ -2533,4 +2537,3 @@ If you decide to upgrade Yioop at some later date you only have to replace the c of Yioop and set the Work Directory path to the value of your pre-upgrade version. For this reason the Work Directory should not be a subfolder of the Yioop code folder. EOD; - diff --git a/src/controllers/components/CrawlComponent.php b/src/controllers/components/CrawlComponent.php index e0c19db5d..4f26da9a2 100644 --- a/src/controllers/components/CrawlComponent.php +++ b/src/controllers/components/CrawlComponent.php @@ -180,7 +180,7 @@ class CrawlComponent extends Component implements CrawlConstants $crawl_params = []; $crawl_params[self::STATUS] = "RESUME_CRAWL"; $crawl_params[self::CRAWL_TIME] = - substr($parent->clean($_REQUEST['timestamp'], "int"),0, + substr($parent->clean($_REQUEST['timestamp'], "int"), 0, C\TIMESTAMP_LEN); $seed_info = $crawl_model->getCrawlSeedInfo( $crawl_params[self::CRAWL_TIME], $machine_urls); diff --git a/src/data/default.db b/src/data/default.db index 4aa3a401e..654fdc0ab 100644 Binary files a/src/data/default.db and b/src/data/default.db differ diff --git a/src/models/CrawlModel.php b/src/models/CrawlModel.php index 4a40a2ee1..4bc2c0083 100755 --- a/src/models/CrawlModel.php +++ b/src/models/CrawlModel.php @@ -951,13 +951,13 @@ EOT; $scheduler_info[self::TO_CRAWL][] = [$site_parts[0], 1.0]; } } - $scheduler_string = "\n".L\webencode( + $scheduler_string = "\n" . L\webencode( gzcompress(serialize($scheduler_info))); file_put_contents( - C\CRAWL_DIR."/schedules/".self::schedule_start_name, + C\CRAWL_DIR."/schedules/" . self::schedule_start_name, $scheduler_string); - return true; } + return true; } /** * Used to start QueueServers and Fetchers on current machine when