in news

Blog toolbox components


Blog toolbox list of components

  1. Post SEO
  2. Post search
  3. Post tags
  4. Related posts
  5. Visit count
  6. User (Author) profile
  7. Newsletter subscribe (sign-up)
  8. Newsletter update/unsubscribe page

Post SEO component

This component is responsible for injecting SEO data you provided in post object into default OctoberCMS page SEO properties, excluding OG tags which you will have to manually put into your head elements, since OctoberCMS does not support OG tags by default. This component will magically extract SEO data and provide you an easy way of integrating on your layout. Other than standard title and description meta tags you also have fields such as robot follow, indexing options, canonical url, OG:title, OG:description and OG:image.

If you have trouble with setting your SEO properties, this component will help you easily set up your SEO strategy and increase your ranking on search engines.

Post Search component

PostSearch component will give you the option to add search feature on your website to provide your users with easier navigation. This component has some options that can be configured.

Configuration options

  • Post title
    • If checked, text inserted into input will search posts by title
  • Post content
    • If checked, text inserted into input will search posts by content
  • Sort posts
    • Dropdown menu with options to sort collection from latest posts or oldest
  • Category filter
    • Dropdown menu with categories listed, with this you can narrow the search on particular blog category

Side note: If you select both post title and post content options, it will combine them. Users can search posts both by title and by content, but this will not duplicate posts results.

Post Tags component

PostTags component is something similar to default category component of extended RainLab.Blog plugin, but we felt tags would be nice addition to bring more categorization options.

This component will allow you to create page which will behave like sorting option to display posts which have a particular tag assigned to. This component takes in GET parameter into slug and by default that parameter is :tag.

With that in mind, it is possible to create great interconnectivity between posts, for example you have a restaurant website and you use blog posts as menu builder. With this component you can add tag „vegetarian“ and link it, so when user clicks on that tag it will give him list of meals you've prepared for vegetarian customers.

RelatedPosts component works with PostTags component. It uses tags you've set on your posts to find similar posts based on currently read posts by your visitor. This component puts the GET parameter into slug and by default that parameter is :slug.

It has an option which allows you to set how many related posts should be retrieved with this component (it takes numbers). Also, it allows you to limit how many posts are displayed on a single post page.

Visit count component

VisitCount component is a simple tool, yet it can be powerful when you are trying to figure out your reader's interests. This component should be attached to a single post page. This component injects simple javascript code, which uses cookies as a mechanism to track if a user is visiting that post for the first time or if it is a revisit. If you use this component, you should take into consideration updating cookie policy on your website so that GDPR won't be broken in the EU.

User profile component

UserProfile component is extending User component. With this component you can create an Author profile/bio page. This component puts the GET parameter into slug and by default that parameter is :user-slug. By extending User with our toolbox, this component will give you ability to display user's bio text, contact email (which is not the default system email) and social network links (so far we have added Facebook, Twitter, YouTube, Instagram, LinkedIn, Medium and Twitch platforms). User profile also has another field: “business position”, where you can specify a position inside a company if you are working on a corporate website.

Another great feature about this component is that it can also retrieve posts created by that author. In this way, you can create a great author page and give your visitors personal insight with addition of being able to show them authors publications.

Newsletter subscribe component

Newsletter Subscribe is a component that allows you to add newsletter form signup. This component uses default categories of RainLab.Blog as a list of options your user can sign for. In order for this component to retrieve a certain category, you have to tick the newsletter option inside the category located in the backend. Great thing about this component is that it handles data saving with AJAX and gives back response which you can use to notify users of its success or error. JSON response looks like this: [status:0 or 1, success or error: pre-defined message].

When a user subscribes successfully, welcome email will be sent to the provided address alongside a nice welcome message and link for changing options or to unsubscribe.

Note that design of the form can be changed, but keep in mind, if you are changing ID's on elements, you have to also change javascript code so the form can continue to work properly. Important thing is that your input names stay the same in order for form to function properly

Newsletter options component

Newsletter options is a component that is connected with the Newsletter Subscribe component and is a crucial part of the whole newsletter feature. This component is different from the previous one and is used only as a page where a user can change his subscription options or unsubscribe from your newsletter.

Whole newsletter feature works with auto generated tokens which have two days duration. When a user subscribes or if a new post is created, published and selected as a newsletter, a new token will be generated and sent to the user as part of the link which should point at the page with this component. In that retrospective, this component puts the GET parameter into slug and by default that parameter is :token.

When a user lands on a page with this component, the user will be asked to insert his email address and then the component will check if the token from slug is matching the user's email. If a token is matched, the user will get a display of his selected options where he can change them or unsubscribe from all of them. In case the token is expired, a button is displayed which regenerates the token and sends new email to the user. User is then supposed to open that email and click on the updated link for changing his preferences. After he clicks on that link, he’ll once again land on the page to repeat the process.

Buy blog toolbox plugin - 13 USD

Prev: Plugin introduction Next: Controllers