PageRenderTime 86ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/tipue_search/README.md

https://gitlab.com/unofficial-mirrors/pelican-plugins
Markdown | 99 lines | 64 code | 35 blank | 0 comment | 0 complexity | 975042c568fe4191c165da3277cca52f MD5 | raw file
    

  1. Tipue Search
    2. 

  2. ============
    3. 

  3. 

  4. > :warning: **Instead of this plugin, please use the [Pelican Search](https://github.com/pelican-plugins/search) plugin.**
    5. 

  5. 

  6. > :warning: **This plugin, and the jQuery code upon which it depends, _is abandoned and no longer maintained_.**
    7. 

  7. 

  8. 

  9. Purpose
    10. 

  10. -------
    11. 

  11. 

  12. Serialize generated HTML content to a JS variable for use by the Tipue static search jQuery plugin.
    13. 

  13. 

  14. 

  15. Installation
    16. 

  16. ------------
    17. 

  17. 

  18. This plugin can be installed via:
    19. 

  19. 

  20.     python -m pip install -e "git+https://github.com/getpelican/pelican-plugins/#egg=pelican-tipue-search&subdirectory=tipue_search"
    21. 

  21. 

  22. 

  23. Why Do You Need It?
    24. 

  24. -------------------
    25. 

  25. 

  26. Static sites do not offer search feature out of the box. [Tipue Search](https://web.archive.org/web/20200703134724/https://tipue.com/search/)
    27. 

  27. is a jQuery plugin that search the static site without using any third party service, like DuckDuckGo or Google.
    28. 

  28. 

  29. Tipue search requires the textual content of site in a JS variable.
    30. 

  30. 

  31. 

  32. How Tipue Search Works
    33. 

  33. ----------------------
    34. 

  34. 

  35. Tipue Search serializes the generated HTML into JSON and saves it into a JS variable. Format of JSON is as follows
    36. 

  36. 

  37. ```javascript
    38. 

  38. var tipuesearch = {
    39. 

  39.     "pages": [
    40. 

  40.         {
    41. 

  41.             "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer nec odio. Praesent libero. Sed cursus ante dapibus diam. Sed nisi. Nulla quis sem at nibh elementum imperdiet. Duis sagittis ipsum. Praesent mauris. Fusce nec tellus sed augue semper porta. Mauris massa. Vestibulum lacinia arcu eget nulla. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Curabitur sodales ligula in libero.",
    42. 

  42.             "tags": "Example Category",
    43. 

  43.             "url" : "http://oncrashreboot.com/plugin-example.html",
    44. 

  44.             "title": "Everything you want to know about Lorem Ipsum"
    45. 

  45.         },
    46. 

  46.         {
    47. 

  47.             "text": "Sed dignissim lacinia nunc. Curabitur tortor. Pellentesque nibh. Aenean quam. In scelerisque sem at dolor. Maecenas mattis. Sed convallis tristique sem. Proin ut ligula vel nunc egestas porttitor. Morbi lectus risus, iaculis vel, suscipit quis, luctus non, massa. Fusce ac turpis quis ligula lacinia aliquet. Mauris ipsum. Nulla metus metus, ullamcorper vel, tincidunt sed, euismod in, nibh.",
    48. 

  48.             "tags": "Example Category",
    49. 

  49.             "url" : "http://oncrashreboot.com/plugin-example-2.html",
    50. 

  50.             "title": "Review of the book Lorem Ipsum"
    51. 

  51.         }
    52. 

  52.     ]
    53. 

  53. };
    54. 

  54. ```
    55. 

  55. 

  56. JS variable is written to file `tipuesearch_content.js` which is created in the root of `output` directory.
    57. 

  57. 

  58. 

  59. How to Use
    60. 

  60. ----------
    61. 

  61. 

  62. Your theme needs to have Tipue Search properly configured in it. [Official documentation](https://web.archive.org/web/20200703134724/https://tipue.com/search/help/) has the required details.
    63. 

  63. 

  64. In addition to the instructions from Tipue, the following has to be added in `pelicanconf.py`.
    65. 

  65. 

  66. ```python
    67. 

  67. DIRECT_TEMPLATES = ['index', 'tags', 'categories', 'authors', 'archives', 'search']
    68. 

  68. ```
    69. 

  69. 

  70. Furthermore, the generated JavaScript variable has to be sourced in the relevant HTML pages.
    71. 

  71. 

  72. ```html
    73. 

  73. <script src="{{ SITEURL }}tipuesearch_content.js"></script>
    74. 

  74. ```
    75. 

  75. 

  76. Pelican [Plumage theme](https://github.com/kdeldycke/plumage) has Tipue Search configured. Check out its code to understand the configuration.
    77. 

  77. 

  78. 

  79. Backward Compatibility
    80. 

  80. ----------------------
    81. 

  81. 

  82. This plugin requires Tipue Search Version 7.0 or higher.
    83. 

  83. 

  84. Tipue used to expect content in a JSON file. Around Version 7.0, Tipue maintainers made a switch to JavaScript variable. tipue_search plugin was updated to reflect this change in commit `4a5f171fc`. Latest version of tipue_search plugin will not work with older versions of Tipue Search.
    85. 

  85. 

  86. If you are using older Tipue Search, prior to 7.0 release, then you will find old version of tipue_search plugin in commit `2dcdca8c8`.
    87. 

  87. 

  88. 

  89. Source Archive
    90. 

  90. --------------
    91. 

  91. 

  92. The Tipue Search project itself seems to have been long abandoned. There is no
    93. 

  93. longer any official canonical reference of source code or documentation. There
    94. 

  94. only some artifacts left that were archived by the community:
    95. 

  95. 

  96. * [Archived Tipue Search homepage](https://web.archive.org/web/20200703134724/https://tipue.com/search/)
    97. 

  97. * [Archived Tipue plugin help page](https://web.archive.org/web/20200703134724/https://tipue.com/search/help/)
    98. 

  98. * [Archived Tipue Search code v7.1](https://web.archive.org/web/20200703134724/https://www.tipue.com/search/tipuesearch.zip)
    99. 

  99. * [GitHub repository copy](https://notabug.org/jorgesumle/Tipue-Search)
    100. 

  100.