v 12.0 Third Party 6
Live Preview
Required Apps Website (website)
Included Dependencies
Technical Name documentation_builder
LicenseSee License tab
Websitehttps://odootools.com/apps/12.0/odoo-documentation-builder-476
Also available in version v 13.0
You bought this module and need support? Click here!
Required Apps Website (website)
Included Dependencies
Technical Name documentation_builder
LicenseSee License tab
Websitehttps://odootools.com/apps/12.0/odoo-documentation-builder-476
Also available in version v 13.0

Clear and full documentation is a way to highlight seriousness of your project, to cut costs by motivating clients for self-service, and to reveal hidden organizational knowledge. However, creating and, more important, supporting documentation site is a complex task. This tools aims to help with that.

With KnowSystem you gradually prepare materials which might be already used as a shared online library. Simultaneously, navigating by independent articles becomes harder, and you decide to combine knowledge into chapters. The idea is to have a single documentation website page which fully covers a definite issue or aspect. The app Odoo Documentation Builder let you efficiently achieve that goal.

This is an extension to the tool KnowSystem. Read the full description of the features and optional modules on the core module page.

Structured and Customizable Documentation

The tool allows preparing an unlimited number of documentation pages structured by categories. You can also modify appearance of pages: show or hide introductions and footers, turn on/off search bar and table of contents, add or remove preview images and texts. Comfortable for navigation, easy to maintain.

Documentation by categories and sections

Odoo documentation overview

Documentation page

Odoo website documentation

Configure documentation overview page

Documentation overview optional features

Custom options for documentation

Documentation custom optional features

Categorize documentation pages per website

Documentation categories, sections, and versions

Simple to Prepare and Update

To create a new documentation section just select and order KnowSystem articles. The app would generate a website page automatically. Moreover, each article revision would be reflected on this page on a fly, while to update this documentation set you need just to add or to remove an article.

Compose articles for documentation

Documentation construction

Add KnowSystem articles to documentation

Construct documentation as a set of articles

Dynamic Navigation

Table of contents for documentation is constructed automatically according to article headers. In such a way, end users might navigate to a target documentation piece in a single click. Moreover, when a visitor scrolls a page, navigation panel dynamically shows where she/he is now. The feature might be turned off at any moment.

Automatic table of contents by documentation

Comfortable navigation by documentation page

Show / hide table of contents

Expandable table of contents

Inline Search

To address very specific aspects, end users often would require inspecting materials for definite key words. The tool covers that case by introducing the optional search bar inside each documentation page. It is possible to find matches in a whole text or only in headers, to make key words case sensitive or insensitive.

Inline search by documentation

Documentation page search navigation

Documentation Versioning

When you prepare specifications, user manuals or software guidelines, you inevitable face the situation when certain articles are suitable only for definite product versions. Simultaneously, the most of materials are fine for all versions. To avoid double work in such a case, the app let indicate to which version an article relates to. Thus, only topical materials would be shown.

Documentation Security

Documentation categories and sections are designed for a shared use, although you at any moment can restrict both portal and public accesses on the configuration page. Each category or section might be unpublished, for example, for the period of re-construction. Besides, it is possible to limit particular documentation page for chosen portal partners using KnowSystem tags (in the same way it is done for articles). The latter allows you, for instance, to sell valuable materials.
Access to articles (documentation parts) is regulated by the app KnowSystem, where you can manage rights for public and portal users. This tool, however, let you overcome this regulation by selecting a security action. In particular, it is possible to fully neglect access rights (always show an article disregarding rights), show warning if no access is possible (good for paid access for materials), or use standard approach (articles would not be shown at all for limited users; so documentation would look differently for different users).

Documentation settings

Manage Odoo documentations

Documentation builder settings

Set up your own Odoo documentation

Security: optionally show warning if no access possible

Documentation access warning

Multi Websites

The tool supports multi website environment. In particular, it is possible to show/hide documentation pages for definite sites, to have different categories for different portals, and to have own settings per each platform.
  1. Restart your Odoo server and update the module

  2. Clean your browser cache (Ctrl + Shift + R) or open Odoo in a private window.

According to the current Odoo Apps Store policies:

  • every module bought for the version 12.0 and prior gives you an access to the all versions up to 12.0.

  • starting from the version 13.0, every version of the module should be purchased separately.

  • disregarding the version, purchasing a tool grants you a right for all updates and bug fixes within a major version.

Take into account that Odoo Tools team does not control those policies. By all questions please contact the Odoo Apps Store representatives directly.

Sorry, but no. We distribute the tools only through the official Odoo apps store

  1. Unzip source code of purchased tools in one of your Odoo add-ons directory

  2. Re-start the Odoo server

  3. Turn on the developer mode (technical settings)

  4. Update the apps' list (the apps' menu)

  5. Find the app and push the button 'Install'

  6. Follow the guidelines on the app's page if those exist.

Yes, all modules marked in dependencies are absolutely required for a correct work of our tool. Take into account that price marked on the app page already includes all necessary dependencies.  

Red / orange warning itself does not influence features of the app. Regretfully, sometimes our modules do not pass standard automatic tests, since the latter assumes behavior which is in conflict with our apps goals. For example, we change price calculation, while standard Odoo module tests compare final price to standard algorithm.

So, first of all, please check deployed database features. Does everything work correctly?

If you still assume that warning influences real features, please contact us and forward full installation logs and the full lists of deployed modules (including core and third party ones).

Yes, sure. Take into account that Odoo automatically adds all dependencies to a cart. You should exclude previously purchased tools.

Regretfully, we do not have a technical possibility to provide individual prices.

As soon as you purchased the app, the button 'Deploy on Odoo.sh' will appear on the app's page in the Odoo store. Push this button and follow the instructions.

Take into account that for paid tools you need to have a private GIT repository linked to your Odoo.sh projects

No, third party apps can not be used on Odoo Online.

Documentation by categories and sections

Odoo documentation overview

Documentation page

Odoo website documentation

Automatic table of contents by documentation

Comfortable navigation by documentation page

Inline search by documentation

Documentation page search navigation

Show / hide table of contents

Expandable table of contents

Configure documentation overview page

Documentation overview optional features

Custom options for documentation

Documentation custom optional features

Compose articles for documentation

Documentation construction

Documentation settings

Manage Odoo documentations

Add KnowSystem articles to documentation

Construct documentation as a set of articles

Documentation builder settings

Set up your own Odoo documentation

Categorize documentation pages per website

Documentation categories, sections, and versions

Security: optionally show warning if no access possible

Documentation access warning

Odoo demonstration databases (live previews)

For this app we might provide a free demo database.

To demand such database: press the button "Live Preview" on the top of this page or copy the link ${object.support_url}&url_type_id=3

No phone number or credit card are required to contact us: only a short email sign up which does not take more than 30 seconds.

By your request we will prepare an individual live preview database, where you would be able to apply any tests and to check assumptions during 14 days.

Bug reporting

In case you have faced any bugs or inconsistent behavior, do not hesitate to contact us. We guarantee to provide fixes during 60 days after a purchase, while even after this period we are strongly interested to improve our tools.

To send us a bug report: press the "Website" link on the top of this page and push the button "Bug Report" (the tab Support). Alternatively, copy the link ${object.support_url}&url_type_id=1

No phone number or credit card are required to contact us: only a short email sign up which does not take more than 30 seconds.

Please include in your request as many details as possible: screen shots, Odoo server logs, full description of how to re-produce your problem, and so on. Usually it takes a few business days to prepare a working plan by an issue (if a bug is confirmed) or provide you with guidelines what should be done (otherwise).

Public features request and module ideas (free development)

We are strongly motivated to improve our tools and would be grateful for any sort of feedback. In case your requirements are of public use and might be efficiently implemented, the team would include those into our to-do list.

Such to-do list is processed on a regular basis and does not assume extra fees. Altough we cannot promise deadlines and final design, it might be a good way to get desired features without investments and risks.

To share ideas: press the "Website" link on the top of this page and push the button "Share Features Ideas" (the tab Support). Alternatively, copy the link ${object.support_url}&url_type_id=5

No phone number or credit card are required to contact us: only a short email sign up which does not take more than 30 seconds.

New features and extra Odoo services (individual development)

Each of our apps might be customized and extended to suit your specific requirements.

Our customization team (itlibertas.com) fulfills not only such jobs but it also provides a full range of Odoo services. From simple modifications and consultations to complex enterprise projects. The team has completed over 100 implementations since 2012, and might help with any technical or business needs.

To contact us for details and conditions: press the "Website" link on the top of this page and push the button "Request Individual Customization" (the tab Support). Alternatively, copy the link ${object.support_url}&url_type_id=2

No phone number or credit card are required to contact us: only a short email sign up which does not take more than 30 seconds.

Questions and misc issues

Feel free to contact us by any other concerns, doubts, or questions: press the "Website" link on the top of this page and push the button "Raise Question" (the tab Support). Alternatively, copy the link ${object.support_url}&url_type_id=4

About the team

Odoo Tools (odootools.com) is the team of developers and business analysts to help you extend Odoo potential. We have been communicating with end users to whom the software became the main business tool since 2012. As a result, we are proud of dozens of successful Odoo apps developed. We are open for new ideas and challenges to create the best Odoo tools for business needs all over the world.

You may like the tools

KnowSystem

The tool to build deep and structured knowledge base for internal and external use

228 205
Joint Calendar

The tool to combine different Odoo events in a few configurable super calendars. Shared calendar. Common calendar.

74 66
Password Manager

The tool to safely keep passwords for shared use

144
Universal Appointments and Time Reservations

The tool for time-based service management from booking appointment to sale and reviews

399 199
URL Transliterations for Website Pages

The tool to translate URL addresses of Odoo website pages

49
Smart Alerts

The tool to draw users' attention to important document warnings and details

44
Google Drive Odoo Integration

The tool to automatically synchronize Odoo attachments with Google Drive files in both ways

394
OwnCloud / NextCloud Odoo Integration

The tool to automatically synchronize Odoo attachments with OwnCloud / NextCloud files in both ways

394
OneDrive / SharePoint Odoo Integration

The tool to automatically synchronize Odoo attachments with OneDrive files in both ways

394
Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.