diff --git a/_includes/breadcrumbs.html b/_includes/breadcrumbs.html new file mode 100644 index 0000000..c63c5c7 --- /dev/null +++ b/_includes/breadcrumbs.html @@ -0,0 +1,17 @@ + diff --git a/_includes/footer.html b/_includes/footer.html index 5977d15..adc2a0e 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,11 +1,23 @@ +
+
arrow_upward
+
+ +
+ diff --git a/_includes/header.html b/_includes/header.html index e786056..e8362c5 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -1,15 +1,84 @@ +{% if page.slug == 'homepage' %}
+{% endif %}
-
+ +{% if page.slug != 'homepage' %} + {% include breadcrumbs.html %} +{% endif %} diff --git a/_includes/sidebar.html b/_includes/sidebar.html new file mode 100644 index 0000000..9ab86fe --- /dev/null +++ b/_includes/sidebar.html @@ -0,0 +1,7 @@ +
+ +
diff --git a/_layouts/default.html b/_layouts/default.html index 77348c4..8b8ce47 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -1,49 +1,39 @@ - - - - - - - - - - - {% if page.title %}{{ page.title | escape }}{% else %}{{ site.title }}{% endif %} - - - - - - {% include analytics.html %} - - - - - {% include header.html %} - -
- {{ content }} -
- - {% include footer.html %} - - - + + + + + + + + + + + {% if page.title %}{{ page.title | escape }}{% else %}{{ site.title }}{% endif %} + + + + + + {% include analytics.html %} + + + + + {% include header.html %} + +
+ {{ content }} +
+ + {% include footer.html %} + + + + {% if page.slug == 'addons-plugins' or page.slug == 'addons-themes' %} + + {% endif %} + + diff --git a/_layouts/home.html b/_layouts/home.html index 7512c12..1197ee7 100644 --- a/_layouts/home.html +++ b/_layouts/home.html @@ -2,11 +2,23 @@ layout: default --- -

Question2Answer (Q2A) is a popular open source Q&A platform for PHP/MySQL, currently running on 24,500+ sites in 40 languages.

+
+

Question2Answer (Q2A) is a popular open source Q&A platform for PHP/MySQL, currently running on 24,500+ sites in 40 languages.

+
-{{ content }} + -
+
{% capture answerText %}

A Q&A site helps your online community to share knowledge. @@ -23,8 +35,8 @@

Question2Answer (Q2A) is a popular open {% include card-showcase.html icon="people" title="Why offer Q&A on my site?" answer=answerText %} {% capture answerText %} -

Download Question2Answer, then read how to install. - Version 1.8.8 was released on July 25th, 2023. +

Download Question2Answer, then read how to install. + Version 1.8.8 was released on July 25th, 2023. Also on GitHub.

Question2Answer is open source, licensed under GPL v2+.

{% endcapture %} @@ -43,9 +55,9 @@

Question2Answer (Q2A) is a popular open {% capture answerText %} @@ -68,24 +80,24 @@

Question2Answer (Q2A) is a popular open
  • Create experts, editors, moderators and admins.
  • User avatars (or Gravatar) and custom fields.
  • Private messages and public wall posts.
    • -
  • Log in via Facebook or others (using plugins).
    • +
  • Log in via Facebook or others (using plugins).
    • {% endcapture %} {% include card-showcase.html icon="face" title="Built-in user account management ..." answer=answerText %} {% capture answerText %}
      -
    • Out-of-the-box WordPress and Joomla integration.
      • -
    • Custom single sign-on support for other sites.
      • -
    • Deep integration and customization via plugins.
      • +
    • Out-of-the-box WordPress and Joomla integration.
      • +
    • Custom single sign-on support for other sites.
      • +
    • Deep integration and customization via plugins.
    {% endcapture %} {% include card-showcase.html icon="assignment_ind" title="... or integrate with existing sites" answer=answerText %} {% capture answerText %}
      -
    • PHP/MySQL scalable to millions of users and posts.
      • -
    • Safe from XSS, CSRF and SQL injection attacks.
      • +
    • PHP/MySQL scalable to millions of users and posts.
      • +
    • Safe from XSS, CSRF and SQL injection attacks.
    • Beat spam with captchas, moderation and/or flagging.
    {% endcapture %} @@ -93,10 +105,10 @@

    Question2Answer (Q2A) is a popular open {% capture answerText %}

    Contribute via Github, - create a theme, - plugin or - translation.

    + create a theme, + plugin or + translation.

    {% endcapture %} {% include card-showcase.html icon="translate" title="How can I help?" answer=answerText %} -

    + diff --git a/_layouts/page.html b/_layouts/page.html index b308436..1156bc8 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -3,23 +3,10 @@ ---
    -
    - {% include nav-sub.html %} -
    - -
    +
    {{ content }} -
    + +
    - - diff --git a/addons/clients.md b/addons/clients.md index dc15b3e..a9b0d56 100644 --- a/addons/clients.md +++ b/addons/clients.md @@ -2,6 +2,7 @@ layout: page menu: addons title: "Question2Answer - Add-ons - Clients" +slug: addons-clients --- # Question2Answer Clients diff --git a/addons/index.md b/addons/index.md index 52441f0..de3ca94 100644 --- a/addons/index.md +++ b/addons/index.md @@ -2,17 +2,18 @@ layout: page menu: addons title: "Question2Answer - Add-ons" +slug: addons --- # Question2Answer is being extended by the community. This page links to add-ons created by Question2Answer users. These are not endorsed for quality or suitability, but we hope they are useful. If you have something to contribute, please submit a pull request to [the docs](https://github.com/q2a/q2a.github.io/) or [get in touch](https://www.question2answer.org/feedback.php) - your help is much appreciated! -## [Translations](/addons/translations/) +## [Translations]({{ site.baseurl }}/addons/translations/) -## [Themes](/addons/themes/) +## [Themes]({{ site.baseurl }}/addons/themes/) -## [Plugins](/addons/plugins/) +## [Plugins]({{ site.baseurl }}/addons/plugins/) -## [Clients](/addons/clients/) +## [Clients]({{ site.baseurl }}/addons/clients/) diff --git a/addons/plugins.md b/addons/plugins.md index 86e4072..e097b47 100644 --- a/addons/plugins.md +++ b/addons/plugins.md @@ -2,15 +2,21 @@ layout: page menu: addons title: "Question2Answer Add-ons - Plugins" +slug: addons-plugins --- # Question2Answer Plugins To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `qa-plugin` directory, then open the Plugins section of the Admin panel and check it is listed. The plugin may also offer some options on this page. +> Note: If a plugin is marked as "Inactive" or "Unknown", it doesn't necessarily mean it's broken or unsupported. Some plugins are simply stable and don’t require frequent updates. +> +> For better compatibility insight, check the "Tested with" label. This shows which version of Q2A the plugin has been verified to work with by the author, maintainer, or contributors. + ## Major features -- [Badges Plugin](https://github.com/NoahY/q2a-badges) by [NoahY](http://www.question2answer.org/qa/user/NoahY) ➔ [updated](https://github.com/rxchun/q2a-badges/) by [Chun](https://rxchun.github.io/). Provides user badges which recognize users' activities and achievements. +- [Badges Plugin](https://github.com/NoahY/q2a-badges) by [NoahY](http://www.question2answer.org/qa/user/NoahY) Provides user badges which recognize users' activities and achievements. +- ➔ [Badges Plugin updated](https://github.com/rxchun/q2a-badges/) by [Chun](https://rxchun.github.io/). - [Better Points](https://github.com/arjunsuresh/q2a-betterpoints) by [Arjun](http://gateoverflow.in/user/Arjun). Extends the default Q2A point system by adding points for giving comments, receiving comment upvotes/downvotes. Also, has an option to give points for blog/exam postings which are supported by paid plugins. - [Category Experts](https://github.com/arjunsuresh/q2a-categoryexperts) by [Arjun](http://gateoverflow.in/user/Arjun). Adds a widget on Category pages showing the best performing users in that category. A good way to identify Category Experts. - [Extra Question Field](https://github.com/JacksiroKe/q2a-extra-question-field) by [Jack Siro](https://www.linkedin.com/in/jacksiroke/). Enhance your Extra Question fields with file management among other extra fields. @@ -23,15 +29,22 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q - [Embed Youtube Plugin](https://github.com/NoahY/q2a-embed) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Converts links to YouTube videos into embedded videos when displaying questions, answers or comments. - [Express Editor](https://github.com/amiyasahu/q2a-express-editor) by [Amiya Sahu](http://amiyasahu.com/). Recent version of [CKEditor](http://ckeditor.com/) bundled with [Ace Editor](http://ace.c9.io/) for smooth code editing. - [Lightbox-images](https://github.com/ProThoughts/q2apro-lightbox-images) by [q2apro.com](https://github.com/q2apro). Provides a Lightbox Effect for all images in posts. -- [Markdown Editor Plugin](https://github.com/ProThoughts/markdown-editor-for-q2a) by [Scott Vivian](http://codelair.co.uk/) of [PokéBase](http://pokemondb.net/pokebase/), updated for Q2A 1.8.6 [here](https://github.com/fardina/markdown-editor-for-q2a). +- [Markdown Editor](https://github.com/svivian/q2a-markdown-editor) by [Scott Vivian](http://codelair.co.uk/) of [PokéBase](http://pokemondb.net/pokebase/). This plugin uses [Markdown](https://www.markdownguide.org/getting-started/), a lightweight markup language for creating formatted text using a plain-text editor. For example `**bold**` for bold text, or start a line with `>` for quoting sources. +- ➔ [Markdown Editor with TOAST UI](https://github.com/ProThoughts/markdown-editor-for-q2a) by **awei922**. This version is based off of **Scott Vivian**'s version + [tui.editor](https://ui.toast.com/tui-editor), and allows you to edit your Markdown documents using text or WYSIWYG. Screenshot [here](https://raw.githubusercontent.com/ProThoughts/markdown-editor-for-q2a/refs/heads/master/screenshot.png). +- ➔ **awei922**'s version of **Markdown with TUI** also [forked here](https://github.com/fardina/markdown-editor-for-q2a) by [Fardina](https://github.com/fardina) for Q2A 1.8.6. - [Memes for Text](https://github.com/thibaultduponchelle/q2a-memes) by [Thibault Duponchelle](https://github.com/thibaultduponchelle). Post *lolfaces* in your answers or comments. - [Miranda](http://www.question2answer.org/qa/51849/tinymcewrapper-miranda-updated-most-powerful-editor-joins) [Tinymcse Wrapper](https://www.tinymce.com/) by Don Shakespeare. Adds Tinymcse to be used across posts as well as other text areas like messages, wall posts and is higly customizable. -- [Prevent Simultaneous Edits](https://github.com/ElephantsGroup/q2a-prevent-simultaneous-edits) by [q2apro.com](https://github.com/q2apro). Prevent two users editing the same post simultaneously. Also [forked](https://github.com/ElephantsGroup/q2a-prevent-simultaneous-edits) by [Jalal Jaberi](https://github.com/ElephantsGroup). +- [Prevent Simultaneous Edits](https://github.com/ElephantsGroup/q2a-prevent-simultaneous-edits) by [q2apro.com](https://github.com/q2apro). Prevent two users editing the same post simultaneously. +- ➔ [Prevent Simultaneous Edits also forked](https://github.com/ElephantsGroup/q2a-prevent-simultaneous-edits) by [Jalal Jaberi](https://github.com/ElephantsGroup). - [SCEditor Plugin](https://github.com/q2apro/SCEditor) by [q2apro.com](https://github.com/q2apro). Provides [SCEditor](http://www.sceditor.com) as a WYSIWYG rich text editor. Some functionality requires the Premium version. - [Shortcode Plugin](https://github.com/NoahY/q2a-shortcode) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows posts to be displayed with text substitutions, including support for regular expressions. -- [Smilies for Text](https://github.com/NoahY/q2a-smilies) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows smilies to be embedded in plain text or Markdown content. Also [forked](https://github.com/thibaultduponchelle/q2a-smilies) by [Thibault Duponchelle](https://github.com/thibaultduponchelle) to support multiboxes, add a lot of smilies and slightly improve the style. +- [Smilies for Text](https://github.com/NoahY/q2a-smilies) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows smilies to be embedded in plain text or Markdown content. +- ➔ [Smilies for Text also forked](https://github.com/thibaultduponchelle/q2a-smilies) by [Thibault Duponchelle](https://github.com/thibaultduponchelle) to support multiboxes, add a lot of smilies and slightly improve the style. - [Syntax Highlighter](https://github.com/amiyasahu/q2a-syntax-highlighter) by [Amiya Sahu](http://amiyasahu.com/). Code syntax highlighting based on [highlight.js](https://highlightjs.org/) with over 40 built-in themes. -- [WYSIWYG Math Editor](https://github.com/thibaultduponchelle/q2a-wysiwyg-matheditor) by [Thibault Duponchelle](https://github.com/thibaultduponchelle). A CKEditor 4 editor plugin *with math capabilities*. Allow users to add math formulas (MathJax) in questions, answers and comments. Other math editors based on *preview zone* like [SCEditor](https://github.com/ProThoughts/q2apro-sceditor-free)were already mentioned above. Also: [q2a-formatter](https://github.com/tangruize/q2a-formatter) (or [Google Code Prettify and MathJax](https://github.com/arjunsuresh/mathjax) from [Arjun Suresh](https://github.com/arjunsuresh) from which [q2a-formatter](https://github.com/tangruize/q2a-formatter) was forked). +- [WYSIWYG Math Editor](https://github.com/thibaultduponchelle/q2a-wysiwyg-matheditor) by [Thibault Duponchelle](https://github.com/thibaultduponchelle). A CKEditor 4 editor plugin *with math capabilities*. Allow users to add math formulas (MathJax) in questions, answers and comments. +- ➔ Other math editors based on *preview zone* like [SCEditor](https://github.com/ProThoughts/q2apro-sceditor-free) were already mentioned above. +- ➔ Also: [q2a-formatter](https://github.com/tangruize/q2a-formatter) by [tangruize](https://github.com/tangruizer). +- ➔ Or [Google Code Prettify and MathJax](https://github.com/arjunsuresh/mathjax) from [Arjun Suresh](https://github.com/arjunsuresh) from which **q2a-formatter** was forked. - [Paid] [DM - Dynamic Mentions](https://www.question2answer.org/qa/66929) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Allows users to be mentioned using the @user syntax. @@ -48,6 +61,7 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q - [Facebook Like Box](https://github.com/amiyasahu/q2a-facebook-like-box) by [Amiya Sahu](http://amiyasahu.com/). Basic widget for displaying a [Facebook](http://www.facebook.com/) like box. - [Google Adsense Async](https://github.com/ganbox/ganbox-async-adsense) by Georgi Stefanov @ [Ganbox](https://ganbox.com/). Widget for displaying Google AdSense ads with asynchronous JavaScript code. - [Google Cloud Storage](https://q2a.io/product/google-cloud-storage-plugin/) by [q2a.io](https://q2a.io/). Stores and serves uploaded files in [Google Cloud Storage](https://cloud.google.com/storage/) instead of the local database. +- [Google Code Prettify and MathJax](https://github.com/arjunsuresh/mathjax) by [Arjun](http://gateoverflow.in/user/Arjun). Handles the trouble of adding MathJax or CodePretiffy to Q2A. - [Google Custom Search](https://github.com/arjunsuresh/q2a-google-search) by [Arjun](http://gateoverflow.in/user/Arjun). Replaces Q2A's default search functionality with [Google Custom Search](https://cse.google.com/cse/all). Useful for searching across a network of Q2A sites and also if you are using blogs in Q2A. - [Google Plus Badge](https://github.com/amiyasahu/q2a-google-plus-badge) by [Amiya Sahu](http://amiyasahu.com/). Basic widget for displaying a [Google Plus](https://plus.google.com/) badge. - [IMAP Login](https://github.com/josebmera/q2a-imap-login) by Jose Mª Bermudo Mera. Replaces the Q2A login form with authentication against an email server via IMAP. @@ -57,9 +71,8 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q - [Mailgun Integration](https://q2a.io/product/mailgun-integration-plugin/) by [q2a.io](https://q2a.io/). Sends outgoing emails via the [Mailgun](https://www.mailgun.com/) API. - [Mailing List Manager](https://github.com/MichaelApproved/Question2Answer-Mailing-List-Manager) by [Michael Khalili](http://www.michaelapproved.com/). Adds your Q2A member email addresses to your [MailChimp.com](http://mailchimp.com/) list. - [Mattermost Notifications](https://github.com/Schoaf/qa-mattermost-notifications) by [Andreas Scharf](https://github.com/Schoaf). Sends notifications of new questions to a [Mattermost](http://mattermost.org/) feed. -- [Google Code Prettify and MathJax](https://github.com/arjunsuresh/mathjax) by [Arjun](http://gateoverflow.in/user/Arjun). Handles the trouble of adding MathJax or CodePretiffy to Q2A. - [MyBB single sign-on](http://community.mybb.com/thread-121885-post-879492.html#pid879492) by Dahevos. Allows Q2A to be integrated into a MyBB forum, sharing the same user database. -- [Open Login](https://github.com/alixandru/q2a-open-login) by [Alex Lixandru](https://github.com/alixandru/). Log in via [Facebook](http://www.facebook.com/), [Google](http://www.google.com/), [Yahoo](http://www.yahoo.com/), [Github](http://www.github.com/) and many more, plus multiple logins for a single Q2A account. +- [Open Login](https://github.com/alixandru/q2a-open-login) by [Alex Lixandru](https://github.com/alixandru). Log in via [Facebook](http://www.facebook.com/), [Google](http://www.google.com/), [Yahoo](http://www.yahoo.com/), [Github](http://www.github.com/) and many more, plus multiple logins for a single Q2A account. - [Persian Magic Words](http://question2answer-farsi.com/707/q2a-magicword-plugin.html) by AmirHossein Tavousi @ [Question2Answer Farsi](http://question2answer-farsi.com/). Shows word meanings from [Vajehyab.com](http://vajehyab.com/) for highlighted words. - [Proxy SSO](https://github.com/larrykluger/Question-2-Answer-Proxy-SSO-Plugin) by Larry Kluger. Lets your main website serve as a single sign-on authentication system for Q2A. - [uLogin Login Plugin](https://github.com/saxap/ulogin-for-q2a) by [Sergey Astafev](http://dontforget.pro/). Allows logging in via [uLogin](http://ulogin.ru), which supports many identity providers popular in Russia. @@ -69,13 +82,17 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q ## Additional page types -- [Best Users per Month](https://github.com/ProThoughts/q2apro-best-users-pro) by [q2apro.com](https://github.com/q2apro). Displays the users with the most points each month (for large sites there is a premium plugin which does not have performance issue). Also [forked](https://github.com/ElephantsGroup/q2a-best-users-per-month) by [Jalal Jaberi](https://github.com/ElephantsGroup) which supports Jalali calendar. +- [Best Users per Month](https://github.com/ProThoughts/q2apro-best-users-pro) by [q2apro.com](https://github.com/q2apro). Displays the users with the most points each month (for large sites there is a premium plugin which does not have performance issue). +- ➔ Also [forked](https://github.com/ElephantsGroup/q2a-best-users-per-month) by [Jalal Jaberi](https://github.com/ElephantsGroup) which supports Jalali calendar. - [Blog Post](https://github.com/JaxiroKe/q2a-blog-post) by [Jack Siro](https://www.linkedin.com/in/JaxiroKe/). Allows registered users to maintain a blog on their Q2A site. -- [Book Plugin](https://github.com/NoahY/q2a-book) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Creates an HTML (or PDF) book of a site's top questions and answers. Also [forked](https://github.com/arjunsuresh/q2a-book) by [Arjun](http://gateoverflow.in/user/Arjun) which adds more question filtering options and better styling options. +- [Book Plugin](https://github.com/NoahY/q2a-book) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Creates an HTML (or PDF) book of a site's top questions and answers. +- ➔ Also [forked](https://github.com/arjunsuresh/q2a-book) by [Arjun](http://gateoverflow.in/user/Arjun) which adds more question filtering options and better styling options. - [Chat Room](https://github.com/svivian/q2a-chat-room) by [Scott Vivian](http://codelair.co.uk/) of [PokéBase](http://pokemondb.net/pokebase/). Adds a simple chat room to a Q2A site. - [Custom 404 Page](https://github.com/amiyasahu/q2a-custom-404-page) by [Amiya Sahu](http://amiyasahu.com/). Allows the content of the 404 (page not found) page to be customized. -- [Edit History](https://github.com/svivian/q2a-edit-history) by [Scott Vivian](http://codelair.co.uk/) of [PokéBase](http://pokemondb.net/pokebase/). Stores all edits to posts and allows users to see what changed. Also [forked](https://github.com/ElephantsGroup/q2a-edit-history) by [Jalal Jaberi](https://github.com/ElephantsGroup). -- [FAQ Page](https://github.com/gturri/q2a-faq/) forked from [older version](https://github.com/NoahY/q2a-faq) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Provides a customizable FAQs page which can include an explanation of the points system on your Q2A site. +- [Edit History](https://github.com/svivian/q2a-edit-history) by [Scott Vivian](http://codelair.co.uk/) of [PokéBase](http://pokemondb.net/pokebase/). Stores all edits to posts and allows users to see what changed. +- ➔ Also [forked](https://github.com/ElephantsGroup/q2a-edit-history) by [Jalal Jaberi](https://github.com/ElephantsGroup). +- [FAQ Page](https://github.com/NoahY/q2a-faq) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Provides a customizable FAQs page which can include an explanation of the points system on your Q2A site. +- ➔ [FAQ Page forked](https://github.com/gturri/q2a-faq/) from NoahY's older version by [gturri](https://github.com/gturri). - [Open Questions Plugin](https://github.com/nakov/q2a-plugin-open-questions) by [Svetlin Nakov](http://www.nakov.com/). Provides a page displaying all questions with no answers and which have not been closed. - [Polls Plugin](https://github.com/NoahY/q2a-poll) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows some questions to be created as polls. - [Print View Plugin](https://github.com/NoahY/q2a-print) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Adds a simplified print view for questions. @@ -88,16 +105,17 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q ## Widgets - [Category Anywhere](https://github.com/ostack/qa-categories-anywhere-widget) by [ZhaoGuangyue](https://www.linkedin.com/in/%E5%85%89%E8%B7%83-%E8%B5%B5-b58234146). [Demo](https://www.ostack.cn). Displays category not only sidebar but also top panel, bottom panel and so on. -- [Random Question](https://github.com/ostack/qa-random-question-widget) by [ZhaoGuangyue](https://www.linkedin.com/in/%E5%85%89%E8%B7%83-%E8%B5%B5-b58234146). [Demo](https://www.ostack.cn). Displays random questions, to improve search engine coverage. - [Breadcrumbs Widget](https://github.com/amiyasahu/q2a-breadcrumbs) by [Amiya Sahu](http://amiyasahu.com/). Displays navigational breadcrumbs showing the path to the currently viewed page. - [Category Description](https://github.com/arjunsuresh/categorydescription) by [Arjun](http://gateoverflow.in/user/Arjun). Allows HTML description to be added for Categories which gets displayed on top of Category Pages. - [Feed Widget](https://github.com/Towhidn/Q2A-feed-widget) by [Towhid](http://TowhidN.com/). Lists recent items from an external RSS feed. Useful for blog posts, articles, etc... - [Logarithmic Tag Cloud](https://github.com/NoahY/q2a-log-tags) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Provides a list of tags with logarithmic size indicating popularity. - [Most Active Users](https://github.com/yshiga/q2apro-most-active-users) by [q2apro.com](https://github.com/q2apro). Shows a list of users who were most active in the past week or month. -- [Online User Count](https://github.com/pupi1985/q2a-onlineusers/tree/a1e555b77b5a0585f8c336d9e37e1e4a2bece437) by Ali Sayahiyan. Shows a list of users who are currently online as well as total visitors. Also [forked here](https://github.com/pupi1985/q2a-onlineusers) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). +- [Online User Count](https://github.com/pupi1985/q2a-onlineusers/tree/a1e555b77b5a0585f8c336d9e37e1e4a2bece437) by Ali Sayahiyan. Shows a list of users who are currently online as well as total visitors. +- ➔ Also [forked here](https://github.com/pupi1985/q2a-onlineusers) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). - [Popular Questions](https://github.com/ProThoughts/q2apro-popular-questions-widget) by [q2apro.com](https://github.com/q2apro). Shows a list of the most viewed questions. - [Random Question Widget](https://github.com/NoahY/qa-random-question) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Displays a random question in the sidebar. -- [Recent Events Widget](https://github.com/fullstack412/Q2A-Recent-Events-Widget) by [q2apro.com](https://github.com/q2apro/). Displays all recent events in the sidebar or main area. +- ➔ [Random Question updated](https://github.com/ostack/qa-random-question-widget) by [ZhaoGuangyue](https://www.linkedin.com/in/%E5%85%89%E8%B7%83-%E8%B5%B5-b58234146). [Demo](https://www.ostack.cn). Displays random questions, to improve search engine coverage. +- [Recent Events Widget](https://github.com/fullstack412/Q2A-Recent-Events-Widget) by [q2apro.com](https://github.com/q2apro). Displays all recent events in the sidebar or main area. - [Recent Questions Widget](http://www.q2amarket.com/market/q2am-recent-questions/) by [Q2A Market](http://www.q2amarket.com/). Shows a list of recent questions in the sidebar or other locations. - [RSS Feed Widget](https://github.com/mbentley3123/q2a-rss-feed) by Mark Bentle by Mark Bentleyy. Displays posts from an RSS feed in the sidebar. - [Simple Slider](https://github.com/JacksiroKe/q2a-simple-slider) by [Jack Siro](https://www.linkedin.com/in/jacksiroke/). A simple image slider for the tops of pages, showing titles, descriptions and links. @@ -106,12 +124,12 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q - [Tag List Widget](https://github.com/svivian/q2a-tag-list-widget) by [Scott Vivian](http://codelair.co.uk/) of [PokéBase](http://pokemondb.net/pokebase/). Displays the most popular tags in a simple list. - [Twitter Widget](https://github.com/Towhidn/q2a-twitter) by [Towhid](http://TowhidN.com/). Shows recent tweets from your twitter account. - [Widget Anywhere Plugin](https://github.com/svivian/q2a-widget-anywhere) by [Scott Vivian](http://codelair.co.uk/) of [PokéBase](http://pokemondb.net/pokebase/). Allows custom content to be added on any page, in a variety of locations. -- [Simple Ads Manager](https://github.com/ProThoughts/q2a-simple-ads-manager) by [ProThoughts](http://ProThoughts.com). Allow you to add advertisements in [listed spots](https://github.com/ProThoughts/q2a-simple-ads-manager). You can use Google adsense or any HTML ad code. Also [forked](https://github.com/arjunsuresh/q2a-simple-ads-manager) by [Arjun](http://gateoverflow.in/user/Arjun) to add more options like Ads after first question hiding ads for certain user level and above etc. +- [Simple Ads Manager](https://github.com/ProThoughts/q2a-simple-ads-manager) by [ProThoughts](http://ProThoughts.com). Allow you to add advertisements in listed spots. You can use Google adsense or any HTML ad code. +- ➔ Also [forked](https://github.com/arjunsuresh/q2a-simple-ads-manager) by [Arjun](http://gateoverflow.in/user/Arjun) to add more options like Ads after first question hiding ads for certain user level and above etc. - [Paid] [AS - Advanced Search](https://www.question2answer.org/qa/54072) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Extends the way in which Q2A searches for posts and allows the user to get better results when searching. ## User interface -- [Title Length Counter](https://github.com/MominRaza/title-length-counter) by [Momin Raza](https://github.com/MominRaza). It shows the length of title below title text field. - [Advanced Tag Descriptions](https://github.com/Towhidn/q2a-tag-descriptions) by [Towhid](http://TowhidN.com/). Add titles, icons and HTML descriptions to your tags. - [Accept Rate Plugin](https://github.com/NoahY/q2a-accept-rate) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Shows the percentage of questions asked by a user which had an answer selected as the best. - [Ajax User Search](https://github.com/ProThoughts/q2apro-ajax-usersearch) by [q2apro](https://github.com/q2apro). Adds a live search box at the top of the users page to search users by username. @@ -127,29 +145,33 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q - [Gregorian 2 Jalali](http://question2answer-farsi.com/109/shamsi-date-plugin.html) by Ali Sayahiyan @ [Question2Answer Farsi](http://question2answer-farsi.com/). Displays dates in Jalali (Iranian) format. - [Guest-id](https://github.com/ProThoughts/q2apro-guest-id) by [q2apro.com](https://github.com/q2apro). Gives all anonymous users that are posting in your forum a unique ID. - [Hide answer for unlogin user](https://github.com/ostack/q2a-hide-answers-for-unlogin-user) by [ZhaoGuangyue](https://www.linkedin.com/in/%E5%85%89%E8%B7%83-%E8%B5%B5-b58234146). [Demo](https://www.ostack.cn). Only show answers for logged in users or users with enough points, to encourage registrations. +- [MTL - Maximum Tag Length](https://www.question2answer.org/qa/41822) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Limits the amount of characters allowed per each question tag. - [Pretty-tags](https://github.com/ProThoughts/q2apro-pretty-tags) by [q2apro.com](https://github.com/q2apro). Provides a pretty autocomplete for tags on the ask page. - [Privilege Management](https://github.com/NoahY/q2a-privileges) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Adds a tab to user profile pages showing progress towards additional privileges. - [Private Message Adapter](https://github.com/JacksiroKe/q2a-pm-adapter) by [Jack Siro](https://www.linkedin.com/in/jacksiroke/). Adds an editor of your choice on the private message and feedback pages, including support for HTML messages. - [Question Filter](https://github.com/ganbox/qa-filter) by Georgi Stefanov @ [Ganbox](http://ganbox.com/). Adds filtering of user input when asking questions, to check duplication, capitalization, etc... - [Question Numbering](https://github.com/arjunsuresh/q2a-qnumbering) by [Arjun](http://gateoverflow.in/user/Arjun). Adds numbering to questions in question listing pages. - [Quick-login](https://github.com/ProThoughts/q2apro-quick-login) by [q2apro.com](https://github.com/q2apro). Provides a quick login field for all your users. -- [Role Markers](https://github.com/NoahY/q2a-role-markers) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Adds markers to the avatars displayed for users with special privileges. Also [forked](https://github.com/zakkak/q2a-role-markers) by [Zakkak](https://github.com/zakkak). +- [RA - Random Avatar](https://www.question2answer.org/qa/39812) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Assigns new users a random avatar from a given set immediately after registering. +- [Role Markers](https://github.com/NoahY/q2a-role-markers) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Adds markers to the avatars displayed for users with special privileges. +- ➔ Also [forked](https://github.com/zakkak/q2a-role-markers) by [Zakkak](https://github.com/zakkak). - [Social Sharing Plugin](https://github.com/NoahY/q2a-share) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Adds social sharing buttons to question pages. - [Sort Answers](https://github.com/amiyasahu/q2a-sort-answers) by [Amiya Sahu](http://amiyasahu.com/). Allows answers on a question page to be sorted by oldest, newest and highest voted. - [Tag Search](https://github.com/arjunsuresh/tag-search) by [Arjun](http://gateoverflow.in/user/Arjun). Allows tags to be searched via AJAX and with auto complete. -- [Tag Descriptions Plugin](http://www.question2answer.org/releases/q2a-tag-descriptions-tutorial.zip) from the [plugin tutorial](/plugins/tutorial/). Allows tag descriptions to be shown on tag pages and in tooltips. +- [Tag Descriptions Plugin](http://www.question2answer.org/releases/q2a-tag-descriptions-tutorial.zip) from the [plugin tutorial]({{ site.baseurl }}/plugins/tutorial/). Allows tag descriptions to be shown on tag pages and in tooltips. - [Theme Switcher Plugin](https://github.com/arjunsuresh/q2a-theme-switch) by [NoahY](http://www.question2answer.org/qa/user/NoahY) and updated by [Arjun](http://gateoverflow.in/user/Arjun). Allows users to choose their own theme on their profile page for normal as well as mobile view. -- [Top Searches](https://github.com/arjunsuresh/q2a-top-search) by [Arjun](http://gateoverflow.in/user/Arjun). Adds a widget to display the top searched words. Also have an option to display top seacrhed tags if using [Tag Search](https://github.com/arjunsuresh/tag-search) plugin. -- [User Signatures Plugin](https://github.com/NoahY/q2a-signatures) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows users to define a signature for all of their posts. Also [forked here](https://github.com/pupi1985/q2a-signatures) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). -- [Userinfo](https://github.com/ProThoughts/q2apro-userinfo) by [q2apro.com](https://github.com/q2apro).Mouse over a username to display user profile information: Avatar image, account age, total points, monthly points, answers, best answers, ratio, questions posted, badges. -- [Userslist-locations](https://github.com/ProThoughts/q2apro-userslist-locations) by [q2apro.com](https://github.com/q2apro).Add Location to users list +- [Title Length Counter](https://github.com/MominRaza/title-length-counter) by [Momin Raza](https://github.com/MominRaza). It shows the length of title below title text field. +- [Top Searches](https://github.com/arjunsuresh/q2a-top-search) by [Arjun](http://gateoverflow.in/user/Arjun). Adds a widget to display the top searched words. +- ➔ Also have an option to display top searched tags if using [Tag Search](https://github.com/arjunsuresh/tag-search) plugin. +- [User Signatures Plugin](https://github.com/NoahY/q2a-signatures) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows users to define a signature for all of their posts. +- ➔ Also [forked here](https://github.com/pupi1985/q2a-signatures) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). +- [Userinfo](https://github.com/ProThoughts/q2apro-userinfo) by [q2apro.com](https://github.com/q2apro). Mouse over a username to display user profile information: Avatar image, account age, total points, monthly points, answers, best answers, ratio, questions posted, badges. +- [Userslist-locations](https://github.com/ProThoughts/q2apro-userslist-locations) by [q2apro.com](https://github.com/q2apro). Add Location to users list - [Warn on Leave](https://github.com/yshiga/q2apro-warn-on-leave) by [q2apro.com](https://github.com/q2apro). Warns users before leaving a page with text they have entered (also support WYSIWYG editor). - [MTL - Maximum Tag Length](https://www.question2answer.org/qa/41822) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Limits the amount of characters allowed per each question tag. - [RA - Random Avatar](https://www.question2answer.org/qa/39812) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Assigns new users a random avatar from a given set immediately after registering. - [Paid] [Avatar Cropper](https://rxchun.github.io/shop/avatar-cropper/?ref=q2a-docs) by [Chun](https://www.question2answer.org/qa/user/gold-developer). Crops new and existing user avatars to a square format (1:1). - [Paid] [PC - Profile Customizer](https://www.question2answer.org/qa/36952) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Allows the customization of the profile page by adding additional features not present in the core, including tracking of point changes. -- [Paid] [Report Master](https://rxchun.github.io/shop/report-master/?ref=q2a-docs) by [Chun](https://www.question2answer.org/qa/user/gold-developer). Report reasons & user suspension. - With Report Master, users can easily submit detailed reports, specifying issues like spam, abuse, off-topic content, or inappropriate behavior. Moderators can review reports, suspend users if necessary, and leave notes for team collaboration. - [Paid] [SNP - Social Network Profiles](https://www.question2answer.org/qa/46857) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Allows users to add information about social networks they are part of and share it with the community. - [Paid] [UR - User Reactions](https://www.question2answer.org/qa/62711) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Allows users to react to questions, answers and comments. @@ -158,35 +180,43 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q - [Category Email Notifications](https://github.com/dunse/qa-category-email-notifications) by Pehr Johansson. Emails new questions in a category to all users who favorited that category. - [Email Formatting](https://github.com/ruuttt/q2a-email-formating) by Ruut Brandsma @ [Ecofys](http://www.ecofys.com/). Allows HTML formatting to be used in notification emails. - [Email Notifications](https://github.com/sawtoothsoftware/Q2A-Email-Notifications) by Walter Williams @ [Sawtooth Software](http://www.sawtoothsoftware.com/). Allows users to receive notifications about new questions and answers. +- [FNS - Flexible Notifications System](https://github.com/pupi1985/q2a-pupi-fns) by [pupi1985](https://question2answer.org/qa/user/pupi1985). Flexible Notifications System is a plugin that allows users to receive notifications in a flexible and efficient way. [Learn more](https://question2answer.org/qa/112052/new-free-plugin-fns-flexible-notifications-system) - [Follow Question](https://github.com/ProThoughts/q2apro-follow-question) by [q2apro.com](https://github.com/q2apro). +- [Newsletter-favtags](https://github.com/ProThoughts/q2apro-newsletter-favtags) by [q2apro.com](https://github.com/q2apro).Users can subscribe to their favorite tags and the plugin emails them daily if there are new questions. +- [Newsletter Plugin](https://github.com/NoahY/q2a-newsletter) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows users to receive an HTML newsletter of the latest top questions, answers and comments. - [On-Site Notifications](https://github.com/q2apro/q2apro-on-site-notifications) by [q2apro.com](https://github.com/q2apro). Pop-up notifications on the page which can replace email notifications. - [Remind Users](https://github.com/yshiga/q2apro-remind-users) by [q2apro.com](https://github.com/q2apro). Reminds users to complete their profile and upload an avatar within X hours after registration. - [Revised Email Notifications](https://github.com/zakkak/q2a-email-notifications-revised) by [Foivos Zakkak](http://foivos.zakkak.net/). An enhanced fork of the "Email Notifications" plugin. -- [Newsletter-favtags](https://github.com/ProThoughts/q2apro-newsletter-favtags) by [q2apro.com](https://github.com/q2apro).Users can subscribe to their favorite tags and the plugin emails them daily if there are new questions. -- [Newsletter Plugin](https://github.com/NoahY/q2a-newsletter) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows users to receive an HTML newsletter of the latest top questions, answers and comments. - [Tag and Category Notification](https://github.com/amiyasahu/q2a-email-notification) by [Amiya Sahu](http://amiyasahu.com/). When a question is asked with a tag/category, emails users who favorited that tag/category. -- [Votes-manager](https://github.com/ProThoughts/q2apro-votes-manager) by [q2apro.com](https://github.com/q2apro).Lists all votes made in your forum.](https://github.com/q2apro).Sends emails to users about activities on questions they have favorited. +- [Votes-manager](https://github.com/ProThoughts/q2apro-votes-manager) by [q2apro.com](https://github.com/q2apro). Lists all votes made in your forum. Sends emails to users about activities on questions they have favorited. ## Anti-spam tools - [Akismet Plugin](http://qcybb.com/question2answer-akismet-plugin/) by [Dave Hannon](http://qcybb.com/). Uses the [Akismet](http://akismet.com/) spam filtering service to detect spammy posts and queue them for moderation. - [AntiBot Captcha](https://github.com/KrzysztofKielce/q2a-captcha-antibot) by [Krzysztof Kielce](http://www.question2answer.org/qa/user/Krzysztof+Kielce). Simple and easy captcha for Q2A 1.5+. - [Bootstrap reCAPTCHA](https://github.com/amiyasahu/q2a-bootstrap-recaptcha) by [Amiya Sahu](http://amiyasahu.com/). A version of the default reCAPTCHA plugin that works well with Bootstrap-based themes. +- [Q2A Honeypot](https://github.com/rxchun/q2a-honeypot) by [Chun](https://rxchun.github.io/). This plugin creates a simple Javascript honeypot for spam bots on Register, Ask, and Feedback pages, preventing them from auto-filling fields and completing user registration. - [KeyCAPTCHA Captcha](https://github.com/spd-name/q2a-captcha-keycaptcha) by [Andrey Gvosdev](http://spd.name). Provides the [KeyCAPTCHA](https://www.keycaptcha.com) captcha for Q2A. - [Logical Captcha](https://github.com/amiyasahu/q2a-logical-captcha) by [Amiya Sahu](http://amiyasahu.com/). Shows simple logical questions from [Text CAPTCHA](http://textcaptcha.com) as a captcha challenge. - [Spammer Checker](https://github.com/sawtoothsoftware/Q2A-Spammer-Checker) by Walter Williams @ [Sawtooth Software](http://www.sawtoothsoftware.com/). On IP address pages, checks [stopforumspam.com](http://www.stopforumspam.com/) and [botscout.com](http://botscout.com/) to see if the IP belong to a known spammer. +- [SRS - SPAM Registration Stopper](https://github.com/pupi1985/q2a-pupi-srs) by [pupi1985](https://question2answer.org/qa/user/pupi1985). SPAM Registration Stopper is a plugin that prevents highly probable SPAM user registrations based on well-known SPAM checking services. [Learn more](https://question2answer.org/qa/98717/new-free-plugin-srs-spam-registration-stopper) - [Stop-spam](https://github.com/ProThoughts/q2apro-stop-spam) by [q2apro.com](https://github.com/q2apro). An easy to use customizable captcha with a honeypot that keeps 99 % of the daily spam away. +- [Paid] [Report Master](https://rxchun.github.io/shop/report-master/?ref=q2a-docs) by [Chun](https://www.question2answer.org/qa/user/gold-developer). Report reasons & user suspension. + With Report Master, users can easily submit detailed reports, specifying issues like spam, abuse, off-topic content, or inappropriate behavior. Moderators can review reports, suspend users if necessary, and leave notes for team collaboration. ## Administrative tools - [Admin Plus Plugin](https://github.com/NoahY/q2a-admin-plus) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Extends the admin area by allowing PHP commands to be executed. (Use with caution!) -- [Batch Import Users](https://github.com/ostack/q2a-user-import) updated and fixed by [ZhaoGuangyue](https://www.linkedin.com/in/%E5%85%89%E8%B7%83-%E8%B5%B5-b58234146). [Original](https://github.com/thisliquidspace/q2a-user-import). Batch import users from CSV files. +- [Batch Import Users](https://github.com/thisliquidspace/q2a-user-import). Batch import users from CSV files. +- ➔ [Batch Import Users Updated](https://github.com/ostack/q2a-user-import) updated and fixed by [ZhaoGuangyue](https://www.linkedin.com/in/%E5%85%89%E8%B7%83-%E8%B5%B5-b58234146). - [Categorization Plugin](https://github.com/NoahY/q2a-cat) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows individual categorization of uncategorized posts via the categories admin panel. - [Change Post Owner](https://github.com/ProThoughts/q2apro-change-post-owner) by [q2apro.com](https://github.com/q2apro). Allows the author of a post to be changed, or to make it anonymous. +- [COMA - Configuration Manager](https://github.com/pupi1985/q2a-pupi-coma) by [pupi1985](https://question2answer.org/qa/user/pupi1985). This plugin allows users to import/export and share their Q2A configuration with others. This is particularly useful when trying to identify issues with the Q2A core or plugins. [Learn more](https://question2answer.org/qa/98717/new-free-plugin-srs-spam-registration-stopper) - [Convert Comment to Answer](https://github.com/ellcupakabra/q2apro-comment-to-answer) by [q2apro.com](https://github.com/q2apro). Convert a comment to an answer, optionally move the succeeding comments. - [Database Backup/Restore](https://github.com/KrzysztofKielce/q2a-backup) by [Krzysztof Kielce](http://www.question2answer.org/qa/user/Krzysztof+Kielce). An admin tool for one-click backup and restore of the Q2A instance or entire database. - [Delete Hidden Posts](https://github.com/amiyasahu/q2a-delete-hidden-posts) by [Amiya Sahu](http://amiyasahu.com/). Enables all hidden posts (including those with dependencies) to be deleted. - [Expert Questions](https://github.com/NoahY/q2a-expert-questions) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows some questions to made viewable by experts only. +- [FC - Fake Cron](https://github.com/pupi1985/q2a-fake-cron) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Fires events after a certain amount of requests or in a time-based manner (daily, weekly, monthly). [Q2A Post](https://www.question2answer.org/qa/42051) - [Find Text in Posts](https://github.com/q2apro/q2apro-find-text-posts) by [q2apro](https://github.com/q2apro). Allows admins to search posts for specific text and display the creator, URL and content. - [Google Analytics Plugin](https://github.com/kufeiko/QA-Google-Analytics-Plugin) by [Ivan](http://www.question2answer.org/qa/user/Ivan+Donkov). Analyze Q2A traffic with Google Analytics, optionally excluding requests from the super admin. - [Greeklish URLs](https://github.com/stefkiourk/Question2Answer-greeklish-URLs) by Kiourkoulis Stefanos]. Converts Greek characters in question URLs into Latin equivalents. @@ -201,11 +231,11 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q - [Translator](https://github.com/pedjas/q2a-translator) by [Pedja Supurovic](http://pedja.supurovic.net). Allows translations to be created online through pages in the administration interface. - [Webmaster Tools](https://github.com/Towhidn/Q2A-Webmaster) by [Towhid](http://TowhidN.com). Reports include server info and memory usage, SEO analysis, security warnings. - [Quick-edit](https://github.com/ProThoughts/q2apro-quick-edit) by [q2apro.com](https://github.com/q2apro). Update all question titles and tags quickly on one page and save hours of time. -- [Ultimate SEO](https://github.com/q2a-projects/Q2A-Ultimate-SEO) by [Towhid](http://TowhidN.com). Enhances Question2Answer for better search engine optimization and offers valuable customization features. Also [forked here](https://github.com/pupi1985/q2a-ultimate-seo) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). +- [Ultimate SEO](https://github.com/q2a-projects/Q2A-Ultimate-SEO) by [Towhid](http://TowhidN.com). Enhances Question2Answer for better search engine optimization and offers valuable customization features. +- ➔ Also [forked here](https://github.com/pupi1985/q2a-ultimate-seo) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). - [Uploadmanager](https://github.com/ProThoughts/q2apro-uploadmanager) by [q2apro.com](https://github.com/q2apro). A complete upload manager for question2answer with upload details and image rotate features. - [Userstatistics](https://github.com/ProThoughts/q2apro-userstatistics) by [q2apro.com](https://github.com/q2apro). A complete user statistic with detailed points per post and thumbs and more. - [Votes-manager](https://github.com/ProThoughts/q2apro-votes-manager) by [q2apro.com](https://github.com/q2apro). Lists all votes made in your forum. -- [FC - Fake Cron](https://www.question2answer.org/qa/42051) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Fires events after a certain amount of requests or in a time-based manner (daily, weekly, monthly). - [Paid] [BCG - Bulk Content Generator](https://www.question2answer.org/qa/54488) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Allows admins to generate large amounts of content on their sites simply by uploading files (.xls, .xlsx, .ods, among other file formats). - [Paid] [JABP - Just A Bump Plugin](https://www.question2answer.org/qa/31264) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Allows users to bump questions sending them to the top of the All activity section. - [Paid] [TUB - Temporary User Block](https://www.question2answer.org/qa/73008) by [pupi1985](https://www.question2answer.org/qa/user/pupi1985). Allows users to be blocked for a period of time and then be automatically unblocked. @@ -216,4 +246,4 @@ To install a plugin (requires Q2A 1.3 or later), place its directory in Q2A's `q - [Comment Voting Plugin](https://github.com/NoahY/q2a-comment-voting) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows comments to be voted on, similarly to questions and answers. - [Question Closing](https://github.com/NoahY/q2a-close) by [NoahY](http://www.question2answer.org/qa/user/NoahY). Allows questions to be closed in Q2A 1.4.x. -Click for documentation on [creating Q2A plugins](/plugins/) (requires PHP programming). +Click for documentation on [creating Q2A plugins]({{ site.baseurl }}/plugins/) (requires PHP programming). diff --git a/addons/themes.md b/addons/themes.md index 3ea3c67..5308b2f 100644 --- a/addons/themes.md +++ b/addons/themes.md @@ -2,12 +2,19 @@ layout: page menu: addons title: "Question2Answer Add-ons - Themes" +slug: addons-themes --- # Question2Answer Themes To install a theme, place its directory in Q2A's `qa-theme` directory, then open the General section of the Admin panel and choose the theme from the menu provided. **Many good themes can be found at [Q2A service providers](/services/)**. Below is a list of other recently updated themes: +> Note: If a theme is marked as "Inactive" or "Unknown", it doesn't necessarily mean it's broken or unsupported. Some plugins are simply stable and don’t require frequent updates. +> +> For better compatibility insight, check the "Tested with" label. This shows which version of Q2A the theme has been verified to work with by the author, maintainer, or contributors. + +## Free Themes + - [MayroPro](https://github.com/MominRaza/MayroPro) (A Google Material Design Theme with Dark Mode, RTL, PWA Support) by [Momin Raza](https://mominraza.github.io). - [Blog Theme](https://github.com/ostack/qa-ostack-blog-theme) by [ZhaoGuangyue](https://www.linkedin.com/in/%E5%85%89%E8%B7%83-%E8%B5%B5-b58234146) based on SnowFlat. [Demo](https://www.ostack.cn). This theme can show pictures and content in question lists, to make the Q2A site look like a blog. - [FatSnowFlat](https://github.com/ostack/qa-FatSnowFlat-theme) by [ZhaoGuangyue](https://www.linkedin.com/in/%E5%85%89%E8%B7%83-%E8%B5%B5-b58234146) based on SnowFlat. [Demo](https://www.ostack.cn). This theme can show pictures and content in question lists. @@ -30,9 +37,12 @@ To install a theme, place its directory in Q2A's `qa-theme` directory, then open - [Twenty Eleven](http://devmx.de/en/themes/twentyeleven-fur-q2a) by [Maximilian Narr](http://devmx.de/). For use with the WordPress theme of the same name. - [TwentyTwelve](https://github.com/q2a-projects/Q2A-TwentyTwelve) by [Towhidn](https://github.com/q2a-projects). Based on WordPress default theme, TwentyTwelve. - [Twitter Bootstrap](https://github.com/harshjv/q2a-bootstrap) by [Harsh J. Vakharia](http://twitter.com/harshjv). For Q2A 1.5.3 only, since it heavily modifies the core to work with [Bootstrap](https://github.com/twitter/bootstrap). + +## Paid Themes + - [Paid] [Polaris theme](https://rxchun.github.io/shop/polaris/) by [Chun](https://www.question2answer.org/qa/user/gold-developer). Polaris is a carefully thought Material Design theme, Ranking all 100's on Google PageSpeed for Performance, Structure, Best Practices & SEO. Mobile App like theme with Dark Mode toggle. RTL ready and supports [plugins](https://www.question2answer.org/qa/102051/premium-theme-polaris-current-v2-14). - [Paid] [AVEN theme](https://rxchun.github.io/shop/aven/) by [Chun](https://www.question2answer.org/qa/user/gold-developer). Shape shifter. Blog type of theme with thumbnail switch. RTL ready. - [Paid] [Frapuchino theme](https://rxchun.github.io/shop/frapuchino/) by [Chun](https://www.question2answer.org/qa/user/gold-developer). Shape shifter. Blog type of theme with thumbnail switch. RTL ready. - [Paid] [Legacy theme](https://rxchun.github.io/shop/legacy/) by [Chun](https://www.question2answer.org/qa/user/gold-developer). Fast, Simple, Material Design theme with inbuilt support for Q2A Blog Tool and other plugins. RTL ready. -You can also [create your own themes](/themes/) using CSS only, or (optionally) [modify the HTML code](/themes/#creating-an-advanced-theme-for-question2answer). +You can also [create your own themes]({{ site.baseurl }}/themes/) using CSS only, or (optionally) [modify the HTML code]({{ site.baseurl }}/themes/#creating-an-advanced-theme-for-question2answer). diff --git a/addons/translations-old.md b/addons/translations-old.md index d7bbe83..2992ebb 100644 --- a/addons/translations-old.md +++ b/addons/translations-old.md @@ -2,6 +2,7 @@ layout: page menu: addons title: "Question2Answer - old language packs" +slug: addons-translate-old --- # Question2Answer old language files diff --git a/addons/translations.md b/addons/translations.md index 6f1b66a..dc65b54 100644 --- a/addons/translations.md +++ b/addons/translations.md @@ -2,16 +2,16 @@ layout: page menu: addons title: "Question2Answer - Add-ons - Language files" +slug: addons-translate --- # Question2Answer Language Files -The language files below are marked by the corresponding Question2Answer version. You can safely install a language file from a different version, and [update it with the missing phrases](/translate/). To install a language, place its directory (such as `fr` or `ru`) in Q2A's `qa-lang` directory, then open the General section of the Admin panel and choose the language from the menu provided. +The language files below are marked by the corresponding Question2Answer version. You can safely install a language file from a different version, and [update it with the missing phrases]({{ site.baseurl }}/translate/). To install a language, place its directory (such as `fr` or `ru`) in Q2A's `qa-lang` directory, then open the General section of the Admin panel and choose the language from the menu provided. ## Q2A 1.8 - [Q2A 1.8.x - Arabic (العربية)](https://github.com/mbassiouny33/q2a-arabic-translation) by [Mohamed Bassiouny](https://mohamedh.me/) based on [this](http://www.mediafire.com/file/j33or1rf9z6owjn/ar.zip) by Musab Alqaiduh @ [Soalwjwab](https://soalwjwab.com/). -- [Q2A 1.8.x - Brazilian Portuguese (Português)](http://www.question2answer.org/third-party/question2answer-1.8-language-pt-BR.zip) by [Pergunte Direito](http://www.perguntedireito.com.br/). - [Q2A 1.8.x - Chinese Simplified (简体中文)](https://github.com/yinhongbo/q2a-lang-cn) by Hongbo Yin. - [Q2A 1.8.x - Danish (Dansk)](https://github.com/ejvindh/q2a-da) by [Ejvind Hansen](http://ejvindh.net/en). - [Q2A 1.8.x - French (Français)](https://github.com/mrflos/q2a-lang-fr) by Olivier Seree, Pierre-Yves Aillet, Florian Schmitt, Grégoire Barré and Guillaume Turri. @@ -24,6 +24,8 @@ The language files below are marked by the corresponding Question2Answer version - [Q2A 1.8.x - Kurdish (Kurmancî)](https://github.com/brznbrzn/q2a-Kurdish-Lang-Latine-translation) by Berzan @ [Pirsname](http://www.pirsname.com/). - [Q2A 1.8.x - Persian (فارسی)](https://github.com/shamio/Q2A-Farsi) by [DinoTechno](https://dinotechno.com/). - [Q2A 1.8.x - Polish (Polski)](https://github.com/PELock/Question2Answer) by Bartosz Wojcik @ [PELock](https://www.pelock.com). +- [Q2A 1.8.x - Portuguese - Brazil (Português pt-BR)](http://www.question2answer.org/third-party/question2answer-1.8-language-pt-BR.zip) by [Pergunte Direito](http://www.perguntedireito.com.br/). +- [Q2A 1.8.x - Portuguese - Portugal (Português pt-PT)](https://github.com/rxchun/q2a-lang-pt-PT) by [Chun](https://rxchun.github.io/?ref=q2a-docs-translation). - [Q2A 1.8.x - Russian (Русский)](https://github.com/Dennwer/Q2A-russian-translation) by Dennwer @ [Вопрос – Ответ](https://abees.ru/). Also: [Russian](https://github.com/ferasinka/q2a-lang-ru) by Andrey K. @ [Роборобо Android Q&A](http://roborobo.ru/). - [Q2A 1.8.x - Serbian (srpski)](https://github.com/stefanmm/Q2A-serbian-translation) by Stefan Marjanov @ [Saznaj Novo](http://saznajnovo.com/). - [Q2A 1.8.x - Spanish - Argentina (Español)](https://github.com/pupi1985/q2a-spanish-translation) by Gabriel Zanetti. @@ -35,7 +37,6 @@ The language files below are marked by the corresponding Question2Answer version ## Q2A 1.7 - [Q2A 1.7.x - Arabic (العربية)](https://github.com/pupi1985/q2a-arabic-translation) by Tariq Ahmed. -- [Q2A 1.7.x - Brazilian Portuguese (Português)](http://www.question2answer.org/third-party/question2answer-1.7-language-pt-BR.zip) by [Pergunte Direito](http://www.perguntedireito.com.br/). - [Q2A 1.7.x - Bulgarian (Български)](https://github.com/pazoff/q2a-lang-bg) by Plamen Vatev(Pazoff). - [Q2A 1.7.x - Catalan (Català)](https://github.com/pau-minoves/q2a-catalan-translation) by Lluís Minoves. - [Q2A 1.7.x - Chinese Simplified (简体中文)](http://androidren.com/download/qa_lang/zh1_7_x.zip) by Fish, updated by forlong401 @ [Androidren](http://androidren.com/). @@ -53,7 +54,8 @@ The language files below are marked by the corresponding Question2Answer version - [Q2A 1.7.x - Lithuanian (lietuvių)](http://www.question2answer.org/third-party/question2answer-1.7-language-lt.zip) by Kestas. - [Q2A 1.7.x - Persian (فارسی)](http://question2answer-farsi.com/files/language/Fa-1.7.zip) by Ali Bakhshi ilani @ [Question2Answer Farsi](http://question2answer-farsi.com/). Also: Jalali Dates, Magic Words plugins. - [Q2A 1.7.x - Polish (Polski)](https://github.com/PELock/Question2Answer) by Bartosz Wojcik @ [PELock](https://www.pelock.com). -- [Q2A 1.7.x - Portuguese (Português)](http://english-ingles.com/q2a-portuguese-pt_PT-translation.zip) by Tiago Marcelo @ [English Ingles](http://english-ingles.com/). +- [Q2A 1.7.x - Portuguese - Brazil (Português)](http://www.question2answer.org/third-party/question2answer-1.7-language-pt-BR.zip) by [Pergunte Direito](http://www.perguntedireito.com.br/). +- [Q2A 1.7.x - Portuguese - Portugal (Português)](http://english-ingles.com/q2a-portuguese-pt_PT-translation.zip) by Tiago Marcelo @ [English Ingles](http://english-ingles.com/). - [Q2A 1.7.x - Russian (Русский)](https://github.com/ferasinka/q2a-lang-ru) by Andrey K. @ [Роборобо Android Q&A](http://roborobo.ru/). - [Q2A 1.7.x - Slovak (Slovenčina)](http://www.question2answer.org/third-party/question2answer-1.7-language-sk.zip) by Boris Sipos. - [Q2A 1.7.x - Spanish - Argentina (Español)](https://github.com/pupi1985/q2a-spanish-translation) by Gabriel Zanetti. @@ -67,7 +69,6 @@ The language files below are marked by the corresponding Question2Answer version - [Q2A 1.6.x - Arabic (العربية)](http://www.question2answer.org/third-party/question2answer-1.6-language-ar.zip) by Tariq Ahmed. - [Q2A 1.6.x - Basque (Euskara)](https://github.com/alex18kr/Q2A-Euskara-Basque) by Alexander Gonzalo de Sá. Place in a directory named `eu` inside `qa-lang` and add the line `'eu' => 'Basque - Euskara',` to `qa_admin_language_options()` - [Q2A 1.6.x - Bengali (বাংলা)](http://www.question2answer.org/third-party/question2answer-1.6-language-bn.zip) by [Shubhra Prakash Paul](http://shuvro.wordpress.com/). -- [Q2A 1.6.x - Brazilian Portuguese (Português)](http://www.question2answer.org/third-party/question2answer-1.6-language-pt-BR.zip) by [Pergunte Direito](http://www.perguntedireito.com.br/). - [Q2A 1.6.x - Bulgarian (Български)](http://0xffffffff.com/?attachment_id=76) by Nikolay Hamov. - [Q2A 1.6.x - Chinese Simplified (简体中文)](http://www.question2answer.org/third-party/question2answer-1.6-language-zh.zip) by Fish. - [Q2A 1.6.x - Chinese Traditional (繁體中文)](http://www.question2answer.org/third-party/question2answer-1.6-language-zh-TW.zip) by Joe Liu. @@ -82,6 +83,7 @@ The language files below are marked by the corresponding Question2Answer version - [Q2A 1.6.x - Italian (Italiano)](http://opzionibinarie1.altervista.org/qa-lang/it_1_6_2.rar) by Carlo @ [Oracle FAQ](http://oraclefaq.altervista.org/). - [Q2A 1.6.x - Persian (فارسی)](http://question2answer-farsi.com/files/language/fa.zip) by Ali Bakhshi ilani @ [Question2Answer Farsi](http://question2answer-farsi.com/). Also: Jalali Dates, Magic Words plugins. - [Q2A 1.6.x - Polish (Polski)](http://hoek.pl/pliki/q2a-pl.zip) by [Hoek](http://hoek.pl/). +- [Q2A 1.6.x - Portuguese - Brazil (Português)](http://www.question2answer.org/third-party/question2answer-1.6-language-pt-BR.zip) by [Pergunte Direito](http://www.perguntedireito.com.br/). - [Q2A 1.6.x - Russian (Русский)](https://github.com/ferasinka/q2a-lang-ru) by Andrey K. @ [Роборобо Android Q&A](http://roborobo.ru/). - [Q2A 1.6.x - Spanish (Español)](https://github.com/pupi1985/q2a-spanish-translation) by Ronald @ [Preguntas y Respuestas](http://www.ppyrr.com/), updated by Sergio Navarrete Suárez @ [Universidad Distrital FJC](http://www.udistrital.edu.co/) and Gabriel Zanetti. - [Q2A 1.6.x - Swedish (Svenska)](http://www.vilkenapp.se/q2a-files/q2a_1.6_swedish_sv_latest.zip) by Anders Hellman @ [VilkenApp.se](http://www.vilkenapp.se/). @@ -89,6 +91,6 @@ The language files below are marked by the corresponding Question2Answer version - [Q2A 1.6.x - Ukrainian (Українська)](http://sourceforge.net/projects/q2a-lang-uk/) by Andriy Bokiy. - [Q2A 1.6.x - Vietnamese (Tiếng Việt)](http://annguyenco.com/hoidap/vi-qa-lang.zip) by [AnNguyenCo](http://www.annguyenco.com). Also: [Updated version](https://www.dropbox.com/s/z1gzuow0rz4rkyu/vi.zip?dl=0) by [NTHQ Team](https://namgivu.wordpress.com/2015/01/09/vietnamese-translation-for-question2answer-website/). -_View [older language files](/addons/translations-old/)._ +_View [older language files]({{ site.baseurl }}/addons/translations-old/)._ -If your language is not listed, or is out-of-date, you can [create or update language files](/translate/) using a text editor. +If your language is not listed, or is out-of-date, you can [create or update language files]({{ site.baseurl }}/translate/) using a text editor. diff --git a/code/external.md b/code/external.md index e0b2f5f..5eb7901 100644 --- a/code/external.md +++ b/code/external.md @@ -2,11 +2,12 @@ layout: page menu: code title: "Question2Answer - Developers - External Access" +slug: code-external --- # Accessing Question2Answer from external PHP code -Question2Answer provides a self-contained environment for your Q&A site. However you may wish to access parts of Q2A from other PHP code running on your server, e.g. to access the Q2A database, check if a Q2A user is logged in, or call [other functions](/code/functions/). +Question2Answer provides a self-contained environment for your Q&A site. However you may wish to access parts of Q2A from other PHP code running on your server, e.g. to access the Q2A database, check if a Q2A user is logged in, or call [other functions]({{ site.baseurl }}/code/functions/). To access Q2A 1.3.2 or later from an external script, simply `require_once` the file `qa-include/qa-base.php` from Q2A's directory, along with any other Q2A files containing functions you need. You can then freely call any of the functions defined within these files. Each function is documented at the top of the function definition. (Note: Versions of Q2A prior to 1.3.2 also required you to define `QA_BASE_DIR` and call `qa_base_db_connect()` with a failure handler - see [here](http://www.question2answer.org/qa/4583/login-system-outside-q%26a-directory#a4608).) diff --git a/code/functions.md b/code/functions.md index aa6b6e0..9472566 100644 --- a/code/functions.md +++ b/code/functions.md @@ -2,6 +2,7 @@ layout: page menu: code title: "Question2Answer - Developers - Selected Functions" +slug: code-functions --- # Selected functions in Question2Answer @@ -18,7 +19,7 @@ Many of these functions take optional additional parameters which are not shown ## General functions in qa-base.php -- **`qa_exit($reason)`** calls the `shutdown()` method of any installed [process modules](/plugins/modules-process/), passing the supplied `$reason`. Then it terminates execution of the PHP script with PHP's `exit;` command. Requires Q2A 1.5+. +- **`qa_exit($reason)`** calls the `shutdown()` method of any installed [process modules]({{ site.baseurl }}/plugins/modules-process/), passing the supplied `$reason`. Then it terminates execution of the PHP script with PHP's `exit;` command. Requires Q2A 1.5+. - **`qa_fatal_error($message)`** outputs and logs `$message`, then calls `qa_exit('error');` to terminate execution. - **`qa_list_modules($type)`** returns an array containing the names of all installed modules of type `$type`. - **`qa_load_module($type, $name)`** returns an object belonging to the class defined in module `$name` of type `$type`, or `null` if it cannot be loaded. You can use this to communicate between multiple modules within a plugin, or between different plugins. Note that multiple calls to `qa_load_module()` with the same `$type` and `$name` will return the same object. @@ -36,7 +37,7 @@ Many of these functions take optional additional parameters which are not shown - **`qa_is_https_probably()`** returns whether the current request is using the HTTPS protocol. It is hard to determine this absolutely. - **`qa_is_human_probably()`** returns `true` if the current request appears to be from a person using a web browser, rather than a search engine bot or automated script. This assessment is based on the HTTP user agent containing a known string such as `MSIE` or `Firefox`. Note that it is perfectly possible for a malicious bot or script to masquerade as a web browser. - **`qa_is_mobile_probably()`** returns `true` if the current request appears to be from a mobile phone. This assessment is based on the presence of mobile HTTP headers or the HTTP user agent containing a mobile identifying string. Requires Q2A 1.5+. -- **`qa_lang($identifier)`** and **`qa_lang_html($identifier)`** return a localized language phrase from the appropriate `qa-lang-*.php` file. For example, `qa_lang('main/cancel_button')` would return the phrase with key `'cancel_button'` from the file `qa-lang-main.php`. The phrase returned by `qa_lang_html()` is escaped for output in HTML. From Q2A 1.5+, language files can also be [registered by plugins](/plugins/) and then accessed via these functions. +- **`qa_lang($identifier)`** and **`qa_lang_html($identifier)`** return a localized language phrase from the appropriate `qa-lang-*.php` file. For example, `qa_lang('main/cancel_button')` would return the phrase with key `'cancel_button'` from the file `qa-lang-main.php`. The phrase returned by `qa_lang_html()` is escaped for output in HTML. From Q2A 1.5+, language files can also be [registered by plugins]({{ site.baseurl }}/plugins/) and then accessed via these functions. - **`qa_path_to_root()`** returns the URL to the root of the Q2A site, relative to the currently requested page. Requires Q2A 1.5+. - **`qa_path($request)`** returns the URL for Q2A page `$request`, relative to the currently requested page. You can also call **`qa_path($request, $params)`** to add GET-style parameters to the URL, where `$params` is an array of parameter name `=>` parameter value, not yet urlencoded. **To ensure compatibility with different Q2A URL structures, please use this (or a related `qa_path_*()` function to build URLs instead of hard-coding their structure.** - **`qa_path_html($request)`** and **`qa_path_html($request, $params)`** return the URL for Q2A page `$request` (with optional `$params`), relative to the currently requested page, escaped for output in HTML. Usage example: @@ -46,7 +47,7 @@ Many of these functions take optional additional parameters which are not shown - **`qa_q_path($questionid, $title, $absolute, $showtype, $showid)`** and **`qa_q_path_html(...)`** return the URL for question `$questionid` which has `$title` as its title. If `$absolute` is `true`, this will be an absolute URL, otherwise it will be relative to the currently requested page. To link to a particular answer or comment within that question page, pass `'A'` or `'C'` as the `$showtype` and the `postid` of the answer or comment in `$showid`. Otherwise, pass `null` or omit these last two parameters. The URL returned by `qa_q_path_html()` is escaped for output in HTML. Requires Q2A 1.5+. - **`qa_self_html()`** returns the relative URL for the current Q2A page, preserving URL parameters, escaped for output in HTML. It is particularly useful for creating form tags, e.g. `echo '
    ';` - **`qa_redirect($request)`** and **`qa_redirect($request, $params)`** perform an HTTP redirect to a Q2A page, specified in the same way as the parameters to `qa_path()`. -- **`qa_redirect_raw($url)`** performs an HTTP redirect to `$url`, without processing the URL in any way. Generally you should use `qa_redirect()` however this function can be useful for [login modules](/plugins/modules-login/). +- **`qa_redirect_raw($url)`** performs an HTTP redirect to `$url`, without processing the URL in any way. Generally you should use `qa_redirect()` however this function can be useful for [login modules]({{ site.baseurl }}/plugins/modules-login/). - **`qa_retrieve_url($url)`** returns the content of remote `$url`, using PHP's `file_get_contents()` or curl functions. - **`qa_opt($name)`** gets the value of the option labelled `$name` from Q2A's internal options storage. - **`qa_opt($name, $value)`** sets the option labelled `$name` to `$value` in Q2A's internal options storage. To prevent interference with Q2A or other plugins, your options should be named using a prefix which is unique to your plugin. Do not use this to store large pieces of content, since all options are retrieved for every Q2A page request - instead, look at `app/blobs.php`. @@ -87,7 +88,7 @@ Many of these functions take optional additional parameters which are not shown Note that all `qa_post_...()` functions will send the appropriate email notifications and event reports, as well as update database indexes and counts. This can be prevented with the `qa_suspend...()` functions, described elsewhere on this page. -- **`qa_post_create($type, $parentpostid, $title, $content, $format, $categoryid, $tags, $userid)`** creates a new post in the database, and returns its `postid`. Set `$type` to `'Q'` for a new question, `'A'` for an answer, or `'C'` for a comment. To queue the post for moderation (requires Q2A 1.5+), set `$type` to `'Q_QUEUED'`, `'A_QUEUED'`, or `'C_QUEUED'`. For questions, set `$parentpostid` to the `postid` of the answer to which the question is related, or `null` if (as in most cases) the question is not related to an answer. For answers, set `$parentpostid` to the `postid` of the question being answered. For comments, set `$parentpostid` to the `postid` of the question or answer to which the comment relates. The `$content` and `$format` parameters go together - if `$format` is `''` then `$content` should be in plain UTF-8 text, and if `$format` is `'html'` then `$content` should be in UTF-8 HTML. Other values of `$format` may be allowed if an appropriate [viewer module](/plugins/modules-viewer/) is installed. The `$title`, `$categoryid` and `$tags` parameters are only relevant when creating a question - `$tags` can either be an array of tags, or a string of tags separated by commas. The new post will be assigned to `$userid` if it is not `null`, otherwise it will be anonymous. Additional optional parameters set notification, extra question fields and names on anonymous posts. +- **`qa_post_create($type, $parentpostid, $title, $content, $format, $categoryid, $tags, $userid)`** creates a new post in the database, and returns its `postid`. Set `$type` to `'Q'` for a new question, `'A'` for an answer, or `'C'` for a comment. To queue the post for moderation (requires Q2A 1.5+), set `$type` to `'Q_QUEUED'`, `'A_QUEUED'`, or `'C_QUEUED'`. For questions, set `$parentpostid` to the `postid` of the answer to which the question is related, or `null` if (as in most cases) the question is not related to an answer. For answers, set `$parentpostid` to the `postid` of the question being answered. For comments, set `$parentpostid` to the `postid` of the question or answer to which the comment relates. The `$content` and `$format` parameters go together - if `$format` is `''` then `$content` should be in plain UTF-8 text, and if `$format` is `'html'` then `$content` should be in UTF-8 HTML. Other values of `$format` may be allowed if an appropriate [viewer module]({{ site.baseurl }}/plugins/modules-viewer/) is installed. The `$title`, `$categoryid` and `$tags` parameters are only relevant when creating a question - `$tags` can either be an array of tags, or a string of tags separated by commas. The new post will be assigned to `$userid` if it is not `null`, otherwise it will be anonymous. Additional optional parameters set notification, extra question fields and names on anonymous posts. - **`qa_post_set_content($postid, $title, $content, $format, $tags)`** changes the data stored for post `$postid` based on any of the `$title`, `$content`, `$format` and `$tags` parameters passed which are not `null`. The meaning of these parameters is the same as for `qa_post_create()` above. Additional optional parameters allow changes to post notification, extra question fields, names on anonymous posts and can identify the user who made the change. - **`qa_post_set_category($postid, $categoryid)`** changes the category of `$postid` to `$categoryid`. The category of all related posts (shown together on the same question page) will also be changed. - **`qa_post_set_selchildid($questionid, $answerid)`** sets the selected best answer of `$questionid` to `$answerid` (or to none if `$answerid` is `null`). diff --git a/code/structure.md b/code/structure.md index 8f03ff4..c690ba7 100644 --- a/code/structure.md +++ b/code/structure.md @@ -2,6 +2,7 @@ layout: page menu: code title: "Question2Answer - Developers - Q2A code structure" +slug: code-structure --- # Question2Answer application structure @@ -23,7 +24,7 @@ All HTTP requests for Q2A are routed through the root `index.php` file. This fil For the latter four types above, we include `qa-include/qa-base.php` which initializes the PHP environment, various constants and settings, and then connects to the database. It also defines an autoloader (from v1.7+) which automatically loads core classes of a specific format: -1. From Q2A 1.9 namespaces are used. The main core namespace is `Q2A` which maps to the `qa-src/` directory. So a class of the form `\Q2A\Storage\FileCacheDriver` will automatically load the file `qa-src/Storage/FileCacheDriver.php`. See the [coding style](/contribute/coding-style/#new-autoloaded-classes) page for full details. +1. From Q2A 1.9 namespaces are used. The main core namespace is `Q2A` which maps to the `qa-src/` directory. So a class of the form `\Q2A\Storage\FileCacheDriver` will automatically load the file `qa-src/Storage/FileCacheDriver.php`. See the [coding style]({{ site.baseurl }}/contribute/coding-style/#new-autoloaded-classes) page for full details. 2. In Q2A 1.7-1.8, classes of the form `Q2A_Util_Usage` map to files in the `qa-include/Q2A/` directory, e.g. `qa-include/Q2A/Util/Usage.php`. These are being phased out in favor of namespaces. Here we "normalize" the request, which converts the URL from one of multiple formats (parameters or SEO-friendly) into a standard format such as `/activity` or `/question/1234/title`. diff --git a/contribute/coding-style.md b/contribute/coding-style.md index 2549366..a73d691 100644 --- a/contribute/coding-style.md +++ b/contribute/coding-style.md @@ -2,6 +2,7 @@ layout: page menu: contribute title: "Question2Answer Coding Style guidelines" +slug: contribute-coding-style --- # Question2Answer Coding Style guidelines diff --git a/contribute/docs.md b/contribute/docs.md index 61811fd..1f94c15 100644 --- a/contribute/docs.md +++ b/contribute/docs.md @@ -2,6 +2,7 @@ layout: page menu: contribute title: "Question2Answer Jekyll docs" +slug: contribute-docs --- # Contributing to the Q2A documentation diff --git a/contribute/index.md b/contribute/index.md index ddb9d85..9cf378b 100644 --- a/contribute/index.md +++ b/contribute/index.md @@ -2,6 +2,7 @@ layout: page menu: contribute title: "Contribute" +slug: contribute --- # Contributing to Question2Answer diff --git a/contribute/unit-tests.md b/contribute/unit-tests.md index 085b620..70cbdfd 100644 --- a/contribute/unit-tests.md +++ b/contribute/unit-tests.md @@ -2,6 +2,7 @@ layout: page menu: contribute title: "Question2Answer unit test guidelines" +slug: contribute-unit-tests --- # Writing unit tests for Question2Answer diff --git a/css/styles.css b/css/styles.css new file mode 100644 index 0000000..7a49b2d --- /dev/null +++ b/css/styles.css @@ -0,0 +1,1373 @@ +/* ================== + Base styles +================== */ + +/* Colors: +Orange = #ff773d +Dark orange = #ff6b2b +*/ + +* { + box-sizing: border-box; +} + +html { + scroll-padding-top: 90px; +} + +body { + margin: 0; + padding: 0; + font: 400 16px/24px Roboto,sans-serif; + -moz-osx-font-smoothing: grayscale; + -webkit-font-smoothing: antialiased; + color: #424242; + /* background-color: #f8f8f8; */ + background-color: #ffffff; + text-align: left; +} + +a, a:visited { + text-decoration: none; + color: #ff6b2b; +} + +a:hover, a:active { + color: #ff6b2b; +} + +.page-container a:hover, +.footer a:hover { + text-decoration: underline; +} + + +h1, h2, h3 { + font-weight: 500; +} + +/* +h1, h2, h3, h4, h5, h6 { + color: #424242; +} + +h1 { + font-size: 2rem; + line-height: 2.5rem; + margin: 0 0 .5rem; +} + +h2 { + font-size: 1.5rem; + line-height: 2rem; + margin: 2rem 0 .5rem; +} + +h3 { + font-size: 1.25rem; + font-weight: 500; + line-height: 1.75rem; + margin: 1.5rem 0 .5rem; +} + +h4 { + font-size: 1rem; + font-weight: 500; + line-height: 1.5rem; + margin: 1.25rem 0 .25rem; +} + +h5 { + font-size: .875rem; + font-weight: inherit; + line-height: 1.5rem; + margin: 1rem 0 .25rem; +} +*/ + +ul, ol { + padding-left: 1.8rem; + margin-left: 0; + margin-bottom: 2em; +} + +img { + max-width: 100%; + height: auto; +} + +code, pre { + background-color: #eeeeee; + font-family: "Menlo", "Consolas", "Monaco", "Ubuntu Mono", "Andale Mono", "Bitstream Vera Sans Mono", monospace; + font-size: 13px; +} + +/* inline code */ +code { + word-wrap: break-word; /* old syntax (IE/Edge) */ + overflow-wrap: anywhere; + word-break: break-word; + padding: 2px 4px; + border-radius: 3px; +} + +/* block code */ +pre { + display: grid; + width: 100%; + background-color: #f6f6f6; + overflow: hidden; + border-radius: 6px; + font-size: .8125rem; + font-family: ui-monospace, "Cascadia Mono", "Segoe UI Mono", "Liberation Mono", Menlo, Monaco, Consolas, monospace; + line-height: 1.30769231; +} +pre code { + background-color: #f6f6f6; + padding: 0; + max-height: 600px; + color: inherit; + font-family: inherit; + tab-size: 4; + font-size: 13px; + overflow: auto; + padding: 12px; +} + +blockquote { + background-color: #fff9e1; + border-left: 3px solid #ffef95; + padding: .1rem 1rem; + margin: 0; +} + +/* =================== + PREDEFINED CLASSES +======================= */ + +.no-select, .noSelect, .noselect { + -webkit-tap-highlight-color: transparent; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.flex-row { + display: flex; + flex-direction: row; +} +.flex-item { + display: flex; + justify-content: flex-start; + align-items: center; + flex-wrap: nowrap; +} +.not-flex-middle { + width: 25%; + padding: 0 2rem; +} + +.display-none, .displayNone { + display: none; +} + +.docs-svg { + pointer-events: none; +} + +.docs-svg path { + fill: inherit; +} + +.docs-caret { + position: relative; + display: inline-block; + width: 18px; + height: 18px; + vertical-align: middle; + pointer-events: none; +} +.docs-caret:before { + content: ""; + display: inline-block; + width: 20%; + height: 20%; + border-right: 2px solid; + border-bottom: 2px solid; + position: absolute; + top: 30%; + left: 50%; + transform: translateX(-50%) translateY(-30%) rotate(45deg); +} + +.nav-item:focus .docs-caret:before { + width: 40%; + border-right: none; + transform: translateX(-50%) translateY(-30%) rotate(0deg); +} + +.darkpane, .darkPane, .dark-pane { + position: fixed; + background-color: #000; + top: 0; + left: 0; + right: 0; + bottom: 0; + z-index: 1000; + opacity: .5; + z-index: 1; + opacity: 0; + visibility: hidden; + pointer-events: none; + transition: opacity .25s ease; +} +.darkpane.active, .darkPane.active, .dark-pane.active { + opacity: .5; + visibility: visible; + pointer-events: auto; + transition: opacity .25s ease; +} + +.clear, .clearFloat, .clear-float { + clear: both; +} + +.nav-container .nav > li { + transition: opacity .05s linear; +} +.obfuscate { + opacity: .5; +} + + +/* ================== + LAYOUT +================== */ + +body.page { + margin-top: 66px; +} + +.container { + max-width: 1200px; +} + +.wave-container { + position: absolute; + top: 0; + left: 0; + z-index: -1; + width: 100%; + height: 170px; + background: transparent url(../images/wave-combo.svg) 20% top / cover no-repeat; +} + +.wave-container .docs-svg path { + fill: revert-layer; +} + +.header { + position: fixed; + top: 0; + left: 0; + right: 0; + z-index: 999999; + width: 100%; + height: 66px; + padding: 0 2rem; + transition: box-shadow .218s, background-color .218s; +} +.header.sticky { + /* background-color: #ff773d; */ + background-color: #ffffff; + box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); + color: #3c4043; + fill: #3c4043; +} + +body:not(.template-homepage) .header { + background-color: #ffffff; + border-bottom: 1px solid rgb(0 0 0 / 10%); +} + +.template-homepage .header:not(.sticky) { + color: #ffffff; + fill: #ffffff; +} + +/* Necessary to cap the width, without afecting background fill color */ +.header-container { + height: 66px; + padding: 0 2rem; + max-width: 1500px; + margin: 0 auto; +} + + +#main-nav-trigger { + margin-right: 1rem; + cursor: pointer; +} + +.logo-container { + padding-right: 2rem; +} +.header-logo { + display: inline-flex; + max-width: 225px; +} + +.header.sticky .header-logo .docs-svg path, +body:not(.template-homepage) .header .header-logo .docs-svg path { + fill: revert-layer; +} + +.header-logo .docs-svg, .logo-img { + width: 100%; + max-width: 225px; + height: auto; +} + +body:not(.template-homepage) .header .white-logo { + display: none; +} + +.template-homepage .normal-logo, .template-homepage .header.sticky .white-logo { + display: none; +} +.template-homepage .header.sticky .normal-logo { + display: initial; +} + +.nav-container { + flex-grow: 1; +} + +.nav-container .header-logo { + padding: 1rem; + max-width: 175px; +} + +.nav { + margin: 0; + padding: 0; +} + +.nav li { + display: inline-block; + position: relative; +} +.nav li ul { + color: initial; + fill: initial; +} + +.mega-menu { + width: 100%; +} + +.mega-menu .nav-main .sub-nav-item { + border-radius: 6px; +} + +a.nav-item, .nav-item { + padding: .5rem 1rem; + font-size: .938rem; + font-weight: 500; + line-height: 14px; + color: inherit; + white-space: nowrap; + border-radius: 30px; + cursor: pointer; +} +/* Fix for carrot, dropdown menu */ +.nav-main .nav-item { + padding-right: .5rem; +} +.toggleChildren a, .toggleChildren span { + cursor: pointer; +} + +.nav-item .docs-svg { + height: 22px; + width: 22px; + vertical-align: top; + fill: inherit; +} + +.nav-item:hover .docs-svg { + fill: inherit; +} + +.selected-nav, a.selected-nav, +.nav-item:hover, a.nav-item:hover, +.sub-nav-item:hover, a.sub-nav-item:hover, +.current-dropdown, +.nav-item.current-dropdown { + box-shadow: none; + background-color: #f1f3f4; + color: #3c4043; + fill: #3c4043; +} + +ul.sub-nav { + position: absolute; + top: -6px; + z-index: 1; + margin: 0; + padding: 12px 0; + background-color: #ffffff; + min-width: 100%; + width: max-content; + border-radius: 6px; + box-shadow: 0 2px 10px 0 rgba(0, 0, 0, 0.15); +} + +/* top:-6px; for filters, but top:45px; for a tooltip style for the .header */ +.header ul.sub-nav { + top: 40px; +} +.mega-menu .nav-main:before, .header ul.sub-nav:before { + content: ''; + position: absolute; + left: 30px; + bottom: 100%; + border-bottom: 8px solid #ffffff; + border-left: 8px solid transparent; + border-right: 8px solid transparent; +} +.sub-nav li { + display: block; +} +.sub-nav .sub-nav-item, .sub-nav a.sub-nav-item { + color: #424242; + display: block; + padding: .3rem 1rem; +} + +/* =============== + BREADCRUMBS +=============== */ + +.breadcrumbs { + display: block; + font-size: .875rem; + line-height: 3.5rem; + margin: 0; + padding: 0 1rem; + white-space: nowrap; +} + +.breadcrumb-item { + display: inline-block; +} + +.breadcrumb-item:after { + content: "\e315"; + font-family: 'Material Icons'; + font-style: normal; + vertical-align: middle; + color: inherit; + height: 1.5rem; + width: 1.5rem; + font-size: 150%; + margin: 0 .5rem; + font-weight: initial; +} + +.breadcrumb-item:last-child.breadcrumb-item:after { + display: none; +} + + +/* =============== + MAIN SECTION +================ */ + +.notice-container { + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + z-index: 999999; +} + +.notice { + position: absolute; + top: 50%; + left: 50%; + transform: translateX(-50%) translateY(-50%); + z-index: 1; + background-color: #ffffff; + width: 70%; + max-width: 90vw; + height: 70vh; + overflow: hidden; + border-radius: 12px; +} + +.notice-text, .notice-image { + width: 50%; + height: 100%; + float: right; +} + +.notice-text { + padding: 2rem; + overflow-Y: auto; + max-height: inherit; +} + +.notice-text > :first-child { + padding-top: 0; + margin-top: 0; +} + +.notice-image { + background-image: url(../images/pexels-leeloothefirst-5428824-800.webp); + background-position: center; + background-repeat: no-repeat; + background-size: cover; +} + +.close-notice { + position: absolute; + top: 0; + right: 0; + padding: 1rem; + cursor: pointer; + border-radius: 50px; + transition: background-color .25s ease; +} + +.close-notice:hover { + background-color: rgb(0 0 0 / 10%); +} + +.close-sheet { + position: absolute; + top: 0; + left: 0; + right: 0; + bottom: 0; + z-index: 0; + background-color: rgb(0 0 0 / 50%); +} + +.page-status { + position: fixed; + bottom: 2rem; + left: 50%; + transform: translateX(-50%); + font-size: 13px; + display: flex; + flex-direction: row; + align-items: center; + background-color: rgb(32, 33, 36); + color: #ffffff; + fill: #ffffff; + padding: .6rem 2rem; + border-radius: 6px; + width: max-content; + min-width: 24vw; + max-width: 95%; +} + +.close-page-status { + cursor: pointer; + padding: 4px; + border-radius: 30px; +} + +.close-page-status:hover { + background-color: rgb(255 255 255 / 10%); +} + +.template-addons-themes .page-content blockquote, +.addons-themes .page-content blockquote, +.template-addons-plugins .page-content blockquote, +.addons-plugins .page-content blockquote { + font-size: small; +} + +.page-container { + margin: 0 auto; + max-width: 1200px; +} + +.template-homepage .home-intro-container { + padding: 9rem 2rem 2rem 2rem; +} + +.docs-container { + display: flex; + margin: 0 auto; + max-width: 75.125rem; + padding: 0 1rem; + width: 100%; +} + +.page-content { + align-self: flex-start; + flex: 1; + max-width: 52rem; + padding: 0.8rem 1rem; + border: 1px solid #dadce0; + border-radius: 0.5rem; +} + +.template-addons-plugins .sectionTitle { + margin-top: 3rem; +} +.template-addons-plugins .page-content blockquote ~ .sectionTitle { + margin-top: revert; +} + +#question2answer-plugins ~ ul, #question2answer-themes ~ ul { + list-style: none; + margin: 0; + padding: 0; +} + +#question2answer-plugins ~ ul:not(:nth-last-child(2)), +#question2answer-themes ~ ul:not(:nth-last-child(2)) { + margin-bottom: 3rem; +} + +#question2answer-plugins ~ ul li, +#question2answer-themes ~ ul li { + border-bottom: 1px solid #e0e0e0; + padding: .8rem 1rem; +} + +#question2answer-plugins ~ ul .child-repository, +#question2answer-themes ~ ul .child-repository { + padding-left: 2rem; +} + +.child-repository { + position: relative; +} + +.child-repository:before { + content: ""; + position: absolute; + top: .8rem; + left: 1rem; + bottom: .8rem; + width: 4px; + background-color: rgb(0 0 0 / 10%); +} + +#question2answer-plugins ~ ul li:hover, +#question2answer-themes ~ ul li:hover { + background-color: rgb(0 0 0 / 2%); +} + +#question2answer-plugins ~ ul li a:first-of-type, #question2answer-themes ~ ul li a:first-of-type { + font-weight: bold; +} + +.repository-footer { + display: flex; + margin-top: .2rem; + color: rgb(95, 99, 104); + font-size: 88%; +} + +.rf-item:first-child { + margin-right: 1rem; +} + +.rf-item ~ .rf-item { + margin-left: auto; +} + +.rf-item .docs-svg { + height: auto; + vertical-align: middle; +} + +.tooltip-wrapper { + position: relative; +} + +.tooltip-wrapper:hover .tooltip { + display: initial; +} +.tooltip { + display: none; + position: absolute; + left: 50%; + bottom: 150%; + transform: translateX(-50%); + z-index: 1; + width: 80vw; + max-width: max-content; + margin: 0 auto; + background-color: rgb(0 0 0 / 90%); + color: #fff; + font-size: smaller; + padding: 0.6rem 1rem; + border-radius: 6px; +} + +.rep-date { + display: inline-block; + background-color: #e0e0e0; + margin-inline-start: 4px; + margin-inline-end: 4px; + min-width: 18px; + min-height: 10px; + vertical-align: middle; + border-radius: 30px; +} + +.rep-date-0, .rep-date-1 { + background-color: #18ab60; /* Green */ + color: #ffffff; +} +.rep-date-2 { + background-color: #3498db; /* Blue */ + color: #ffffff; +} +.rep-date-3, .rep-date-4 { + background-color: #ffe252; /* Yellow */ +} +.rep-date-5 { + /* background-color: #e0e0e0; */ /* Grey */ + background-color: #e74c3c; + color: #ffffff; +} +/* +.rep-date-bad { + background-color: #e74c3c; + color: #ffffff; +} +*/ + + +.page-sidebar { + width: 21.125rem; + font-size: 15px; + position: sticky; + top: 66px; + margin: 0; + list-style: none; + max-height: calc(100vh - 66px); + height: max-content; /* Fix for position:sticky stopped being sticky short */ +} + +.docs-nav-title { + position: relative; + margin-top: 0; + padding-left: 2rem; +} +.docs-nav-title:before { + position: absolute; + top: 0; + left: 0; + content: "article"; + height: 1.5rem; + width: 1.5rem; + font: normal 1.5rem 'Material Icons'; + color: #ff773d; +} + +.docs-nav { + padding-left: 1rem; + margin: 0; + list-style: none; + max-height: calc(100vh - 66px - 4rem); + overflow: auto; +} + +.template-addons-plugins .docs-nav, +.template-addons-plugins .docs-nav { + max-height: calc(100vh - 66px - 4rem - 60px); +} + +.docs-nav-item { + padding: .3rem 0 .3rem 2rem; + position: relative; + cursor: pointer; +} + +.docs-nav-item:before { + content: "article"; + font-family: 'Material Icons'; + width: 1.5rem; + height: 1.5rem; + line-height: 1.5rem; + font-size: 150%; + font-weight: initial; + position: absolute; + top: 5px; + left: 0; + color: #ff6b2b; +} + +.docs-nav-item.active { + font-weight: bold; +} + +.docs-nav-q2a-version { + border-top: 1px solid rgb(0 0 0 / 20%); + margin-top: 1rem; + padding: 1rem; + font-style: italic; +} +.docs-nav-q2a-version a { + font-weight: bold; + background-color: rgb(255 107 43 / 20%); + padding: 3px; + border-radius: 3px; + margin: 0 3px; + border: 1px solid rgb(255 255 255 / 0%); + transition: border-color .25s ease; +} +.docs-nav-q2a-version a:hover { + border: 1px solid; +} +.docs-nav-q2a-version .qa-svg { + vertical-align: sub; + width: 18px; + height: 18px; + fill: #ff6b2b; +} + +.jump-top-container { + display: block; + margin: 0 40px; + padding-bottom: 6rem; + position: relative; + text-align: right; +} +.jump-top { + display: flex; + position: absolute; + right: 0; + overflow: hidden; + background-color: #ffffff; + height: 56px; + width: 56px; + font-size: 24px; + align-items: center; + justify-content: center; + border-radius: 50%; + box-shadow: 0 1px 2px 0 rgba(60, 64, 67, .3), 0 1px 3px 1px rgba(60, 64, 67, .15); + transition: background .2s, box-shadow .2s, color .2s; + cursor: pointer; +} +.jump-top.active { + position: fixed; + right: 40px; + bottom: 40px; + box-shadow: 0 2px 3px 0 rgba(60, 64, 67, .3), 0 6px 10px 4px rgba(60, 64, 67, .15); +} + +.jump-top .material-icons { + pointer-events: none; +} + +.footer { + border-top: 1px solid rgb(0 0 0 / 10%); + padding: 0 2rem; +} +.footer-container { + max-width: 1500px; + display: flex; + flex-wrap: wrap; + justify-content: space-between; + gap: 2rem; + padding: 3rem 2rem; + margin: 0 auto; +} +.footer-nav-link { + margin: 0 1rem; +} + +.footer-nav ul { + display: flex; + flex-wrap: wrap; + justify-content: inherit; + margin: 0; + padding: 0; + list-style: none; +} + +.footer-nav ul li { + display: inline; +} + + + +/* ================== + HOMEPAGE +================== */ + +.home-intro { + max-width: 800px; + margin: 0 auto; + text-align: center; + font-size: 1.5rem; + line-height: initial; + font-weight: normal; +} + +.showcase-cols { + display: grid; + grid-template-columns: 1fr; + grid-gap: 2rem; + margin: 2rem auto; + max-width: 1000px; +} + +.card-showcase { + display: flex; + align-items: flex-start; + flex-direction: row; + flex: 1 0 100%; + padding: 1.5rem; + border: 1px solid #dadce0; + border-radius: 0.5rem; +} + +.card-showcase-icon { + display: flex; + position: relative; + overflow: hidden; + flex: 0 0 50px; + align-items: center; + justify-content: center; + border-radius: 52px; + width: 50px; + height: 50px; + background-color: #ff773d; + color: #ffffff; + font-size: 2rem; + margin-right: 1rem; +} +.card-showcase-icon:after { + content: ""; + position: absolute; + left: 50%; + width: 50%; + height: 100%; + background-color: #000000; + opacity: 0.04; +} +.card-showcase-icon .material-icons { + font-size: inherit; +} + +.card-showcase-info h4 { + margin: 0; +} +.card-showcase-info p, .card-showcase-info ul { + color: #707070; +} +.card-showcase-info ul { + padding-left: 1.25rem; +} + +.text-small { + font-size: 0.85rem; +} + + +/* =============== + DOCS PAGES +=============== */ + +a[href*="/releases/question2answer"][href$=".zip"] { + margin-left: 2px; + padding: 0.5rem; + vertical-align: bottom; + border-radius: 6px; + background: #ff773d; + color: #fff; + font-size: 0.75rem; + text-transform: uppercase; +} +a[href*="/releases/question2answer"][href$=".zip"]:active, +a[href*="/releases/question2answer"][href$=".zip"]:hover { + background: #ff6b2b; + text-decoration: none; +} + + +/* =============== + MEDIA QUERIES +================= */ + +@media (min-width: 1500px) { + .wave-container { + height: 200px; + background-size: 100%; + } +} + +@media (min-width: 1024px) { + .mobile-only { + display: none; + } + .nav-main { + position: absolute; + top: 60px; + z-index: 1; + background-color: #ffffff; + padding: 1rem 0; + align-items: unset; + color: #000; + fill: #000; + border-radius: 6px; + box-shadow: 0 2px 10px 0 rgba(0, 0, 0, 0.15); + } + .nav-main .sub-nav { + display: block; + position: initial; + box-shadow: none; + /* + border-top: 1px solid rgb(0 0 0 / 10%); + border-radius: 0; + margin-top: .5rem; + */ + } + .mega-menu .nav-main > li { + margin: 0 0.5rem; + } + .mega-menu .nav-main > li:not(:last-child):after { + content: ""; + width: 1px; + height: 100%; + background-color: rgb(0 0 0 / 10%); + position: absolute; + top: 0; + right: -.5rem; + } + + .mega-menu .nav-main .toggleChildren { + pointer-events: none; + background-color: unset; + } + .mega-menu .nav-main .toggleChildren .docs-caret, + .mega-menu .nav-main .toggleChildren .docs-svg { + display: none; + } + + .footer-nav-link:first-child { + margin-left: 0; + } + +} + +@media (min-width: 800px) { + .page-sidebar-toggle { + display: none; + } + + .page-content { + padding: 3rem; + } + .page-content .sectionTitle:first-child { + margin-top: 0; + } + .page-sidebar { + padding: 2rem 1rem; + } + + .showcase-cols { + grid-template-columns: 1fr 1fr; + } + +} + + +/* ======================== + MEDIA QUERIES MAX-WIDTH +=========================== */ + +@media (max-width: 1120px) { + .footer-container { + justify-content: center; + } +} + +@media (max-width: 1024px) { + .desktop-only { + display: none; + } + + .tooltip { + left: initial; + right: 0; + bottom: 120%; + transform: none; + } + + .header .nav-container { + color: initial; + fill: initial; + } + .header-container, .footer { + padding: 0; + } + .nav-container { + display: block; + position: fixed; + top: 0; + left: 0; + bottom: 0; + z-index: 2; + width: 265px; + max-width: 80%; + background-color: #ffffff; + transform: translateX(-100%); + transition: transform .25s cubic-bezier(.4,0,.2,1); + } + .nav-container.active { + transform: translateX(0%); + } + .nav-container .nav, .mega-menu { + display: block; + } + .nav-container li { + display: block; + } + .nav-main { + border-bottom: 1px solid rgb(0 0 0 / 10%); + padding-bottom: .5rem; + margin-bottom: .5rem; + } + .mega-menu-trigger { + display: none; + } + a.nav-item, .nav-item { + display: block; + width: 100%; + line-height: 24px; + border-radius: 0; + } + .nav-item .docs-svg { + vertical-align: text-bottom; + } + ul.sub-nav { + box-shadow: 0 2px 10px 0 rgb(0 0 0 / 30%); + } + .header ul.sub-nav:after { + content: ""; + position: fixed; + top: 50px; + left: 0; + right: 0; + bottom: 0; + z-index: -1; + height: 100vh; + /* background-color: #fff; */ + opacity: .5; + } + .sub-nav .sub-nav-item, .sub-nav a.sub-nav-item { + line-height: 24px; + padding: .5rem 1rem .5rem 2rem; + border-radius: 0 !important; + font-weight: 500; + } + + .jump-top-container { + padding-bottom: 2rem; + } +} + +@media (max-width: 575px) { + body { + font-size: .85rem; + line-height: 1.4rem; + } + h1, h2, h3, h4, h5, h6 { + line-height: initial; + } + + .header { + padding: 0 1rem; + } + .header-logo { + max-width: 130px; + } + .nav-item:hover .docs-caret:before { + width: 40%; + border-right: none; + transform: translateX(-50%) translateY(-30%) rotate(0deg); + } + .breadcrumbs { + padding: 1rem; + line-height: 1.5rem; + white-space: initial; + border-bottom: 1px solid rgb(0 0 0 / 10%); + } + .breadcrumb-item:after { + height: .5rem; + width: .5rem; + margin: 0; + } + + .template-homepage .home-intro-container { + padding: 7rem 3rem 2rem 3rem; + } + .home-intro { + font-size: .938rem; + } + + .showcase-cols { + grid-gap: 1rem; + margin: 2rem 1rem; + } + .card-showcase { + padding: 1rem .5rem; + } + .card-showcase-icon { + flex: 0 0 35px; + width: 35px; + height: 35px; + font-size: 1rem; + margin-right: .5rem; + } + .card-showcase-info p { + margin-top: .5rem; + } + + .page-content { + border: none; + } + + .notice { + width: 80%; + } + .notice-text, .notice-image { + width: 100%; + float: none; + } + .notice-text { + padding: 1rem; + max-height: calc(70vh - 80px - 1rem); + } + .notice-image { + height: 100px; + } + +} + +@media (max-width: 545px) { + .footer-nav ul li { + width: 50%; + margin: .5rem auto; + text-align: center; + } +} + +@media (max-width: 475px) { + .page-content { + padding: 0; + } + #question2answer-plugins ~ ul:not(:nth-last-child(2)), + #question2answer-themes ~ ul:not(:nth-last-child(2)) { + margin-bottom: 2rem; + } + #question2answer-plugins ~ ul .child-repository, #question2answer-themes ~ ul .child-repository { + padding-left: 1.5rem; + } + .child-repository:before { + left: .5rem; + } + .rep-date-true { + white-space: nowrap; + } + .page-status { + padding: .6rem 1rem; + } + + .rf-item:nth-child(even) { + text-align: right; + } + .rf-item * { + text-align: left; + } +} +@media (max-width: 375px) { + .twbb { + display: block; + font-size: 12px; + margin-right: .5rem; + } +} + + +/* ==================== + Syntax highlighting +======================= */ + +.highlight .hll { background-color: #ffffcc } +.highlight .c { color: #808080 } /* Comment */ +.highlight .err { color: #f00000; background-color: #f0a0a0 } /* Error */ +.highlight .k { color: #008000 } /* Keyword */ +.highlight .o { color: #303030 } /* Operator */ +.highlight .cm { color: #808080 } /* Comment.Multiline */ +.highlight .cp { color: #507090 } /* Comment.Preproc */ +.highlight .c1 { color: #808080 } /* Comment.Single */ +.highlight .cs { color: #cc0000 } /* Comment.Special */ +.highlight .gd { color: #a00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #ff0000 } /* Generic.Error */ +.highlight .gh { color: #000080 } /* Generic.Heading */ +.highlight .gi { color: #00a000 } /* Generic.Inserted */ +.highlight .go { color: #808080 } /* Generic.Output */ +.highlight .gp { color: #c65d09 } /* Generic.Prompt */ +/* .highlight .gs { } */ /* Generic.Strong */ +.highlight .gu { color: #800080 } /* Generic.Subheading */ +.highlight .gt { color: #0040d0 } /* Generic.Traceback */ +.highlight .kc { color: #008000 } /* Keyword.Constant */ +.highlight .kd { color: #008000 } /* Keyword.Declaration */ +.highlight .kn { color: #008000 } /* Keyword.Namespace */ +.highlight .kp { color: #003080 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000 } /* Keyword.Reserved */ +.highlight .kt { color: #303090 } /* Keyword.Type */ +.highlight .m { color: #6000e0 } /* Literal.Number */ +.highlight .s { color: #d04020 } /* Literal.String */ +.highlight .na { color: #0060b0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #b00060 } /* Name.Class */ +.highlight .no { color: #003060 } /* Name.Constant */ +.highlight .nd { color: #505050 } /* Name.Decorator */ +.highlight .ni { color: #800000 } /* Name.Entity */ +.highlight .ne { color: #f00000 } /* Name.Exception */ +.highlight .nf { color: #0060b0 } /* Name.Function */ +.highlight .nl { color: #907000 } /* Name.Label */ +.highlight .nn { color: #0e84b5 } /* Name.Namespace */ +.highlight .nt { color: #007000 } /* Name.Tag */ +.highlight .nv { color: #906030 } /* Name.Variable */ +.highlight .ow { color: #000000 } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #6000e0 } /* Literal.Number.Float */ +.highlight .mh { color: #005080 } /* Literal.Number.Hex */ +.highlight .mi { color: #0000d0 } /* Literal.Number.Integer */ +.highlight .mo { color: #4000e0 } /* Literal.Number.Oct */ +.highlight .sb { color: #d04020 } /* Literal.String.Backtick */ +.highlight .sc { color: #0040d0 } /* Literal.String.Char */ +.highlight .sd { color: #d04020 } /* Literal.String.Doc */ +.highlight .s2 { color: #d04020 } /* Literal.String.Double */ +.highlight .se { color: #606060; } /* Literal.String.Escape */ +.highlight .sh { color: #d04020 } /* Literal.String.Heredoc */ +.highlight .si { color: #d04020 } /* Literal.String.Interpol */ +.highlight .sx { color: #d02000; color: #d04020 } /* Literal.String.Other */ +.highlight .sr { color: #000000; background-color: #fff0ff } /* Literal.String.Regex */ +.highlight .s1 { color: #d04020 } /* Literal.String.Single */ +.highlight .ss { color: #a06000 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #306090 } /* Name.Variable.Class */ +.highlight .vg { color: #d07000 } /* Name.Variable.Global */ +.highlight .vi { color: #3030b0 } /* Name.Variable.Instance */ +.highlight .il { color: #0000d0 } /* Literal.Number.Integer.Long */ diff --git a/images/pexels-leeloothefirst-5428824-800.webp b/images/pexels-leeloothefirst-5428824-800.webp new file mode 100644 index 0000000..ed8a723 Binary files /dev/null and b/images/pexels-leeloothefirst-5428824-800.webp differ diff --git a/images/q2a-icon.svg b/images/q2a-icon.svg new file mode 100644 index 0000000..7fa84c4 --- /dev/null +++ b/images/q2a-icon.svg @@ -0,0 +1 @@ + diff --git a/images/question2answer-logo-350x40.webp b/images/question2answer-logo-350x40.webp new file mode 100644 index 0000000..647e84e Binary files /dev/null and b/images/question2answer-logo-350x40.webp differ diff --git a/images/question2answer-logo-white-350x40.webp b/images/question2answer-logo-white-350x40.webp new file mode 100644 index 0000000..5ecf1e5 Binary files /dev/null and b/images/question2answer-logo-white-350x40.webp differ diff --git a/index.md b/index.md index 64a2b81..d9c2f44 100644 --- a/index.md +++ b/index.md @@ -1,8 +1,12 @@ --- layout: home title: "Question2Answer documentation" +slug: homepage --- -Welcome to the Question2Answer docs! This is a community-focused initiative to improve the documentation for Q2A. The docs contains information about installing and using Q2A, as well as developing themes/plugins and an API reference. +Welcome to the **Question2Answer docs**! +This is a community-focused initiative to improve the documentation for Q2A. -This site is hosted via GitHub Pages, using the Jekyll static site generator. Everyone is welcome to contribute improvements - see [the contributing page](/contribute/docs/) for information about setting up Jekyll locally. +The docs contains information about installing and using Q2A, as well as developing themes/plugins and an API reference. + +This site is hosted via GitHub Pages, using the Jekyll static site generator. Everyone is welcome to contribute improvements - see [the contributing page]({{ site.baseurl }}/contribute/docs/) for information about setting up Jekyll locally. diff --git a/install/htaccess.md b/install/htaccess.md index f7769ba..fc5c13e 100644 --- a/install/htaccess.md +++ b/install/htaccess.md @@ -2,6 +2,7 @@ layout: page menu: install title: "Question2Answer .htaccess file" +slug: install-htaccess --- # Why is my .htaccess file not OK? diff --git a/install/index.md b/install/index.md index ea4717e..af59c7d 100644 --- a/install/index.md +++ b/install/index.md @@ -2,6 +2,7 @@ layout: page menu: install title: "Install Question2Answer" +slug: install --- # Question2Answer takes 5 minutes (or less!) to install. @@ -26,13 +27,13 @@ If you are not sure about this, please check with your web hosting provider. ## Installing Question2Answer for the first time (without single sign-on) -The instructions below are for installing Question2Answer where it manages user accounts and logins for you. If you would like Question2Answer to integrate with your existing user database and account system, see the instructions for [single sign-on](/install/single-sign-on/) installation. From version 1.4, Question2Answer also offers easy [integration with a WordPress 3.x](/install/wordpress/) site and user database. +The instructions below are for installing Question2Answer where it manages user accounts and logins for you. If you would like Question2Answer to integrate with your existing user database and account system, see the instructions for [single sign-on]({{ site.baseurl }}/install/single-sign-on/) installation. From version 1.4, Question2Answer also offers easy [integration with a WordPress 3.x]({{ site.baseurl }}/install/wordpress/) site and user database. 1. Download the [latest version of Question2Answer](https://www.question2answer.org/question2answer-latest.zip) to your computer or web server (also available [on GitHub](https://github.com/q2a/question2answer/tree/master) - make sure to use the master branch for the latest stable version). 2. Unzip the download using a tool such as [WinZip](http://www.winzip.com/) (or `unzip` in the Unix shell). -3. If you want to run a non-English site, check if the appropriate [language file](/addons/) is available. If so, download and install it in the `qa-lang` folder. If not, it's simple to [translate](/translate/) Question2Answer for yourself. +3. If you want to run a non-English site, check if the appropriate [language file]({{ site.baseurl }}/addons/) is available. If so, download and install it in the `qa-lang` folder. If not, it's simple to [translate]({{ site.baseurl }}/translate/) Question2Answer for yourself. 4. Create a MySQL database, and a MySQL user with full permissions for that database. If you're interested, the [privileges](http://dev.mysql.com/doc/mysql/en/privilege-system.html) actually needed are: CREATE, ALTER, DELETE, INSERT, SELECT, UPDATE, LOCK TABLES @@ -53,8 +54,8 @@ The instructions below are for installing Question2Answer where it manages user 10. Follow the on-screen instructions to set up your database and administrator account. That's it! -See also: [Upgrading Question2Answer](/install/upgrade/) +See also: [Upgrading Question2Answer]({{ site.baseurl }}/install/upgrade/) ## Add-Ons -See the [add-ons](/addons/) page for language files, themes and plugins created by Question2Answer users. +See the [add-ons]({{ site.baseurl }}/addons/) page for language files, themes and plugins created by Question2Answer users. diff --git a/install/optimize.md b/install/optimize.md index 10004bb..5f46c4c 100644 --- a/install/optimize.md +++ b/install/optimize.md @@ -2,6 +2,7 @@ layout: page menu: install title: "Question2Answer - Optimization" +slug: install-optimization --- # Optimizing the performance of Question2Answer diff --git a/install/security.md b/install/security.md index 453a83a..cc1849b 100644 --- a/install/security.md +++ b/install/security.md @@ -1,7 +1,8 @@ --- layout: page menu: install -title: "Question2Answer - Optimization" +title: "Question2Answer - Security" +slug: install-security --- # Making Question2Answer extra secure diff --git a/install/single-sign-on.md b/install/single-sign-on.md index 493f9be..8c553af 100644 --- a/install/single-sign-on.md +++ b/install/single-sign-on.md @@ -2,11 +2,12 @@ layout: page menu: install title: "Question2Answer - Single Sign-On Integration" +slug: install-single-sign-on --- # Installing Question2Answer with single sign-on -Question2Answer is designed to integrate with websites which have an existing user database and management system. If your site is running WordPress 3.x, you should follow the instructions for [WordPress integration](/install/wordpress/). To implement single sign-on for other sites, a small amount of PHP programming is required. Please follow the instructions below: +Question2Answer is designed to integrate with websites which have an existing user database and management system. If your site is running WordPress 3.x, you should follow the instructions for [WordPress integration]({{ site.baseurl }}/install/wordpress/). To implement single sign-on for other sites, a small amount of PHP programming is required. Please follow the instructions below: 1. Download the [latest version of Question2Answer](https://github.com/q2a/question2answer/releases) to your computer or web server (also available [on GitHub](https://github.com/q2a/question2answer)). diff --git a/install/upgrade.md b/install/upgrade.md index a2edeb9..8d19234 100644 --- a/install/upgrade.md +++ b/install/upgrade.md @@ -2,11 +2,12 @@ layout: page menu: install title: "Upgrading Question2Answer" +slug: install-upgrade --- # Upgrading to the latest version of Question2Answer -Question2Answer regularly has [new releases](/install/versions/) that fix bugs and add new features. Updating your Q2A site is usually a simple process of uploading the new files and visiting your site to check for any database upgrades. Instructions in more detail: +Question2Answer regularly has [new releases]({{ site.baseurl }}/install/versions/) that fix bugs and add new features. Updating your Q2A site is usually a simple process of uploading the new files and visiting your site to check for any database upgrades. Instructions in more detail: 1. Before upgrading, it is recommended to make a backup of your website, and of your MySQL database using `mysqldump` or a similar tool. diff --git a/install/versions/1.md b/install/versions/1.md index eacdcf8..4cab047 100644 --- a/install/versions/1.md +++ b/install/versions/1.md @@ -2,6 +2,7 @@ layout: page menu: install title: "Question2Answer - 1.x version history" +slug: install-version-history-1 --- # Version History (1.6.x and earlier) diff --git a/install/versions/index.md b/install/versions/index.md index 1cc351a..7d31e8b 100644 --- a/install/versions/index.md +++ b/install/versions/index.md @@ -2,6 +2,7 @@ layout: page menu: install title: "Question2Answer - Version History" +slug: install-version-history --- # Version History @@ -140,7 +141,7 @@ First beta of major feature release, 26th September 2017. - Performance has been improved by around 20% on average (even more on questions with many answers). - Added caching system. Currently caches question data, related questions and category list for anonymous users. Caches can be stored in files or in memory (requires Memcached PHP extension). - Added comment voting. Comments may be voted up or down, and points may be given as with answers (default is no points). -- Added ability to enable/disable plugins. For backwards compatibility, by default plugins cannot be disabled (except by removing the plugin folder entirely). Plugin developers must "opt-in" to this feature using the `load_order` property in the plugin's `metadata.json`. See the [plugin documentation](/plugins/#plugin-metadata). +- Added ability to enable/disable plugins. For backwards compatibility, by default plugins cannot be disabled (except by removing the plugin folder entirely). Plugin developers must "opt-in" to this feature using the `load_order` property in the plugin's `metadata.json`. See the [plugin documentation]({{ site.baseurl }}/plugins/#plugin-metadata). - Added support for IPv6 addresses. - Schema.org microdata is now used throughout Q2A. - Number formatting characters (decimal point, thousands separator) can be specified in language files. @@ -434,4 +435,4 @@ First community-developed version of Question2Answer, 6th November 2014. - `qa-theme-base.php/ranking_spacer`: same as above. -## [Changelog for older versions](/install/versions/1/) +## [Changelog for older versions]({{ site.baseurl }}/install/versions/1/) diff --git a/install/wordpress.md b/install/wordpress.md index eff276c..4fac3f3 100644 --- a/install/wordpress.md +++ b/install/wordpress.md @@ -2,6 +2,7 @@ layout: page menu: install title: "Question2Answer - WordPress Integration" +slug: install-wordpress --- # Installing Question2Answer with WordPress integration @@ -52,4 +53,4 @@ From version 1.4, Question2Answer offers out-of-the-box integration with your [W 8. Follow the on-screen instructions to set up your database and Question2Answer functionality. -9. You can now integrate the styling of Question2Answer with your WordPress site by [creating a Question2Answer theme](/themes/). +9. You can now integrate the styling of Question2Answer with your WordPress site by [creating a Question2Answer theme]({{ site.baseurl }}/themes/). diff --git a/js/GithubLinks.js b/js/GithubLinks.js new file mode 100644 index 0000000..cccc834 --- /dev/null +++ b/js/GithubLinks.js @@ -0,0 +1,437 @@ + +// Days until next fetch for Github repository links +const daysUntilNextFetch = 7; + +class githubList { + constructor() { + this.pluginList = []; + this.themeList = []; + } + + addListLink(listType, entry) { + const formattedEntry = { + id: entry.id?.toString() || '', + link: entry.link?.toString() || '', + date: entry.date?.toString() || '', + max_q2a: entry.max_q2a?.toString() || '', + type: entry.type || 'repository' + }; + + if (listType === 'plugins') { + this.pluginList.push(formattedEntry); + } else { + this.themeList.push(formattedEntry); + } + } + + // Store Repositories locally + savePluginsList() { + localStorage.setItem('q2adocs_github_plugins', JSON.stringify(this.pluginList)); + } + saveThemesList() { + localStorage.setItem('q2adocs_github_themes', JSON.stringify(this.themeList)); + } + + getList(listType) { + // List param, will contain either: q2adocs_github_plugins or q2adocs_github_themes + return JSON.parse(localStorage.getItem(listType)); + } + +} + +const currentDate = () => { + const today = new Date(); + const yyyy = today.getFullYear(); + const mm = today.getMonth() + 1; // Months start at 0! + const dd = today.getDate(); + + return new Array(yyyy, mm, dd); +} + +// Takes one date parameter, calculates and returns the amount of days between present day +const calcDays = param => { + const todayDate = currentDate(); + const currentYear = new Date(`${todayDate[0]}/${todayDate[1]}/${todayDate[2]}`); + + let convertDate = param; + if (convertDate.indexOf('-') > -1) { + const arr = convertDate.split('-'); + convertDate = `${arr[0]}/${arr[1]}/${arr[2]}`; + } + + const repositoryYear = new Date(convertDate); + + const oneDay = 24 * 60 * 60 * 1000; // hours*minutes*seconds*milliseconds + const diffDays = Math.round(Math.abs((currentYear - repositoryYear) / oneDay)); + + return diffDays; +} + +// Calculate year gap for Github repositories +const calcYears = param => { + const diffYears = calcDays(param); + let yearGap = 0; + + if ( diffYears <= 365) { + yearGap = 1; + } else if ( diffYears > 365 && diffYears <= 730) { + yearGap = 2; + } else if ( diffYears > 730 && diffYears <= 1095) { + yearGap = 3; + } else if ( diffYears > 1095 && diffYears <= 1460) { + yearGap = 4; + } else if ( diffYears > 1460) { + yearGap = 5; + } + return yearGap; +} + +// Checks for Github repository links, and prepends a tag with their date "year-month-day". (fetched from their metadata.js files) +const gitLinks = document.querySelectorAll(` + .template-addons-plugins .page-content li a[href*="https://github.com/"], + .template-addons-themes .page-content li a[href*="https://github.com/"] +`); + +const pluginLinks = document.querySelectorAll('.template-addons-plugins .page-content li a[href*="https://github.com/"]'); +const themeLinks = document.querySelectorAll('.template-addons-themes .page-content li a[href*="https://github.com/"]'); + +if (gitLinks != null && gitLinks.length) { + + const pluginsList = new githubList(); + const themesList = new githubList(); + const isPluginsPage = (document.querySelector('.template-addons-plugins') != null ? true : false); + const isThemesPage = (document.querySelector('.template-addons-themes') != null ? true : false); + + // Add child-repository class + gitLinks.forEach(link => { + const listItem = link.closest('li'); + if (listItem && listItem.textContent.trim().startsWith('➔')) { + listItem.classList.add('child-repository'); + } + }); + + /** + * Adds an entry to the appropriate list (plugins or themes) with repository type. + * + * @param {string} pageType - Indicates the type of page ('plugins' or 'themes'). + * @param {string} listType - The type of list the entry should be added to ('plugins' or 'themes'). + * @param {Object} entry - The entry object containing id, link, date, and max_q2a. + */ + const addFetchedLinkToList = (pageType, listType, entry) => { + const list = pageType === 'plugins' ? pluginsList : themesList; + list.addListLink(listType, entry); + } + + // Get current Q2A version + const getQ2aVersion = async () => { + try { + const res = await fetch('https://raw.githubusercontent.com/q2a/question2answer/master/VERSION.txt'); + if (res.ok) { + const text = await res.text(); + return text.trim(); + } + } catch (e) { + console.warn('Failed to fetch Q2A version:', e); + } + return '0'; // fallback + }; + + /** + * Fetch Links - Fetches metadata for all GitHub plugin/theme links on the current page. + * + * - Attempts to retrieve each repository's `metadata.json` file. + * - Stores successful and failed responses (with fallback "unknown" values) into localStorage. + * - Adds metadata headers for list length and last updated date. + * - Immediately calls `createTags()` to render tags based on the fetched data. + * - Uses a fast-fail approach for broken URLs to speed up processing. + * + * This ensures future page loads are faster by caching both good and broken links, + * and avoids re-fetching unchanged data. + */ + const fetchLinks = async () => { + const githubDomain = 'https://github.com/'; + const fetchPromises = []; + const tempList = []; + + const q2aVersion = await getQ2aVersion(); + + // Set list headers + if (isPluginsPage) { + pluginsList.addListLink('plugins', { + id: 'metadata_list_size', + link: 'List_length', + date: pluginLinks.length, + max_q2a: q2aVersion, + type: 'metadata' + }); + pluginsList.addListLink('plugins', { + id: 'metadata_list_updated', + link: 'updated', + date: new Date().toISOString(), + max_q2a: q2aVersion, + type: 'metadata' + }); + } else if (isThemesPage) { + themesList.addListLink('themes', { + id: 'metadata_list_size', + link: 'List_length', + date: themeLinks.length, + max_q2a: q2aVersion, + type: 'metadata' + }); + themesList.addListLink('themes', { + id: 'metadata_list_updated', + link: 'updated', + date: new Date().toISOString(), + max_q2a: q2aVersion, + type: 'metadata' + }); + } + + for (let i = 0; i < gitLinks.length; i++) { + const href = gitLinks[i].getAttribute('href'); + const repoPath = href.slice(href.indexOf(githubDomain) + githubDomain.length); + const metadataURL = `https://raw.githubusercontent.com/${repoPath}/master/metadata.json`; + const isRepository = (href.match(/\//g) || []).length >= 4; + + // Add a placeholder, while the content is being loaded + if (gitLinks[i] && gitLinks[i].parentElement) { + gitLinks[i].parentElement.insertAdjacentHTML( + 'beforeend', + ` + Loading repository data... + ` + ); + } + + const fetchPromise = fetch(metadataURL) + .then(res => res.ok ? res.json() : Promise.reject('404')) + .then(data => { + const maxQ2a = data.max_q2a || '0'; + const entry = { + id: i.toString(), + link: href, + date: data.date || 'unknown', + max_q2a: maxQ2a + }; + tempList.push(entry); + + // Add to the list to be saved + if (isPluginsPage) { + addFetchedLinkToList('plugins', 'plugins', entry); + } else if (isThemesPage) { + addFetchedLinkToList('themes', 'themes', entry); + } + }) + .catch(() => { + if (isRepository) { + const entry = { + id: i.toString(), + link: href.toString(), + date: 'unknown', + max_q2a: '0', + type: 'repository' + }; + tempList.push(entry); + + // Add to the list to be saved + if (isPluginsPage) { + addFetchedLinkToList('plugins', 'plugins', entry); + } else if (isThemesPage) { + addFetchedLinkToList('themes', 'themes', entry); + } + } + }); + + fetchPromises.push(fetchPromise); + } + + Promise.all(fetchPromises).then(() => { + // Save to localStorage + if (isPluginsPage) { + pluginsList.savePluginsList(); + // console.log('Fetched and saved plugin list'); + createTags(pluginsList.pluginList); + } else if (isThemesPage) { + themesList.saveThemesList(); + // console.log('Fetched and saved theme list'); + createTags(themesList.themeList); + } + }); + }; + + // Get saved data from LocalStorage + const retrievedPlugins = pluginsList.getList('q2adocs_github_plugins'); + const retrievedThemes = themesList.getList('q2adocs_github_themes'); + + // Create tags for both - Plugins and Themes + const createTags = (param) => { + if (param) { + // Get the stored value for Q2A current version + const currentQ2aVersion = param[0].max_q2a; + + // Show current Q2A version on the sidebar, for comparison with plugins/themes. + const currentVersionEl = document.createElement('div'); + currentVersionEl.className = 'docs-nav-q2a-version'; + currentVersionEl.innerHTML = `Q2A current version: ${currentQ2aVersion} + + + + `; + const docsNavEl = document.querySelector('.docs-nav'); + docsNavEl.parentNode.insertBefore(currentVersionEl, docsNavEl.nextSibling); + + param.forEach((item, index) => { + + const list = param.slice(2); // Remove list header (metadata) indexes + const id = Object.values(list[index] || {} )[0]; + const link = Object.values(list[index] || {} )[1]; + const date = Object.values(list[index] || {} )[2]; + const max_q2a = Object.values(list[index] || {} )[3]; + + // Uncomment to check if list is being stored correctly + // console.log(`${id} === ${link} === ${date}`); + + if (id != null && link != null && date != null && max_q2a != null) { + + // Remove Placeholder + const parentElement = gitLinks[id].parentElement; + const placeholders = parentElement.querySelectorAll('.loading-placeholder'); + + placeholders.forEach(placeholder => placeholder.remove()); + + // Preppend based on stored id/index, because DOM link order may not be accurate when looping + // index order will be updated when information is fetched again + + const yearGapClass = 'rep-date-' + calcYears(date); + + if (date != 'unknown') { + // if 'max_q2a' key is available + if (max_q2a != '0') { + gitLinks[id].parentElement.insertAdjacentHTML( + 'beforeend', + ` + + Last updated: + + ${date} + + + Tested with Q2A ${max_q2a} + + The author of this plugin, maintainer, or its contributors, have tested this plugin's compatibility with Q2A ${max_q2a}. + + + + + `, + ); + } else { + gitLinks[id].parentElement.insertAdjacentHTML( + 'beforeend', + ` + + Last updated: + + ${date} + + `, + ); + } + } else if (date == 'unknown') { + // If response is 'bad request' or '404', show "unknown" tag + gitLinks[id].parentElement.insertAdjacentHTML( + 'beforeend', + ` + + Last updated: + Unknown + + `, + ); + } + } // close if () null + }); + } + } // close createTags() + + // Start "ListLength" at zero, in case not fetched yet + let pluginsListUpdated = currentDate(); + let pluginListLength = 0; + + let themesListUpdated = currentDate(); + let themeListLength = 0; + + const getMetadataValue = (list, key) => list.find(e => e.type === 'metadata' && e.id === key)?.date; + + if (retrievedPlugins?.length) { + try { + const rawDate = getMetadataValue(retrievedPlugins, 'metadata_list_updated'); + const parsedDate = new Date(rawDate); + pluginsListUpdated = !isNaN(parsedDate) ? parsedDate.toISOString().split('T')[0] : currentDate().join('-'); + pluginListLength = parseInt(getMetadataValue(retrievedPlugins, 'metadata_list_size'), 10) || 0; + } catch { + pluginsListUpdated = currentDate().join('-'); + pluginListLength = 0; + } + } + + if (retrievedThemes?.length) { + try { + const rawDate = getMetadataValue(retrievedThemes, 'metadata_list_updated'); + const parsedDate = new Date(rawDate); + themesListUpdated = !isNaN(parsedDate) ? parsedDate.toISOString().split('T')[0] : currentDate().join('-'); + themeListLength = parseInt(getMetadataValue(retrievedThemes, 'metadata_list_size'), 10) || 0; + } catch { + themesListUpdated = currentDate().join('-'); + themeListLength = 0; + } + } + + + // ---------------------------- + // Create the tags / badges --- + // ---------------------------- + + /** + * Initializes repository tag rendering for plugin or theme pages. + * + * - Checks if data in localStorage is fresh and matches the number of GitHub links on the page. + * - If data is outdated, missing, or the list length has changed, triggers a fresh fetch via `fetchLinks()`. + * - Otherwise, uses cached data from localStorage to immediately render tags with `createTags()`. + */ + const createFooters = () => { + if (isPluginsPage) { + const shouldFetch = ( + retrievedPlugins === null || + calcDays(pluginsListUpdated) >= daysUntilNextFetch || + pluginLinks.length != pluginListLength + ); + if (shouldFetch) { + fetchLinks(); // fetchLinks will handle createTags + } else { + createTags(retrievedPlugins); // only use local data if not fetching + } + } else if (isThemesPage) { + const shouldFetch = ( + retrievedThemes === null || + calcDays(themesListUpdated) >= daysUntilNextFetch || + themeLinks.length != themeListLength + ); + if (shouldFetch) { + fetchLinks(); + } else { + createTags(retrievedThemes); + } + } + }; + + // Test remaining days + // console.log('Days passed since Plugins list updated: ' + calcDays(pluginsListUpdated)); + // console.log('Days passed since Themes list updated: ' + calcDays(themesListUpdated)); + createFooters(); + +} // End of if gitLinks.length + + + diff --git a/js/scripts.js b/js/scripts.js new file mode 100644 index 0000000..4a6c505 --- /dev/null +++ b/js/scripts.js @@ -0,0 +1,237 @@ +// -------------------------------- +// Common functions, Reusable STUFF +// -------------------------------- + +// Check for Parents +const hasParent = (element, ...parents) => parents.some( parent => parent.includes(element)); + +// Loop add class +const loopAddClass = (targetClass, addClass) => { + document.querySelectorAll(targetClass).forEach( element => { + element.classList.add(addClass); + }); +} + +// Loop remove class +const loopRemoveClass = (targetClass, removeClass) => { + document.querySelectorAll(targetClass).forEach( element => { + element.classList.remove(removeClass); + }); +} + +// Loop toggle class +const loopToggleClass = (targetClass, toggleClass) => { + document.querySelectorAll(targetClass).forEach( element => { + element.classList.toggle(toggleClass); + }); +} + +// Toggle Visibility. +const toggleVisibility = e => e.classList.toggle('display-none'); + +// Scroll to Elements +const scrollToElement = e => { + window.scroll({ + behavior: 'smooth', + left: 0, + top: e.offsetTop - 90 + }); +} + +// ---- + +// Add current page "selected-nav" class, for the Mega Menu "Documentation" Link item +if (document.querySelectorAll('.nav-main .selected-nav').length > 0) { + document.querySelector('.mega-menu-trigger .nav-item').classList.add('selected-nav'); +} +// Add selected nav to the top level parent (second nav) +if (document.querySelectorAll('.nav-main-second .selected-nav').length > 0 && + !document.body.classList.contains('template-contribute') && + !document.body.classList.contains('template-addons') + ){ + document.querySelector('.nav-main-second .selected-nav').closest('.sub-nav').previousElementSibling.classList.add('selected-nav'); +} + +// toggle menu children +let opened = null; +const handleDropdown = e => { + const clickedItem = e.parentElement.lastChild.previousSibling; + + toggleVisibility(clickedItem); + if (window.screen.width < 1024) { + loopAddClass('.nav-container .nav > li', 'obfuscate'); + e.parentElement.classList.remove('obfuscate'); // Remove it for the current List item + } + + if (!opened) { + opened = clickedItem; + } else if (opened == clickedItem) { + opened = null; + } else { + toggleVisibility(opened); + opened = clickedItem; + } +} + +const navContainer = document.querySelector('.nav-container'); +const backgroundSheet = document.querySelector('.darkPane'); +const navMain = document.querySelector('.nav-main'); +const noticeContainer = document.querySelector('.notice-container'); + +// Handle Click +const handleClick = e => { + + // Menu Trigger + if (e.target.id === 'main-nav-trigger') { + if (navContainer.classList.contains('active')) { + navContainer.classList.remove('active'); + backgroundSheet.classList.remove('active'); + } else { + navContainer.classList.add('active'); + backgroundSheet.classList.add('active'); + } + } + + // Mega Menu + if (e.target.parentElement.className.includes('mega-menu-trigger')) { + toggleVisibility(navMain); + } else if (!hasParent(e.target, '.nav-main')) { + navMain.classList.add('display-none'); + } + + // Nav Menu Children + if (e.target.className.includes('toggleChildren')) { + handleDropdown(e.target); + } else if (opened) { + toggleVisibility(opened); + if (window.screen.width < 1024) + loopRemoveClass('.nav-container .nav > li', 'obfuscate'); + opened = null; + } + + // Scroll to section on Sidebar navigation click + if (e.target.className.includes('docs-nav-item')) { + const targetDataId = e.target.getAttribute('data-attr-scroll'); + scrollToElement(document.getElementById(targetDataId)); + } + + // Go Top + if (e.target.className.includes('jump-top')) { + window.scrollTo({top: 0, behavior: 'smooth'}); + } + + // Close dark sheet + if (e.target.className.includes('darkPane')) { + if (backgroundSheet.classList.contains('active')) { + navContainer.classList.remove('active'); + backgroundSheet.classList.remove('active'); + } + } + + // Needs Page refresh after fetching + if (e.target.className.includes('close-page-status')) { + location.reload(); + } + + // Notice + if (e.target.className.includes('close-notice') || e.target.className.includes('close-sheet')) { + noticeContainer.classList.add('display-none'); + // set Notice localStorage + localStorage.q2adocs_notice = 'closed'; + } + +} // End handleClick() +document.addEventListener('click', handleClick); + +// Show / Hide Notice on the front page +if (localStorage.getItem('q2adocs_notice') === null && noticeContainer != null) { + noticeContainer.classList.remove('display-none'); +} + +// Quick fix to close Mega Menu, when clicking secondary nav items +document.querySelectorAll('.nav-main-second .toggleChildren').forEach(element => { + element.addEventListener('click', (e) => { + navMain.classList.add('display-none'); + }); +}); + + +// On Scroll +const header = document.querySelector('header.header'); +const stickyPos = header ? header.offsetTop : 0; + +const jumpTopContainer = document.querySelector('.jump-top-container'); +const jumpTop = document.getElementById('jump-top'); + +// Handle Scroll +const handleScroll = e => { + + // Sticky Topbar + if (window.scrollY > stickyPos) { + header.classList.add('sticky'); + } else { + header.classList.remove('sticky'); + } + + if(window.screen.width > 900) { + // Get the offset position of the scroll-to-top button + const stickyJumpPos = 700; + + const jtRect = jumpTopContainer.getBoundingClientRect().top; + const jtOH = ( window.pageYOffset || jumpTopContainer.scrollTop ) - ( jumpTopContainer.clientTop || 0 ); + const winHeight = window.innerHeight - jumpTopContainer.offsetHeight; + const stopStickyJump = (jtRect + jtOH - winHeight); + + if (window.scrollY > stickyJumpPos && window.scrollY < stopStickyJump) { + jumpTop.classList.add ('active'); + } else if (window.scrollY > stopStickyJump) { + jumpTop.classList.remove('active'); + } else { + jumpTop.classList.remove('active'); + } + } + +} +handleScroll(); +window.addEventListener('scroll', handleScroll); + + +// ---------------------------- +// Single page ---------------- +// ---------------------------- + +// Docs Navigation +const articleHeaders = document.querySelectorAll('\ + .page-content h1, .page-content h2, .page-content h3, .page-content h4, .page-content h5, .page-content h6\ +'); +const docsNav = document.querySelector('.docs-nav'); + +articleHeaders.forEach(element => { + element.classList.add('sectionTitle'); + let dataId = element.getAttribute('id'); + const html = '
  • ' + element.innerHTML +'
    • '; + docsNav.insertAdjacentHTML('beforeend', html); +}); + + +const sidebarDocslinks = document.querySelectorAll('.docs-nav-item'); +const docsSection = document.querySelectorAll('.sectionTitle'); + +const sidebarLinkNav = e => { + if(!document.body.classList.contains('template-homepage') && sidebarDocslinks != null && docsSection != null) { + let index = docsSection.length; + + while (--index && window.scrollY + 200 < docsSection[index].offsetTop) {} + + // add the active class if within visible height of the element + if (scrollY - docsSection[index].offsetHeight < docsSection[index].offsetTop) { + sidebarDocslinks.forEach((link) => link.classList.remove('active')); + sidebarDocslinks[index].classList.add('active'); + } + } +} +sidebarLinkNav(); +window.addEventListener('scroll', sidebarLinkNav); + + + diff --git a/license.md b/license.md index d4e5175..ac6e615 100644 --- a/license.md +++ b/license.md @@ -1,6 +1,7 @@ --- layout: page title: "Question2Answer - Versions" +slug: singlepage-license --- # Question2Answer is free and open source. diff --git a/plugins/index.md b/plugins/index.md index 14417f6..22c8099 100644 --- a/plugins/index.md +++ b/plugins/index.md @@ -2,32 +2,33 @@ layout: page menu: plugins title: "Question2Answer - Developers - Creating Plugins" +slug: modules --- # Creating plugins for Question2Answer Question2Answer plugins (introduced in Q2A 1.3) allow the platform to be modified or extended without changing the Q2A core. Plugins can integrate with Q2A in one of three ways: -- **[Modules](/plugins/modules/) extend Q2A in a defined and specific way.** The following types of module are supported: - - [*page*](/plugins/modules-page/) modules add a new type of page to a Question2Answer site. - - [*login*](/plugins/modules-login/) modules allow users to log in to Q2A via an external identity provider such as Facebook. - - [*editor*](/plugins/modules-editor/) modules provide a web interface for writing and editing posts. - - [*viewer*](/plugins/modules-viewer/) modules render content as HTML or text, and often work together with an editor module. - - [*event*](/plugins/modules-event/) modules are notified when something important happens, such as content being posted or voted on. - - [*widget*](/plugins/modules-widget/) modules allow extra content to be shown on Q2A pages, as chosen by the site administrator. - - [*filter*](/plugins/modules-filter/) modules can validate and/or modify many types of user input, including the content of posts. - - [*search*](/plugins/modules-search/) modules can implement a custom indexer and/or search engine for a Q2A site. - - [*captcha*](/plugins/modules-captcha/) modules provide a web interface for human verification, such as reCAPTCHA. - - [*process*](/plugins/modules-process/) modules have the opportunity to run at specific stages of Q2A's response processing. +- **[Modules]({{ site.baseurl }}/plugins/modules/) extend Q2A in a defined and specific way.** The following types of module are supported: + - [*page*]({{ site.baseurl }}/plugins/modules-page/) modules add a new type of page to a Question2Answer site. + - [*login*]({{ site.baseurl }}/plugins/modules-login/) modules allow users to log in to Q2A via an external identity provider such as Facebook. + - [*editor*]({{ site.baseurl }}/plugins/modules-editor/) modules provide a web interface for writing and editing posts. + - [*viewer*]({{ site.baseurl }}/plugins/modules-viewer/) modules render content as HTML or text, and often work together with an editor module. + - [*event*]({{ site.baseurl }}/plugins/modules-event/) modules are notified when something important happens, such as content being posted or voted on. + - [*widget*]({{ site.baseurl }}/plugins/modules-widget/) modules allow extra content to be shown on Q2A pages, as chosen by the site administrator. + - [*filter*]({{ site.baseurl }}/plugins/modules-filter/) modules can validate and/or modify many types of user input, including the content of posts. + - [*search*]({{ site.baseurl }}/plugins/modules-search/) modules can implement a custom indexer and/or search engine for a Q2A site. + - [*captcha*]({{ site.baseurl }}/plugins/modules-captcha/) modules provide a web interface for human verification, such as reCAPTCHA. + - [*process*]({{ site.baseurl }}/plugins/modules-process/) modules have the opportunity to run at specific stages of Q2A's response processing. - Modules are the preferred method for extending Q2A - [more about modules](/plugins/modules/). + Modules are the preferred method for extending Q2A - [more about modules]({{ site.baseurl }}/plugins/modules/). -- **[Layers](/plugins/layers/) modify the HTML output for some elements of a Q2A page**. Layers work similarly to [advanced themes](/themes/), by overriding some functions in the base theme class in `qa-theme-base.php`. Unlike advanced themes, multiple layers can be installed simultaneously via their respective plugins. Layers require Q2A 1.4+. -- **[Overrides](/plugins/overrides/) allow over 150 core Q2A functions to be modified**. Core functions can be replaced by the plugin's code, or they can be wrapped, with the plugin modifying the function's inputs and/or outputs. With wrapping, multiple overrides for the same function in different plugins can be active simultaneously. Overrides require Q2A 1.5+. +- **[Layers]({{ site.baseurl }}/plugins/layers/) modify the HTML output for some elements of a Q2A page**. Layers work similarly to [advanced themes]({{ site.baseurl }}/themes/), by overriding some functions in the base theme class in `qa-theme-base.php`. Unlike advanced themes, multiple layers can be installed simultaneously via their respective plugins. Layers require Q2A 1.4+. +- **[Overrides]({{ site.baseurl }}/plugins/overrides/) allow over 150 core Q2A functions to be modified**. Core functions can be replaced by the plugin's code, or they can be wrapped, with the plugin modifying the function's inputs and/or outputs. With wrapping, multiple overrides for the same function in different plugins can be active simultaneously. Overrides require Q2A 1.5+. -The sections below explain the general principles behind plugins. You will also need to read about implementing [modules](/plugins/modules/), [layers](/plugins/layers/) and/or [overrides](/plugins/overrides/), as well as some [functions](/code/functions/) in Q2A that may be useful in developing your plugin. +The sections below explain the general principles behind plugins. You will also need to read about implementing [modules]({{ site.baseurl }}/plugins/modules/), [layers]({{ site.baseurl }}/plugins/layers/) and/or [overrides]({{ site.baseurl }}/plugins/overrides/), as well as some [functions]({{ site.baseurl }}/code/functions/) in Q2A that may be useful in developing your plugin. -An alternative is to work through the [plugin tutorial](/plugins/tutorial/), which introduces all of this material in a more gentle and gradual way. +An alternative is to work through the [plugin tutorial]({{ site.baseurl }}/plugins/tutorial/), which introduces all of this material in a more gentle and gradual way. To see some examples of plugins, modules and layers, take a look at the `qa-plugin` directory in your Q2A installation as well as the modules registered in the function `qa_register_core_modules()` in `qa-base.php` of Q2A 1.5+. @@ -41,11 +42,11 @@ Plugins for Question2Answer have the following directory structure: - The plugin directory may also contain any other files and subdirectories, including PHP, HTML, Javascript, CSS, etc... - A plugin is activated by installing its directory inside Q2A's `qa-plugin` directory. -The `qa-plugin.php` file has two main purposes. First, it registers any modules, layers or overrides provided by the plugin. Second, it contains optional metadata about the plugin and its author. As of Q2A 1.5, it is not recommended for `qa-plugin.php` to perform any other actions - if this seems necessary, please consider using a [process module](/plugins/modules-process/) instead. If you wish to use non English characters in `qa-plugin.php`, ensure your text editor is using UTF-8 encoding without a BOM (byte order mark). +The `qa-plugin.php` file has two main purposes. First, it registers any modules, layers or overrides provided by the plugin. Second, it contains optional metadata about the plugin and its author. As of Q2A 1.5, it is not recommended for `qa-plugin.php` to perform any other actions - if this seems necessary, please consider using a [process module]({{ site.baseurl }}/plugins/modules-process/) instead. If you wish to use non English characters in `qa-plugin.php`, ensure your text editor is using UTF-8 encoding without a BOM (byte order mark). ## Registering modules -Each module is implemented as a PHP `class` with specific member functions, as [detailed here](/plugins/modules/). For the sake of speed, the class definition for each module should be in a separate PHP file, since Q2A will only `include` this file when necessary. +Each module is implemented as a PHP `class` with specific member functions, as [detailed here]({{ site.baseurl }}/plugins/modules/). For the sake of speed, the class definition for each module should be in a separate PHP file, since Q2A will only `include` this file when necessary. To register a module, call `qa_register_plugin_module()` in `qa-plugin.php`, with the following parameters in order: @@ -56,18 +57,18 @@ To register a module, call `qa_register_plugin_module()` in `qa-plugin.php`, wit ## Registering layers -Each layer is implemented as a PHP file containing a fixed `class` declaration, as [described here](/plugins/layers/). To register a layer, call `qa_register_plugin_layer()` in `qa-plugin.php`, with the following parameters in order: +Each layer is implemented as a PHP file containing a fixed `class` declaration, as [described here]({{ site.baseurl }}/plugins/layers/). To register a layer, call `qa_register_plugin_layer()` in `qa-plugin.php`, with the following parameters in order: 1. The name of the PHP file in the plugin directory containing the layer's class declaration, e.g. `qa-mouseover-layer.php`. 2. A human-readable layer name, which should be descriptive and unique, e.g. `'Mouseover Layer'`. This may also be used to refer to the layer within Q2A's internals. ## Registering overrides -Overrides are implemented as PHP files which contain the replacement function definitions, as [described here](/plugins/overrides/). Your functions can call the original Q2A functions using the `_base` suffix, e.g. `qa_lang_base()`. To register a file containing overrides, call `qa_register_plugin_overrides()` in `qa-plugin.php` with the name of the overrides PHP file in the plugin directory. +Overrides are implemented as PHP files which contain the replacement function definitions, as [described here]({{ site.baseurl }}/plugins/overrides/). Your functions can call the original Q2A functions using the `_base` suffix, e.g. `qa_lang_base()`. To register a file containing overrides, call `qa_register_plugin_overrides()` in `qa-plugin.php` with the name of the overrides PHP file in the plugin directory. ## Plugin localization -Throughout Q2A, the [functions](/code/functions/) `qa_lang()` and `qa_lang_html()` are used to obtain localized language phrases. An identifier string is passed to these functions, which consists of a file prefix, a slash (`/`) and a phrase key. For example, the identifier `'main/cancel_button'` obtains the element with key `'cancel_button'` from the appropriate `qa-lang-main.php` language file. Each language file is a PHP script which returns an array mapping keys to phrases, e.g. see `qa-lang-main.php`. If you wish to use non English characters in your language files, ensure your text editor is using UTF-8 encoding without a BOM (byte order mark). +Throughout Q2A, the [functions]({{ site.baseurl }}/code/functions/) `qa_lang()` and `qa_lang_html()` are used to obtain localized language phrases. An identifier string is passed to these functions, which consists of a file prefix, a slash (`/`) and a phrase key. For example, the identifier `'main/cancel_button'` obtains the element with key `'cancel_button'` from the appropriate `qa-lang-main.php` language file. Each language file is a PHP script which returns an array mapping keys to phrases, e.g. see `qa-lang-main.php`. If you wish to use non English characters in your language files, ensure your text editor is using UTF-8 encoding without a BOM (byte order mark). From Q2A 1.5+, plugins can add their own language prefixes and phrases by calling `qa_register_plugin_phrases()` from within `qa-plugin.php`, with the following parameters in order: diff --git a/plugins/layers.md b/plugins/layers.md index d2dc554..a8f1308 100644 --- a/plugins/layers.md +++ b/plugins/layers.md @@ -2,6 +2,7 @@ layout: page menu: plugins title: "Question2Answer - Developers - Layers Modules" +slug: modules-layers --- # Implementing plugin layers @@ -16,9 +17,9 @@ class qa_html_theme_layer extends qa_html_theme_base } ``` -Layers work similarly to [advanced themes](/themes/), except multiple layers can be installed simultaneously via their respective plugins. The PHP code for each layer is automatically modified at runtime (by `qa_load_theme_class()` in `qa-app-format.php`) to build an inheritance chain of appropriately renamed classes. This process is transparent to you as a layer developer. If you wish to use non English characters in your layer, ensure your text editor is using UTF-8 encoding without a BOM (byte order mark). +Layers work similarly to [advanced themes]({{ site.baseurl }}/themes/), except multiple layers can be installed simultaneously via their respective plugins. The PHP code for each layer is automatically modified at runtime (by `qa_load_theme_class()` in `qa-app-format.php`) to build an inheritance chain of appropriately renamed classes. This process is transparent to you as a layer developer. If you wish to use non English characters in your layer, ensure your text editor is using UTF-8 encoding without a BOM (byte order mark). -For more information on how to override theme functions in your layer class declaration, **start at step 3** of the documentation for [advanced themes](/themes/). When overriding functions in your layer, you should use PHP's double colon (`::`) notation to call through to the parent class as much as possible. This will maximize the chance of your layer working well with advanced themes, layers in other plugins, and future versions of Question2Answer. +For more information on how to override theme functions in your layer class declaration, **start at step 3** of the documentation for [advanced themes]({{ site.baseurl }}/themes/). When overriding functions in your layer, you should use PHP's double colon (`::`) notation to call through to the parent class as much as possible. This will maximize the chance of your layer working well with advanced themes, layers in other plugins, and future versions of Question2Answer. Within a plugin's layer PHP file, the following pseudo-constants (substituted for strings at runtime) might prove useful: diff --git a/plugins/modules-captcha.md b/plugins/modules-captcha.md index f45a15d..d07df0b 100644 --- a/plugins/modules-captcha.md +++ b/plugins/modules-captcha.md @@ -2,11 +2,12 @@ layout: page menu: plugins title: "Question2Answer - Developers - Captcha Modules" +slug: modules-captcha --- # Captcha Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) A captcha module (requires Q2A 1.5+) provides a web interface for verifying that a user is a human, rather than an automated script generating spam. The [captcha](http://en.wikipedia.org/wiki/CAPTCHA) should provide a challenge that is easy for humans but difficult for computers, such as reading some warped text or answering a common sense question. @@ -16,4 +17,4 @@ The PHP `class` for a captcha module should contain the following functions (all - **`form_html(&$qa_content, $error)`**. This function returns the HTML form to be displayed for the captcha challenge. You can use hidden fields in this form to provide any information required by `validate_post()` - see below. If `$error` is not `null`, it contains an error message that should be displayed with the captcha, as passed out previously by your `validate_post()` function. You can also inject elements (such as Javascript) into the global `$qa_content` array for the page - see `qa-plugin/recaptcha-captcha/qa-recaptcha-captcha.php` for an example, or [ask here](http://www.question2answer.org/qa/). Note that if a captcha is required in multiple places on a web page, Q2A will only call `form_html()` once, and will take care of moving the captcha around the page as appropriate. This means your captcha must continue to work even if it was moved inside the [DOM](http://en.wikipedia.org/wiki/Document_Object_Model). - **`validate_post(&$error)`**. This function returns whether the user responded to the captcha correctly. The function should retrieve the necessary form fields from PHP's `$_POST` array or Q2A's `qa_post_text()` function, and then perform the appropriate verification. Return `true` if the verification succeeded, otherwise `false`. If verification failed, you should also set `$error` to a textual error message which will passed back to `form_html()` for display to the user. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules-editor.md b/plugins/modules-editor.md index b30a38a..1f1e1d4 100644 --- a/plugins/modules-editor.md +++ b/plugins/modules-editor.md @@ -2,15 +2,16 @@ layout: page menu: plugins title: "Question2Answer - Developers - Editor Modules" +slug: modules-editor --- # Editor Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) An editor module implements a web interface for editing the content of questions, answers and comments. The module controls the HTML field which is displayed for editing, and converts the input from that field into data for storage in Q2A's database. -For example, the default editor module in `qa-editor-basic.php` displays a simple text field and generates text content for storage. The WYSIWYG Editor plugin included with Q2A wraps [CKEditor](http://ckeditor.com/) and generates text or HTML content for storage. Your editor can also store content in a format other than text or HTML, but a [viewer module](/plugins/modules-viewer/) will be required to render that content for Q2A. +For example, the default editor module in `qa-editor-basic.php` displays a simple text field and generates text content for storage. The WYSIWYG Editor plugin included with Q2A wraps [CKEditor](http://ckeditor.com/) and generates text or HTML content for storage. Your editor can also store content in a format other than text or HTML, but a [viewer module]({{ site.baseurl }}/plugins/modules-viewer/) will be required to render that content for Q2A. The PHP `class` for an editor module must contain the following functions (all are **required**): @@ -18,7 +19,7 @@ The PHP `class` for an editor module must contain the following functions (all a - **`get_field(&$qa_content, $content, $format, $fieldname, $rows)`** should return an HTML-based field for your editor. The `$content` and `$format` parameters specify the content that needs editing or `null` if new content is being created. The `$fieldname` parameter contains the HTML element name that you should use - if your editor outputs multiple HTML elements, use `$fieldname` as a prefix. The `$rows` parameter indicates a suggested height for your editor, in lines of text. To output custom HTML for your editor, return `array('type' => 'custom', 'html' => '[the html]')` from this function. You can also return an array representing any standard Q2A form field and inject elements (such as Javascript) into the `$qa_content` array - see `qa-editor-basic.php` and `qa-wysiwyg-editor.php` for some examples, or [ask here](http://www.question2answer.org/qa/). -- **`read_post($fieldname)`** should retrieve the content from your editor, as POSTed from the user's web browser, and convert it for storage in Q2A's database. The `$fieldname` parameter matches the value that was previously passed to `get_field()`. To store plain text, return `array('format' => '', 'content' => '[text in UTF-8]')` from this function. To store HTML, return `array('format' => 'html', 'content' => '[html in UTF-8]')`. **If you are storing HTML as submitted by the user's browser, you must sanitize it using `qa_sanitize_html()` to prevent Javascript injection and other security issues.** Aside from plain text and HTML, your `read_post()` function can store any other type of content in Q2A's database, by supplying an appropriate `'format'` (up to 20 ASCII characters in length) and corresponding `'content'`. In this case, a [viewer module](/plugins/modules-viewer/) will be required to render the stored content as plain text or HTML. +- **`read_post($fieldname)`** should retrieve the content from your editor, as POSTed from the user's web browser, and convert it for storage in Q2A's database. The `$fieldname` parameter matches the value that was previously passed to `get_field()`. To store plain text, return `array('format' => '', 'content' => '[text in UTF-8]')` from this function. To store HTML, return `array('format' => 'html', 'content' => '[html in UTF-8]')`. **If you are storing HTML as submitted by the user's browser, you must sanitize it using `qa_sanitize_html()` to prevent Javascript injection and other security issues.** Aside from plain text and HTML, your `read_post()` function can store any other type of content in Q2A's database, by supplying an appropriate `'format'` (up to 20 ASCII characters in length) and corresponding `'content'`. In this case, a [viewer module]({{ site.baseurl }}/plugins/modules-viewer/) will be required to render the stored content as plain text or HTML. In addition, the following **optional** functions may also be defined (all require Q2A 1.5+): @@ -28,4 +29,4 @@ In addition, the following **optional** functions may also be defined (all requi - **`update_script($fieldname)`** can return a Javascript that prepares the editor content for submission via the enclosing form (requires Q2A 1.5+). If your editor manipulates content outside the form's field, e.g. in an iframe, this allows it to update the field content immediately before the form is submitted. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules-event.md b/plugins/modules-event.md index 851af9c..11a9059 100644 --- a/plugins/modules-event.md +++ b/plugins/modules-event.md @@ -2,11 +2,12 @@ layout: page menu: plugins title: "Question2Answer - Developers - Event Modules" +slug: modules-event --- # Event Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) An event module (requires Q2A 1.4+) is notified when something important happens within Q2A. It can be used to react to this event in any way it wishes. The PHP class for an event module must contain the following function to react to events: @@ -88,4 +89,4 @@ Below is a list of possible values for `$event` and the event that each value de - `'search'` when a search is performed. The search query is in `$params['query']` and the start position in `$params['start']`. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules-filter.md b/plugins/modules-filter.md index 78848a3..91aea88 100644 --- a/plugins/modules-filter.md +++ b/plugins/modules-filter.md @@ -2,11 +2,12 @@ layout: page menu: plugins title: "Question2Answer - Developers - Filter Modules" +slug: modules-filter --- # Filter Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) A filter module (requires Q2A 1.5+) enables plugins to validate and/or modify many different types of user input. This includes the content of posts as well as user information such as usernames and email addresses. Filter modules can also control whether or not the post is queued for moderation. Possible applications of filter modules include cleaning up user input, restricting users of a site, creating specialized Q&A applications, and advanced spam checking. @@ -36,7 +37,7 @@ The PHP class for a filter module may contain the following functions (all are o `'editor'` - The name of the [editor module](/plugins/modules-editor/) used + The name of the [editor module]({{ site.baseurl }}/plugins/modules-editor/) used No No Maybe @@ -133,4 +134,4 @@ The PHP class for a filter module may contain the following functions (all are o - **`validate_password($password, $olduser)`**. This allows a filter module to validate an entered password for new or existing Q2A user accounts. The `$password` parameter contains the password entered. Note than unlike other filter module functions, `validate_password()` cannot modify a password, but rather only validate it. The function can declare the pssword invalid by returning a textual error, otherwise it should return `null`. For your reference, if the password is for an existing user, `$olduser` contains an array of information about the user, but this will not contain the user's previous password, since Q2A doesn't store passwords in their original form. If the password is for a new user, `$olduser` will be `null`. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules-login.md b/plugins/modules-login.md index db92f47..a25427e 100644 --- a/plugins/modules-login.md +++ b/plugins/modules-login.md @@ -2,11 +2,12 @@ layout: page menu: plugins title: "Question2Answer - Developers - Login Modules" +slug: modules-login --- # Login Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) A login module enables users to log in to Q2A via an external identity provider, such as [Open ID](http://openid.net/). The module can display some HTML alongside Q2A's login and register links in the navigation menu, and/or on Q2A's login and register pages. This HTML can use a variety of methods to obtain the user's credentials, such as linking to a separate form or showing a pop-up via Javascript. @@ -39,6 +40,6 @@ The PHP `class` for a login module can contain the following functions (all are - **`logout_html($tourl)`** allows your module to display some HTML for logging out the user, to be displayed in the top right menu. Your `logout_html()` function is only called if the current Q2A user was logged in via `qa_log_in_external_user()` and your `match_source()` function returns `true` for the `$source` value that was used. The `$tourl` parameter contains the URL of the Q2A logout page, to which you **must** redirect the user once your own logout process is complete. -You may choose to request the user's external login credentials on a page which is served by Q2A. In this case you would include both a login module and a [page module](/plugins/modules-page/) in your plugin. The HTML displayed by the login module would link to your custom page, and the page module would display the appropriate form and call `qa_log_in_external_user()` when the form was submitted. +You may choose to request the user's external login credentials on a page which is served by Q2A. In this case you would include both a login module and a [page module]({{ site.baseurl }}/plugins/modules-page/) in your plugin. The HTML displayed by the login module would link to your custom page, and the page module would display the appropriate form and call `qa_log_in_external_user()` when the form was submitted. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules-page.md b/plugins/modules-page.md index 19dd255..96bde04 100644 --- a/plugins/modules-page.md +++ b/plugins/modules-page.md @@ -2,11 +2,12 @@ layout: page menu: plugins title: "Question2Answer - Developers - Plugin Modules" +slug: modules-page --- # Page Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) A page module adds one or more new pages to a Q2A installation. In Q2A, every page displayed has a corresponding `$request` string. For example, the `$request` for Q2A's page for user John Doe is `'user/John Doe'`. Page modules are able to control the output for particular `$request` strings in the same way. (Depending on the chosen URL structure for a Q2A installation, `$request` can be represented in different ways on the actual URL - you need not worry about this, nor should you make any assumptions.) @@ -26,8 +27,8 @@ The PHP `class` for a page module can contain the following functions (all are o - All elements within the nested `$qa_content` array should be made HTML safe - use `qa_html()` as appropriate. - Use `$qa_content['title']` and `$qa_content['error']` to display a page title or error message respectively. - To add some custom HTML to the page, add an element to `$qa_content` whose key begins with `custom`, e.g. `$qa_content['custom']` or `$qa_content['custom_2']`. The value of the element should contain the actual HTML. - - To add a Q2A-style form to the page, add an element to `$qa_content` whose key begins with `form`, e.g. `$qa_content['form']` or `$qa_content['form_2']`. The value of the element should contain a Q2A form array, whose definition is also beyond the scope of this documentation, although see the [comments here](/plugins/modules/). + - To add a Q2A-style form to the page, add an element to `$qa_content` whose key begins with `form`, e.g. `$qa_content['form']` or `$qa_content['form_2']`. The value of the element should contain a Q2A form array, whose definition is also beyond the scope of this documentation, although see the [comments here]({{ site.baseurl }}/plugins/modules/). - Other possible types of structured content in `$qa_content` are question lists (keys starting `q_list`), question views (`q_view`), answer lists (`a_list`) and rankings (`ranking`). Look through the `qa-page-*.php` files for examples. - The elements in `$qa_content` are displayed in array order, with a few exceptions such as page titles and errors. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules-process.md b/plugins/modules-process.md index f99a98a..bdde802 100644 --- a/plugins/modules-process.md +++ b/plugins/modules-process.md @@ -2,11 +2,12 @@ layout: page menu: plugins title: "Question2Answer - Developers - Process Modules" +slug: modules-process --- # Process Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) A process module (requires Q2A 1.5+) can perform any task at specific stages of Q2A's response processing. For example, process modules could provide logging, implement a page cache, change database settings, or perform extra user authentication. @@ -32,4 +33,4 @@ The PHP `class` for a process module can define one or more of the following fun - **`shutdown($reason)`** will be called at the end of Q2A's response processing. The `$reason` parameter will be `'error'` if an error occurred, `'redirect'` if there was a redirection, otherwise it will be `null`. More values may be added in future. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules-search.md b/plugins/modules-search.md index c271454..4947edf 100644 --- a/plugins/modules-search.md +++ b/plugins/modules-search.md @@ -2,17 +2,18 @@ layout: page menu: plugins title: "Question2Answer - Developers - Search Modules" +slug: modules-search --- # Search Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) A search module (requires Q2A 1.5+) enables plugins to create a custom index of the content in a Q2A site, including questions, answers, comments and custom pages. If a search module is selected by the site administrator, it can replace the default Q2A search results with its own, and optionally include pages from external websites in those results. The PHP class for a search module may contain the following functions (all are optional): -- **`index_post($postid, $type, $questionid, $parentid, $title, $content, $format, $text, $tagstring, $categoryid)`**. If defined, this function is called when a post should be added to the search index, either because it is new, or because it has just been edited. The parameter `$postid` contains the `postid` from the database. The `$type` will be `'Q'` for questions, `'A'` for answers, `'C'` for comments or `'NOTE'` for a note (currently used for question closing explanations). The `$questionid` is the `postid` of the question to which the post belongs and the `$parentid` is the `postid` of its immediate parent, or `null` if it has none. For questions, `$title` contains the title in UTF-8 format, otherwise it is `null`. The `$content` and `$format` parameters describe the post's content. If `$format` is `''`, then `$content` contains plain text in UTF-8 encoding. If `$format` is `'html'`, then `$content` contains HTML with UTF-8 encoding. Other values of `$format` may be present if a non-standard [editor module](/plugins/modules-editor/) is installed. The `$text` parameter contains a UTF-8 plain text rendering of the post, which is particularly useful for building a search index. For questions, `$tagstring` contains a comma-separated list of tags, otherwise it is `null`. Finally, `$categoryid` contains the category ID of the post, or `null` if there is none. Note that `index_post()` is only called when a post has been made visible on the Q2A site - it is not called if a new post was marked for moderation. +- **`index_post($postid, $type, $questionid, $parentid, $title, $content, $format, $text, $tagstring, $categoryid)`**. If defined, this function is called when a post should be added to the search index, either because it is new, or because it has just been edited. The parameter `$postid` contains the `postid` from the database. The `$type` will be `'Q'` for questions, `'A'` for answers, `'C'` for comments or `'NOTE'` for a note (currently used for question closing explanations). The `$questionid` is the `postid` of the question to which the post belongs and the `$parentid` is the `postid` of its immediate parent, or `null` if it has none. For questions, `$title` contains the title in UTF-8 format, otherwise it is `null`. The `$content` and `$format` parameters describe the post's content. If `$format` is `''`, then `$content` contains plain text in UTF-8 encoding. If `$format` is `'html'`, then `$content` contains HTML with UTF-8 encoding. Other values of `$format` may be present if a non-standard [editor module]({{ site.baseurl }}/plugins/modules-editor/) is installed. The `$text` parameter contains a UTF-8 plain text rendering of the post, which is particularly useful for building a search index. For questions, `$tagstring` contains a comma-separated list of tags, otherwise it is `null`. Finally, `$categoryid` contains the category ID of the post, or `null` if there is none. Note that `index_post()` is only called when a post has been made visible on the Q2A site - it is not called if a new post was marked for moderation. - **`unindex_post($postid)`**. If defined, this function is called when a post should be removed from the search index, because it has been hidden, deleted, or is about to be edited (in which case `index_post()` will be called immediately after). Generally, the parameter `$postid` matches a value previously passed to `index_post()` when the post was indexed. However in some circumstances the `$postid` might never have been indexed, in which case the function should do nothing. @@ -33,4 +34,4 @@ The PHP class for a search module may contain the following functions (all are o To save additional database queries, it is also possible to pass through more information about a matching question, post or page in `'question'`, `'match_type'` or `'page'` elements. This requires knowledge of Q2A's internals - see `qa-app-search.php` for more information on how these elements are used with the `$fullcontent` parameter. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules-viewer.md b/plugins/modules-viewer.md index 925dc7a..47652b7 100644 --- a/plugins/modules-viewer.md +++ b/plugins/modules-viewer.md @@ -2,13 +2,14 @@ layout: page menu: plugins title: "Question2Answer - Developers - Viewer Modules" +slug: modules-viewer --- # Viewer Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) -A viewer module takes content stored in the database, as generated by an [editor module](/plugins/modules-editor/), and renders it for display by Q2A. The default viewer module in `qa-viewer-basic.php` takes care of rendering stored text or HTML, so you will only need to create a viewer module if you have an editor module which stores content in a different format. +A viewer module takes content stored in the database, as generated by an [editor module]({{ site.baseurl }}/plugins/modules-editor/), and renders it for display by Q2A. The default viewer module in `qa-viewer-basic.php` takes care of rendering stored text or HTML, so you will only need to create a viewer module if you have an editor module which stores content in a different format. The PHP `class` for a viewer module must contain the following functions (all are **required**): @@ -22,4 +23,4 @@ The PHP `class` for a viewer module must contain the following functions (all ar - **`get_text($content, $format, $options)`** should take the supplied `$content` in `$format` and render it as plain text with UTF-8 encoding. The text is primarily used in notification emails and for search indexing. `$options['blockwordspreg']` should be treated in the same way as for `get_html()`. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules-widget.md b/plugins/modules-widget.md index 522eac9..2aded90 100644 --- a/plugins/modules-widget.md +++ b/plugins/modules-widget.md @@ -2,11 +2,12 @@ layout: page menu: plugins title: "Question2Answer - Developers - Widget Modules" +slug: modules-widget --- # Widget Modules -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) A widget module (requires Q2A 1.4+) displays some extra HTML content on one or more of Q2A's pages. The widget specifies which types of pages ("templates") it can be displayed on, and where it can be displayed on the page. The Q2A site admin then chooses exactly where and when the widget is shown, out of those options that the widget makes available. @@ -52,4 +53,4 @@ The PHP class for a widget module must contain the following functions (all are - `$request` - the Q2A request that generated the page, e.g. `'user/John Doe'`. The `$request` uses slash as a separator, independent of the type of URLs a particular Q2A site is using. - `$qa_content` - the nested Q2A array containing the full content for the page being displayed, as it was passed to the theme object. Use PHP's `print_r()` function to see what's inside and find any bits you need. -[« Back to modules](/plugins/modules/) +[« Back to modules]({{ site.baseurl }}/plugins/modules/) diff --git a/plugins/modules.md b/plugins/modules.md index 64db497..7b4cba2 100644 --- a/plugins/modules.md +++ b/plugins/modules.md @@ -2,26 +2,27 @@ layout: page menu: plugins title: "Question2Answer - Developers - Plugin Modules" +slug: modules-modules --- # Implementing plugin modules -Plugin modules enable Question2Answer to be extended in specific ways. Each module is implemented as a PHP `class` with specific member functions. Some functions are relevant for all module types, as described below. Other functions are specific to a certain type of module, e.g. [page modules](/plugins/modules-page/) implement the functions `match_request()` and `process_request()`. If you wish to use non English characters in the PHP code for a module, ensure your text editor is using UTF-8 encoding without a BOM (byte order mark). +Plugin modules enable Question2Answer to be extended in specific ways. Each module is implemented as a PHP `class` with specific member functions. Some functions are relevant for all module types, as described below. Other functions are specific to a certain type of module, e.g. [page modules]({{ site.baseurl }}/plugins/modules-page/) implement the functions `match_request()` and `process_request()`. If you wish to use non English characters in the PHP code for a module, ensure your text editor is using UTF-8 encoding without a BOM (byte order mark). ## Types of Module Below is a list of the module types supported by Q2A - click for more information about each type: -- [**page**](/plugins/modules-page/) modules add a new type of page to a Q2A installation. The XML Sitemap plugin included with Q2A is an example. -- [**login**](/plugins/modules-login/) modules allow users to log in to Q2A via an external identity provider, like the Facebook Login plugin included with Q2A. -- [**editor**](/plugins/modules-editor/) modules provide a web interface for writing and editing posts. The WYSIWYG Editor included with Q2A is implemented via a plugin that registers an editor module. -- [**viewer**](/plugins/modules-viewer/) modules render content as HTML or text, and often work together with an editor module. Support for [Markdown](http://en.wikipedia.org/wiki/Markdown) or equations could be added via a plugin with both an editor and viewer module. -- [**event**](/plugins/modules-event/) modules (from Q2A 1.4+) are notified when something important happens, such as content being posted or voted on. They can be used for analytics, notifications or integrating with external services such as [Twitter](http://www.twitter.com/). The Event Logger plugin included with Q2A logs all events to a database table and/or log files. -- [**widget**](/plugins/modules-widget/) modules (from Q2A 1.4+) allow extra content to be shown on Q2A pages. The site admin can decide exactly where the widget is displayed. The Tag Cloud widget plugin that comes with Q2A is one example. -- [**filter**](/plugins/modules-filter/) modules (from Q2A 1.5+) can validate and/or modify many types of user input, including the content of posts. They can also mark whether a particular post should be queued for moderation. -- [**search**](/plugins/modules-search/) modules (from Q2A 1.5+) can implement a custom indexer and/or search engine for a Q2A site. They are given the opportunity to index posts and/or custom page content, and replace the default search results with their own. -- [**captcha**](/plugins/modules-captcha/) modules (from Q2A 1.5+) provide a web interface for human verification. The reCAPTCHA plugin that comes with Q2A provides an example, using the popular [reCAPTCHA](http://www.google.com/recaptcha) service. -- [**process**](/plugins/modules-process/) modules (from Q2A 1.5+) have the opportunity to run at specific stages of Q2A's response processing. They can be used for logging, analytics, additional authentication, caching, etc... +- [**page**]({{ site.baseurl }}/plugins/modules-page/) modules add a new type of page to a Q2A installation. The XML Sitemap plugin included with Q2A is an example. +- [**login**]({{ site.baseurl }}/plugins/modules-login/) modules allow users to log in to Q2A via an external identity provider, like the Facebook Login plugin included with Q2A. +- [**editor**]({{ site.baseurl }}/plugins/modules-editor/) modules provide a web interface for writing and editing posts. The WYSIWYG Editor included with Q2A is implemented via a plugin that registers an editor module. +- [**viewer**]({{ site.baseurl }}/plugins/modules-viewer/) modules render content as HTML or text, and often work together with an editor module. Support for [Markdown](http://en.wikipedia.org/wiki/Markdown) or equations could be added via a plugin with both an editor and viewer module. +- [**event**]({{ site.baseurl }}/plugins/modules-event/) modules (from Q2A 1.4+) are notified when something important happens, such as content being posted or voted on. They can be used for analytics, notifications or integrating with external services such as [Twitter](http://www.twitter.com/). The Event Logger plugin included with Q2A logs all events to a database table and/or log files. +- [**widget**]({{ site.baseurl }}/plugins/modules-widget/) modules (from Q2A 1.4+) allow extra content to be shown on Q2A pages. The site admin can decide exactly where the widget is displayed. The Tag Cloud widget plugin that comes with Q2A is one example. +- [**filter**]({{ site.baseurl }}/plugins/modules-filter/) modules (from Q2A 1.5+) can validate and/or modify many types of user input, including the content of posts. They can also mark whether a particular post should be queued for moderation. +- [**search**]({{ site.baseurl }}/plugins/modules-search/) modules (from Q2A 1.5+) can implement a custom indexer and/or search engine for a Q2A site. They are given the opportunity to index posts and/or custom page content, and replace the default search results with their own. +- [**captcha**]({{ site.baseurl }}/plugins/modules-captcha/) modules (from Q2A 1.5+) provide a web interface for human verification. The reCAPTCHA plugin that comes with Q2A provides an example, using the popular [reCAPTCHA](http://www.google.com/recaptcha) service. +- [**process**]({{ site.baseurl }}/plugins/modules-process/) modules (from Q2A 1.5+) have the opportunity to run at specific stages of Q2A's response processing. They can be used for logging, analytics, additional authentication, caching, etc... ## Common module functions @@ -37,11 +38,11 @@ Some functions are relevant for all module types, as listed below. You may also - All elements within the nested form array should be made HTML safe - use `qa_html()` as appropriate. - The `NAME=...` of all buttons and fields (within `tags` elements) should have a prefix which is unique to your plugin. - - Use `qa_clicked()` and `qa_post_text()`, as described [here](/code/functions/), to check for button clicks and retrieve submitted fields. + - Use `qa_clicked()` and `qa_post_text()`, as described [here]({{ site.baseurl }}/code/functions/), to check for button clicks and retrieve submitted fields. - Use `qa_opt()` to get or set an option that is stored in Q2A's options table. To prevent interference with Q2A or other plugins, any options should be named using a prefix which is unique to your plugin. - **`init_queries($tableslc)`**. If a module requires some database initialization, e.g. to create its own table, it can define this function to integrate into Q2A's installation and updating process (requires Q2A 1.5+). For your convenience, `$tableslc` contains an array of lower case names of tables currently in the Q2A database. Your function should examine the `$tableslc` array and perform any other diagnostics in order to determine whether initialization is required. If so, return an array of one or more MySQL queries that should be run, otherwise return `null`. If you are creating a table with a `CREATE TABLE` query, you should add the appropriate prefix to the table name - see `qa_db_add_table_prefix()` in `qa-db.php` or use the `^` symbol before the table name. This will prevent clashes between separate Q2A installations sharing a database. ## Communication between modules -A module can define any additional functions for its own purposes, in the usual way for a PHP class. These functions can also be used for communication between modules, either within a plugin, or between different plugins. To call a function defined in a module, call [`qa_load_module()`](/code/functions/) to retrieve an object of the module's class, then call the object's function in the usual PHP way. Note that multiple calls to `qa_load_module()` will return the same object. +A module can define any additional functions for its own purposes, in the usual way for a PHP class. These functions can also be used for communication between modules, either within a plugin, or between different plugins. To call a function defined in a module, call [`qa_load_module()`]({{ site.baseurl }}/code/functions/) to retrieve an object of the module's class, then call the object's function in the usual PHP way. Note that multiple calls to `qa_load_module()` will return the same object. diff --git a/plugins/overrides.md b/plugins/overrides.md index fb0d16b..2d23efe 100644 --- a/plugins/overrides.md +++ b/plugins/overrides.md @@ -2,11 +2,12 @@ layout: page menu: plugins title: "Question2Answer - Developers - Overrides" +slug: overrides --- # Implementing plugin overrides -Plugin overrides (requires Q2A 1.5+) can replace or wrap over 150 functions defined within the Q2A core. Overrides can be very powerful, but they run a risk of incompatibility with future versions of Q2A. If possible, it is recommended to use [modules](/plugins/modules/) or [layers](/plugins/layers/) instead. Nonetheless, some things can only be done via overrides, and future versions of Q2A will try not to break them. +Plugin overrides (requires Q2A 1.5+) can replace or wrap over 150 functions defined within the Q2A core. Overrides can be very powerful, but they run a risk of incompatibility with future versions of Q2A. If possible, it is recommended to use [modules]({{ site.baseurl }}/plugins/modules/) or [layers]({{ site.baseurl }}/plugins/layers/) instead. Nonetheless, some things can only be done via overrides, and future versions of Q2A will try not to break them. Not all functions in Q2A can be overridden. To check a particular function, see whether its definition begins with: diff --git a/plugins/tutorial.md b/plugins/tutorial.md index 68cbd30..1553654 100644 --- a/plugins/tutorial.md +++ b/plugins/tutorial.md @@ -2,13 +2,14 @@ layout: page menu: plugins title: "Question2Answer - Developers - Tutorial - Writing a Plugin" +slug: tutorial --- # Tutorial: Writing a Question2Answer plugin -In this tutorial, we will create a Question2Answer (1.5+) [plugin](/plugins/) from scratch. Our plugin will allow descriptions to be added to tags on a Q2A site. These descriptions will be displayed and edited on the page listing recent questions for each tag. They will also be shown in a tooltip when users mouse over a tag. The Q2A administrator will be able to decide who can edit tag descriptions. +In this tutorial, we will create a Question2Answer (1.5+) [plugin]({{ site.baseurl }}/plugins/) from scratch. Our plugin will allow descriptions to be added to tags on a Q2A site. These descriptions will be displayed and edited on the page listing recent questions for each tag. They will also be shown in a tooltip when users mouse over a tag. The Q2A administrator will be able to decide who can edit tag descriptions. -The tutorial will touch on each of the main areas of Q2A plugin `function`ality. Tag descriptions will be stored in the Q2A database, using Q2A's tag metadata table. The descriptions will be displayed on a tag's page using a [widget module](/plugins/modules-widget/). Tags will be edited on pages provided by a [page module](/plugins/modules-page/). An [override](/plugins/overrides/) will be used to show the tooltips, and then a [layer](/plugins/layers/) will allow us to do this with fewer database queries. An admin form for the plugin will be displayed in the 'Plugins' section of the admin panel, with the corresponding settings stored by Q2A's options mechanism. At the end of this process, we will see how to make the plugin localizable. +The tutorial will touch on each of the main areas of Q2A plugin `function`ality. Tag descriptions will be stored in the Q2A database, using Q2A's tag metadata table. The descriptions will be displayed on a tag's page using a [widget module]({{ site.baseurl }}/plugins/modules-widget/). Tags will be edited on pages provided by a [page module]({{ site.baseurl }}/plugins/modules-page/). An [override]({{ site.baseurl }}/plugins/overrides/) will be used to show the tooltips, and then a [layer]({{ site.baseurl }}/plugins/layers/) will allow us to do this with fewer database queries. An admin form for the plugin will be displayed in the 'Plugins' section of the admin panel, with the corresponding settings stored by Q2A's options mechanism. At the end of this process, we will see how to make the plugin localizable. This tutorial assumes you are familiar with the [PHP](http://www.php.net/) programming language as well as some basic [HTML](http://en.wikipedia.org/wiki/HTML) and [MySQL](http://www.mysql.com/). @@ -17,7 +18,7 @@ This tutorial assumes you are familiar with the [PHP](http://www.php.net/) progr In this first step we will set up the directory for the plugin and create the crucial `qa-plugin.php` file within. -- Create a new empty directory `tag-descriptions` in Q2A's `qa-plugin` directory - see [here](/plugins/) for naming conventions. +- Create a new empty directory `tag-descriptions` in Q2A's `qa-plugin` directory - see [here]({{ site.baseurl }}/plugins/) for naming conventions. - Create an empty `qa-plugin.php` file inside this directory. This file is the core of the plugin. It registers each of the plugin's elements with Q2A and contains meta information for display in Q2A's admin interface. @@ -46,7 +47,7 @@ In this first step we will set up the directory for the plugin and create the cr } ``` - See [here](/plugins/) for a detailed description of the metadata fields. The code below the metadata ensures that visitors to your Q2A site cannot request the `qa-plugin.php` page directly (even though doing so would cause no actual harm). + See [here]({{ site.baseurl }}/plugins/) for a detailed description of the metadata fields. The code below the metadata ensures that visitors to your Q2A site cannot request the `qa-plugin.php` page directly (even though doing so would cause no actual harm). - Reopen the 'Plugins' page of your Q2A site admin panel and check that the listing has been updated. We're on our way! @@ -70,7 +71,7 @@ In this step we will create the initial version of the widget module which displ } ``` - This is the beginning of the PHP class that will define the widget's functionality. The `allow_template()` function is one of three class functions required in a widget module ([more here](/plugins/modules-widget/)). It is called by Q2A to determine which types of pages the widget can be displayed on. In this case, the widget can only be displayed on pages listing recent questions for a tag, so the function only returns `true` if the `$template` parameter is `'tag'`. + This is the beginning of the PHP class that will define the widget's functionality. The `allow_template()` function is one of three class functions required in a widget module ([more here]({{ site.baseurl }}/plugins/modules-widget/)). It is called by Q2A to determine which types of pages the widget can be displayed on. In this case, the widget can only be displayed on pages listing recent questions for a tag, so the function only returns `true` if the `$template` parameter is `'tag'`. - Add the following two additional functions **inside** the `class` definition in `qa-tag-desc-widget.php`: @@ -99,7 +100,7 @@ In this step we will create the initial version of the widget module which displ ); ``` - Each parameter to `qa_register_plugin_module()` is explained by a comment in the code above - [more here](/plugins/). + Each parameter to `qa_register_plugin_module()` is explained by a comment in the code above - [more here]({{ site.baseurl }}/plugins/). - Now it's time to test out the widget. Ensure you have saved/uploaded the `qa-plugin.php` and `qa-tag-desc-widget.php` files. Then open the 'Layout' section of your Q2A site admin panel. The list of available widgets should include the name 'Tag Descriptions'. Click 'add widget' next to it, and choose to display the widget somewhere on tag pages. Note how the options shown in the admin panel reflect the widget module's responses from `allow_template()` and `allow_region()`. @@ -132,7 +133,7 @@ In this step we will create the page module that allows tag descriptions to be e } ``` - The `match_request()` function let a page module decide if it will process a particular web page request. The `$request` parameter is always slash-separated, independent of the URL structure used by a particular Q2A site - [more here](/plugins/modules-page/). We have decided that the URLs for our tag description editor will take the form `tag-edit/*` where `*` is the tag to be edited. For now, the `process_request()` function in the page module generates an empty page for these requests. + The `match_request()` function let a page module decide if it will process a particular web page request. The `$request` parameter is always slash-separated, independent of the URL structure used by a particular Q2A site - [more here]({{ site.baseurl }}/plugins/modules-page/). We have decided that the URLs for our tag description editor will take the form `tag-edit/*` where `*` is the tag to be edited. For now, the `process_request()` function in the page module generates an empty page for these requests. - Activate the page model within the plugin by pasting the following code at the end of your `qa-plugin.php` file: @@ -203,7 +204,7 @@ In this step we will get the tag description editing page up and working. There is a lot happening here, so let's go through it step by step: - - First, we include the Q2A core file `qa-db-metas.php`, since we will need use some of its functions to access the Q2A database table for tag meta information. (If necessary, modules can also create their own database tables by implementing the `init_queries()` function - [more here](/plugins/modules/)). + - First, we include the Q2A core file `qa-db-metas.php`, since we will need use some of its functions to access the Q2A database table for tag meta information. (If necessary, modules can also create their own database tables by implementing the `init_queries()` function - [more here]({{ site.baseurl }}/plugins/modules/)). - The main work consists of adding an element with key `'form'` to the `$qa_content` array. This element describes a form on the page, which is converted by the Q2A theme class into appropriate HTML code. (To add more forms to the page, more elements could be added with keys `'form2'`, `'form_extra'`, or anything else beginning with `'form'`.) @@ -268,7 +269,7 @@ In this step we will get the tag description editing page up and working. } ``` - The `output_widget()` function now identifies which tag page is being requested, retrieves the appropriate tag description from the database, and displays it if it exists, after HTML escaping. An appropriate link to edit the description is also shown, using Q2A's `qa_path_html(...)` function to create an HTML-escaped relative URL to the tag editor page - [more here](/code/functions/). + The `output_widget()` function now identifies which tag page is being requested, retrieves the appropriate tag description from the database, and displays it if it exists, after HTML escaping. An appropriate link to edit the description is also shown, using Q2A's `qa_path_html(...)` function to create an HTML-escaped relative URL to the tag editor page - [more here]({{ site.baseurl }}/code/functions/). - Save/upload as usual. If everything is in place, you should be able to view your descriptions on the tag page, click to edit them on a different page, and then click to save and view them back again on the tag page. Congratulations! @@ -290,7 +291,7 @@ In this step we will implement the tooltips which display tag descriptions when } ``` - This `qa_tag_html()` function will override the standard version of that function, which we saw just before. However our version makes uses of the standard function by calling it using the name `qa_tag_html_base()` - [more here](/plugins/overrides/). Instead of passing through the `$tag` as is, we add underscores before and after it, so that we can test that the override is working. Note that the optional `$favorited` parameter was added in Q2A 1.6, but this code will still work fine in Q2A 1.5.x, with PHP ignoring the extra unexpected parameter. + This `qa_tag_html()` function will override the standard version of that function, which we saw just before. However our version makes uses of the standard function by calling it using the name `qa_tag_html_base()` - [more here]({{ site.baseurl }}/plugins/overrides/). Instead of passing through the `$tag` as is, we add underscores before and after it, so that we can test that the override is working. Note that the optional `$favorited` parameter was added in Q2A 1.6, but this code will still work fine in Q2A 1.5.x, with PHP ignoring the extra unexpected parameter. - Activate the function override by pasting the following line at the end of your plugin's `qa-plugin.php`: @@ -326,7 +327,7 @@ In this step we will implement the tooltips which display tag descriptions when Let's explain this function step by step: - - First, we call the standard version of the function using `qa_tag_html_base()` and store the standard HTML to represent a tag in the variable `$taghtml`. By calling through to the base function rather than copying its code here, we protect ourselves better against changes in future versions of Q2A. We also enable multiple plugins to override the same function for different purposes, with Q2A building an appropriate chain of renamed functions that call each other in turn. If possible, it is always a good idea to do this when overriding a function - [more here](/plugins/overrides/). + - First, we call the standard version of the function using `qa_tag_html_base()` and store the standard HTML to represent a tag in the variable `$taghtml`. By calling through to the base function rather than copying its code here, we protect ourselves better against changes in future versions of Q2A. We also enable multiple plugins to override the same function for different purposes, with Q2A building an appropriate chain of renamed functions that call each other in turn. If possible, it is always a good idea to do this when overriding a function - [more here]({{ site.baseurl }}/plugins/overrides/). - We retrieve the description for `$tag` from the database, using `qa_db_tagmeta_get()` in the same way as before. @@ -413,7 +414,7 @@ In the second stage, a layer will replace the `post_tag_item()` function in Q2A' - Then `$plugin_tag_desc_list` is set to `null` so that this branch is skipped next time `post_tag_item(...)` is called. - - Finally, we call through to the `post_tag_item()` function in Q2A's base theme class using PHP's double colon notation - [more here](/plugins/layers/). Note how base functions are called differently for overrides and for layers. + - Finally, we call through to the `post_tag_item()` function in Q2A's base theme class using PHP's double colon notation - [more here]({{ site.baseurl }}/plugins/layers/). Note how base functions are called differently for overrides and for layers. - As with modules and overrides, we need to activate the layer by adding this in our plugin's `qa-plugin.php` file: @@ -457,7 +458,7 @@ In the second stage, a layer will replace the `post_tag_item()` function in Q2A' - As before, we check if the global `$plugin_tag_desc_list` array variable contains any items, If so, we need to retrieve some tag descriptions from the database. - - We retrieve all the tag descriptions in one database query. There is no function to retrieve metadata for multiple tags in `qa-db-metas.php`, so we write and run the query ourselves using Q2A's `qa_db_query_sub()` function. This substitutes `^` in the query string for the Q2A table prefix set in `qa-config.php`. It also substitutes `$` and `#` for any additional parameters passed, escaping them to ensure the SQL is secure - [more here](/code/functions/#database-access-in-qa-dbphp). In this case, the `$` symbol will be turning into a comma-separated list of tags in `array_keys($plugin_tag_desc_list)`. + - We retrieve all the tag descriptions in one database query. There is no function to retrieve metadata for multiple tags in `qa-db-metas.php`, so we write and run the query ourselves using Q2A's `qa_db_query_sub()` function. This substitutes `^` in the query string for the Q2A table prefix set in `qa-config.php`. It also substitutes `$` and `#` for any additional parameters passed, escaping them to ensure the SQL is secure - [more here]({{ site.baseurl }}/code/functions/#database-access-in-qa-dbphp). In this case, the `$` symbol will be turning into a comma-separated list of tags in `array_keys($plugin_tag_desc_list)`. - The `$result` obtained from the database query is turned into a map from tags to descriptions using Q2A's `qa_db_read_all_assoc()` function - see the function's definition in `qa-db.php`. The map is stored in the global `$plugin_tag_desc_map` variable so that it is available every time our `post_tag_item()` function is called. @@ -539,7 +540,7 @@ In this step, we will add an options form to the plugin which controls how the t The `admin_form()` function can also be added to any module, and enables that module to display a form on the 'Plugins' page of the Q2A admin panel. The function returns a Q2A form definition array for display on the page, after processing any appropriate user input. Most of this should be familiar from our earlier encounter with a Q2A form, but a few things are new: - - We're using Q2A's `qa_opt()` function to both set and retrieve option values - [more here](/code/functions/). + - We're using Q2A's `qa_opt()` function to both set and retrieve option values - [more here]({{ site.baseurl }}/code/functions/). - An element `'ok'` is used to add a confirmation message at the top of the form. - An element `'suffix'` is used within field definitions to show some text after the field. @@ -684,7 +685,7 @@ In this final step we will make your plugin ready for localization into differen ); ``` - This sets up localization for your plugin. The `*` in the file name passed to `qa_register_plugin_phrases()` will be substituted for language codes such as `fr` or `ru`, or `default` to load the default phrases. The second parameter `'plugin_tag_desc'` sets the prefix for retrieving your language strings using Q2A's `qa_lang()` or `qa_lang_html()` functions - [more here](/plugins/). + This sets up localization for your plugin. The `*` in the file name passed to `qa_register_plugin_phrases()` will be substituted for language codes such as `fr` or `ru`, or `default` to load the default phrases. The second parameter `'plugin_tag_desc'` sets the prefix for retrieving your language strings using Q2A's `qa_lang()` or `qa_lang_html()` functions - [more here]({{ site.baseurl }}/plugins/). - Find the line in `qa-tag-desc-widget.php` containing the phrase `Create tag description` and replace it with: @@ -746,4 +747,4 @@ If you made it this far, congratulations! This completes the tutorial. To recap, To check you followed the instructions correctly, you can [download the completed plugin](http://www.question2answer.org/releases/q2a-tag-descriptions-tutorial.zip). -Now you can think about the plugin that **you** want to build and how to go about it. To get started, take a look at the different [types of module](/plugins/modules/) that Q2A supports - as of Q2A 1.5, there are ten available, and we only covered two in this tutorial. You should also take a look at this list of useful [Q2A functions](/code/functions/) and have a browse around the Q2A source code to learn about many more. Finally, take a look at the code of the [many plugins](/addons/) already developed for Q2A. Thank you and good luck! +Now you can think about the plugin that **you** want to build and how to go about it. To get started, take a look at the different [types of module]({{ site.baseurl }}/plugins/modules/) that Q2A supports - as of Q2A 1.5, there are ten available, and we only covered two in this tutorial. You should also take a look at this list of useful [Q2A functions]({{ site.baseurl }}/code/functions/) and have a browse around the Q2A source code to learn about many more. Finally, take a look at the code of the [many plugins]({{ site.baseurl }}/addons/) already developed for Q2A. Thank you and good luck! diff --git a/services.md b/services.md index cb5ba2a..07f791c 100644 --- a/services.md +++ b/services.md @@ -1,6 +1,7 @@ --- layout: page title: "Question2Answer - Services" +slug: singlepage-services --- # Question2Answer service providers diff --git a/themes/index.md b/themes/index.md index f95a544..175e006 100644 --- a/themes/index.md +++ b/themes/index.md @@ -1,6 +1,7 @@ --- layout: page title: "Question2Answer - Developers - Themes" +slug: themes --- # Creating themes for Question2Answer @@ -31,7 +32,7 @@ Question2Answer supports multiple themes, and makes it easy for you to create yo Some of this metadata will be displayed next to the theme setting in the Q2A admin interface. In addition, `Theme Update Check URI` allows you to inform users about new versions of the theme. Q2A will retrieve the content from `Theme Update Check URI`, and look for metadata in the same format as above. If the `Theme Version` values don't match, a message will show up, along with a link to the `Theme URI` from the online metadata. The simplest way to use this mechanism is to keep the latest version of `qa-styles.css` at a particular location online, and set that location as the `Theme Update Check URI`. -6. Please consider offering your theme online as a .zip file for others to download, then [telling us](http://www.question2answer.org/feedback.php) so we can [link to it here](/addons/). +6. Please consider offering your theme online as a .zip file for others to download, then [telling us](http://www.question2answer.org/feedback.php) so we can [link to it here]({{ site.baseurl }}/addons/). ## Creating an advanced theme for Question2Answer diff --git a/translate/index.md b/translate/index.md index 93102ba..dedbfc4 100644 --- a/translate/index.md +++ b/translate/index.md @@ -1,11 +1,12 @@ --- layout: page title: "Question2Answer - Developers - Translation / Localization" +slug: translate --- # Translating Question2Answer into another language -Question2Answer fully supports non-English languages and is easy to translate. Before proceeding, it's worth [checking here](/addons/translations/) to see if a translation is already available. You may be able to use this immediately, or only have to add some missing phrases. +Question2Answer fully supports non-English languages and is easy to translate. Before proceeding, it's worth [checking here]({{ site.baseurl }}/addons/translations/) to see if a translation is already available. You may be able to use this immediately, or only have to add some missing phrases. ## Creating a new translation @@ -31,7 +32,7 @@ To create a new Question2Answer translation from scratch, follow the steps below 7. **`qa-check-lang.php` is your friend!** As you work, use your web browser to view the `qa-include/qa-check-lang.php` page within your Question2Answer site. This will check your language files for any omitted phrases or substitutions. -8. Please consider sending us your translation or making it available online, so that we can [link to it here](/addons/translations/). +8. Please consider sending us your translation or making it available online, so that we can [link to it here]({{ site.baseurl }}/addons/translations/). ## Updating an existing translation @@ -52,7 +53,7 @@ An incomplete Question2Answer translation may be available for your language, fo 5. As you work, refresh `qa-include/qa-check-lang.php` in your web browser and ensure that you resolve all issues shown. You can also browse around your Q2A site to see how the translated phrases are used in context. -6. Please consider sending us your translation or making it available online, so that we can [link to it here](/addons/translations/). +6. Please consider sending us your translation or making it available online, so that we can [link to it here]({{ site.baseurl }}/addons/translations/). ## Customizing selected URLs or phrases