Helpjuice Knowledge Base

How to create custom redirects via JavaScript?

Published September 24th, 2024 by Guilherme Arantes

Custom redirects are redirects that are not covered on the Article Redirects feature, learn more at How to Create Article/URL Redirects . For instance: Redirects from valid URLs on your KB; Redirects based on search parameters or event listeners; In order to redirect users before the page is fully loaded, place the code in the Main Layout file, insi

Shopify/Liquid Global Objects

Published May 20th, 2020 by Guilherme Arantes

This is the complete list of the global objects available on the template engine. Initially, the global objects can be grouped by: Verification variables: Information about the current page; User/Account variables: Information about the user and the knowledge base account; Template variables: Information related to the template; Content related vari

Helpjuice's Template Engine

Published May 20th, 2020 by Guilherme Arantes

A Template Engine replaces variables in the template files with actual values, and transforms the template into the final file. Helpjuice's Template Engine is based on Liquid and nine default files. These files contains all the code needed to display the support site completely such as HTML code for different page types, javascript and css files. Th

Index Page Concept

Published May 20th, 2020 by Guilherme Arantes

The index page is the first page loaded when accessing the Knowledge Base. It usually counts with a grid containing the all categories or at least the top categories to ensure a friendly navigation to the end-user. Check the Standard Sections article ‍to obtain a comprehensive list of sections. Index Page on the Helpjuice's Template Engine The highl

Troubleshooting: Missing glossary terms or definitions on article body.

Published March 2nd, 2023 by Guilherme Arantes

If glossary terms are not being highlighted on the article body, or if the definition of the terms is not being displayed on hover, it could be due to a missing line of code or attribute in the KB. To enable the glossary feature, the following code should be present on your Knowledge Base: On the main layout file: <link rel="stylesheet" href="/kn

Basic Customization Reference

Published May 20th, 2020 by Guilherme Arantes

The Helpjuice's Template Engine provides the Basic Customization Feature. This feature allows you to easily change some basic layout details that the Knowledge Base uses, like links and body colors. Basic Customization The Basic Customization feature can be found under the Basic tab on the Customize Section. It allows you to choose images, colors an

Top Categories Standard Section

Published May 20th, 2020 by Guilherme Arantes

The Top Categories Section is a list of the main categories. Any other category inside the Knowledge Base will be inside these categories, that means that the Top Categories are the most important category type. This is how you can display a list of all the Top Categories: {% if roots_categories.size > 0 %} <h2>Popular Topics</h2> <

Shopify/Liquid Object Syntax

Published May 20th, 2020 by Guilherme Arantes

In order to display the object value, you'll need to make sure it's inside the brackets markup as the following example: <h1>{{ question.name }}</h1> This would output "Shopify/Liquid Object Syntax" on this specific page. Wrong Syntax: <h1>{% question.name %}</h1> <h1>{{ question.name </h1>}} The above examples wo

Shopify/Liquid Filter Syntax

Published May 20th, 2020 by Guilherme Arantes

Every time you need to limit a loop statement or change the output of an object value, you can rely on Liquid Filters. Limit filter The following example is the same example found in the Shopify/Liquid Logic Syntax page‍ plus the limit filter: <ul class="top_categories"> {% for categories in roots_categories | limit: 5 %} <li class="categor

Shopify/Liquid Logic Syntax

Published May 20th, 2020 by Guilherme Arantes

The Liquid Logical Statements are useful if you want to check some variable before displaying it or if you want to create a specific list based on another object. If Statement The If Statement allows you to verify the object value when needed: {% if question.name == "Getting Started" %} <p>Only printed if the question name is "Getting Started"

Shopify/Liquid Complete Objects Reference

Published May 20th, 2020 by Guilherme Arantes

This is the Complete Object Reference. For specific objects, check the grouped version: Global variables - These variables are related to the knowledge base itself. Some of them are template related or account related. See more at Shopify/Liquid Global Objects‍; Category variables - These variables are related to the category object. See more at Sho

Shopify/Liquid Question Objects

Published May 20th, 2020 by Guilherme Arantes

This is the complete list of the question attributes available on the template engine. question.id: Identification number of said question; question.name: Retrieve a String with the full name of the question; question.description: This is the question subtitle; question.category: Fetch the parent category to the specific question and returns as a ob

Categories Navigation Standard Section

Published May 20th, 2020 by Guilherme Arantes

Users might not be searching using the search bar: They may want to navigate through the categories links and its subcategories links. This is how you can create a simple Categories Navigation Section displaying all questions inside them: <ul id="main_navigation"> {% for categories in roots_categories %} <li class="category_item"> <h2

Category Page Concept

Published May 20th, 2020 by Guilherme Arantes

The Category Page holds a list of subsequent categories and questions under the specific category. Check the Standard Sections article ‍to obtain a comprehensive list of sections available to use. The Category Page usually counts with two lists: Subcategories List: Child categories are sub-topics under the specific category; Questions List: All ques

Standard Sections

Published May 20th, 2020 by Guilherme Arantes

The Standard Sections list contains: Recently Updated Articles: This is a list with the most recently updated/created questions. See more information at Recently Updated Standard Section;‍ Root Questions: This is a list with the questions on the root level (the dashboard) - sometimes these questions are very important and need to be highlighted. Se

Shopify/Liquid Documentation

Published May 20th, 2020 by Guilherme Arantes

Helpjuice's template engine is based on Liquid. As Liquid is a template language, it allows you to control the logic flow and use objects while creating amazing templates for web pages. There are three main groups of available objects on the template engine: Global variables - These variables are related to the knowledge base itself. Some of them ar

Question Page Concept

Published May 20th, 2020 by Guilherme Arantes

The Question Page is the page loaded everytime a user access a question. This is the most important page in the Knowledge Base, several sections can be used to improve navigation between related topics and relevant content. Question Page Concept The highlighted section represents the content of the Question Page theme file located on the customize s

Shopify/Liquid Category Objects

Published May 20th, 2020 by Guilherme Arantes

This is the complete list of the category attributes available on the template engine. category.id: Identification number of said category; category.name: Retrieve a String with the full name of the question; category.description: category.image_url: category.is_internal?: Boolean value returns true if the question is indeed internal; category.has_c

Contextual Sections Guide / Custom (Category) Pages

Published May 20th, 2020 by Guilherme Arantes

It is possible to hide or show different parts of your template according to the current page being accessed using Liquid Tags. You can create Contextual Sections within any template file; for instance, to create a Contact Us Section on the Main Layout, you can use something similar to this code: {% if on_show_question_page %} <!-- content for

Root Questions Standard Section

Published May 20th, 2020 by Guilherme Arantes

During customization, the Root Questions Section can be placed on the Index Page or even on the bottom of every page with a different name such as "Useful links". This is how you can display a list with 10 root questions: {% if root_questions.size > 0 %} <h2>Useful links:</h2> <ul id="root_questions"> {% for question in root_que

Shopify/Liquid Syntax

Published May 20th, 2020 by Guilherme Arantes

As Liquid is a template language, it allows you to control the logic flow and use objects while creating amazing templates for web pages. When it comes to Liquid, there're three concepts you'll need to know: How to get a object value: This is the key to create dynamic pages. Check the Shopify/Liquid Object Syntax‍ article; How to control the logic f