Website Documentation
| Lines of Code | 9377 |
| Technical name | to_website_docs |
| License | OPL-1 |
| Website | https://viindoo.com/apps/modules/17.0/to_website_docs |
| Read description for | v 10.0 v 11.0 v 12.0 v 13.0 v 14.0 v 15.0 v 16.0 v 18.0 |
| Required Apps | Discuss (mail) Website (website) |
| Included Dependencies | TVTMA Website Base |
| Extensions | Website Odoo Versioning Documentation |
A documentation site: subjects, sections, categories, documents, versions of content
Write documentation in the backend or on the page - categories in a tree, documents with several contents that go draft, confirmed, approved, published - with tags, languages, public visibility rules, an intro built from the text, an index from the headings, search, and a merge wizard.
Website Documentation (technical name to_website_docs) is an Odoo 17.0 app for Odoo Community and Odoo Enterprise and Viindoo Cloud, built for technical writer, reader.
At a Glance
The facts of Website Documentation, version 0.1.5, in one place. Published by Viindoo.
How It Works
Create the category tree; write documents; confirm, approve, publish.
Site
Subjects and sections.
Category
Its documents.
Document
Index from headings.
Documents
States.
Form
Contents and tags.
Contents
One per version.
Categories
Subjects, sections, categories.
Category form
Public and private.
What You Get
Category tree with covers and layout
Documents with several contents
Draft, confirmed, approved, published
Tags and languages
Public and private visibility rules
Intro and index generated
Editing from the page
Search and merge
What This App Does Not Do
Read this before you buy. Everything below is something the app deliberately leaves to another app or to you.
HTML content.
Otherwise one content.
Works Well With
Apps from the same stack, built to fit this one:
Who Should Use Website Documentation?
Technical writer
The RJE import guide, reviewed then published.
Reader
Search and tags.
Frequently Asked Questions
What does Website Documentation do?
Write documentation in the backend or on the page - categories in a tree, documents with several contents that go draft, confirmed, approved, published - with tags, languages, public visibility rules, an intro built from the text, an index from the headings, search, and a merge wizard.
What does Website Documentation not do?
No file attachments as documents. HTML content. Versions of content are per Odoo version only with the Odoo Docs add-on. Otherwise one content.
Who is Website Documentation for?
Technical writer: The RJE import guide, reviewed then published. Reader: Search and tags.
Which Odoo version and editions does it support?
Odoo 17.0 - Odoo Community, Odoo Enterprise, Viindoo Cloud. Upgrades to a newer Odoo series are a separate purchase for that series.
What does it depend on?
It installs on top of: to_website_base, rating. Odoo installs them with it.
How do I set it up?
Create the category tree; write documents; confirm, approve, publish.
What works well with it?
Odoo Docs (to_website_docs_odoo): Content per Odoo version. Odoo Docs Data (to_website_docs_odoo_data): Default categories.
Can I try it before buying?
Yes - the Live Preview button at the top of this page opens the module's own screen on a working database.
How do I get support?
Write to apps.support@viindoo.com with your Odoo version and the technical name to_website_docs; pre-sales questions go to sales@viindoo.com.
See Website Documentation in Action
Live demo: v17demo-int.viindoo.com/web#action=to_website_docs.document_action
Need help with Website Documentation?
For questions, implementation support or a custom feature, contact Viindoo.
Pre-Sales & Partnership
sales@viindoo.comUpgrades to a newer Odoo series are a separate purchase for that series.
All Viindoo apps: apps.odoo.com/apps/modules/browse?author=Viindoo
Technical Requirement
Changes log
0.1.5 - Latest on the 17.0 line
- Aligned with the 17.0 models and views.
Installation
- Navigate to Apps.
- Search with keyword to_website_docs.
- Press Install.
Instruction
Instruction video: Website Documentation
Granting access rights to user
First, you need to grant access rights to user appropriate rights to fulfill the job function when using the Website Documentation software.
Create a new documentation
Website Documentation software allows you to create and manage documents in a hierarchical form such as a directory tree structure to easily search for information and support work.
So, to create a documentation, you need to do the following steps:
1. Create a subject.
Subject is the main subject of the documentation you provide and is the highest hierarchy of the document. Navigate to Website > Documentation > Subject > Create to create a new documentation.
2. Create a section.
Section is the sub-hierarchy of the subject. For example, the subject is User Documentation including the section on Experimental Information and Applications.
3. Create a category.
Category is the main content group in the section. Categories will be arranged in the respective Section area on the Website. For example, CRM, HR categories in the Apps section.
4. Create a document.
You need to create corresponding documentation in categories to contain the content you want to convey by navigating to Website > Documentation > Document > Create.
5. Create the content of the document.
Navigate to Website > Documentation > Document Contents > Create to create the content of the document.
The Website will view the following:
Approve and publish documents
1. Approve documents and the content of documents.
- With documents are created and validated, the person with approval authority will check and approve/reject the document.
- Then, the approver will approve/reject the contents of that document to determine whether the content is eligible for publishing.
2. Publish documents.
With approved documents and content, you can publish them on the Website.
Manage documents
1. Edit Website documents.
On the Website view, you can make adjustments to the modules you have created. For example, with the category, you can edit the name, change the background image, background color, arrange the order,...
2. Merge documents.
When you want to merge 2 documents into 1 composite document, on the Document view, click Actions > Documents Merging Wizard. After merging, the contents of the source Document are all transferred to the target Document.
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.