Merge PR #422 into 16.0

Signed-off-by etobella

document_page_reference/README.rst

@@ -0,0 +1,89 @@
+=======================
+Document Page Reference
+=======================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fknowledge-lightgray.png?logo=github
+    :target: https://github.com/OCA/knowledge/tree/15.0/document_page_reference
+    :alt: OCA/knowledge
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/knowledge-15-0/knowledge-15-0-document_page_reference
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/118/15.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module allows to add a reference name on documents and simplifies the link
+between document pages.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+When editing a document page add elements like ${XXX} where XXX is the reference
+of another page. Now, when viewing the document, it will link directly to the page.
+Also, the name will be parsed as the display name.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/knowledge/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/knowledge/issues/new?body=module:%20document_page_reference%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Creu Blanca
+
+Contributors
+~~~~~~~~~~~~
+
+* Enric Tobella <etobella@creublanca.es>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px
+    :target: https://github.com/etobella
+    :alt: etobella
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-etobella| 
+
+This module is part of the `OCA/knowledge <https://github.com/OCA/knowledge/tree/15.0/document_page_reference>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

document_page_reference/__init__.py

@@ -0,0 +1 @@
+from . import models

document_page_reference/__manifest__.py

@@ -0,0 +1,23 @@
+# Copyright 2019 Creu Blanca
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Document Page Reference",
+    "summary": """
+        Include references on document pages""",
+    "version": "16.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "Creu Blanca,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/knowledge",
+    "depends": ["document_page", "web_editor"],
+    "data": [
+        "views/document_page.xml",
+        "views/report_document_page.xml",
+    ],
+    "assets": {
+        "web.assets_backend": [
+            "document_page_reference/static/src/js/**/*",
+        ],
+    },
+    "maintainers": ["etobella"],
+}

document_page_reference/i18n/document_page_reference.pot

@@ -0,0 +1,51 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* document_page_reference
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 15.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: document_page_reference
+#: model:ir.model.fields,field_description:document_page_reference.field_document_page__content_parsed
+msgid "Content Parsed"
+msgstr ""
+
+#. module: document_page_reference
+#: model:ir.model,name:document_page_reference.model_document_page
+msgid "Document Page"
+msgstr ""
+
+#. module: document_page_reference
+#: model:ir.model.fields,field_description:document_page_reference.field_document_page__reference
+msgid "Reference"
+msgstr ""
+
+#. module: document_page_reference
+#: code:addons/document_page_reference/models/document_page.py:0
+#, python-format
+msgid "Reference is not valid"
+msgstr ""
+
+#. module: document_page_reference
+#: code:addons/document_page_reference/models/document_page.py:0
+#, python-format
+msgid "Reference must be unique"
+msgstr ""
+
+#. module: document_page_reference
+#: model:ir.model.fields,help:document_page_reference.field_document_page__reference
+msgid "Used to find the document, it can contain letters, numbers and _"
+msgstr ""
+
+#. module: document_page_reference
+#: model_terms:ir.ui.view,arch_db:document_page_reference.document_page_form_view
+msgid "internal_reference (autofilled if not value is provided)"
+msgstr ""

document_page_reference/i18n/it.po

@@ -0,0 +1,54 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* document_page_reference
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 15.0\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2023-06-23 10:10+0000\n"
+"Last-Translator: mymage <stefano.consolaro@mymage.it>\n"
+"Language-Team: none\n"
+"Language: it\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: nplurals=2; plural=n != 1;\n"
+"X-Generator: Weblate 4.17\n"
+
+#. module: document_page_reference
+#: model:ir.model.fields,field_description:document_page_reference.field_document_page__content_parsed
+msgid "Content Parsed"
+msgstr "Contenuto analizzato"
+
+#. module: document_page_reference
+#: model:ir.model,name:document_page_reference.model_document_page
+msgid "Document Page"
+msgstr "Pagina documento"
+
+#. module: document_page_reference
+#: model:ir.model.fields,field_description:document_page_reference.field_document_page__reference
+msgid "Reference"
+msgstr "Riferimento"
+
+#. module: document_page_reference
+#: code:addons/document_page_reference/models/document_page.py:0
+#, python-format
+msgid "Reference is not valid"
+msgstr "Il riferimento non è valido"
+
+#. module: document_page_reference
+#: code:addons/document_page_reference/models/document_page.py:0
+#, python-format
+msgid "Reference must be unique"
+msgstr "Il riferimento deve essere unico"
+
+#. module: document_page_reference
+#: model:ir.model.fields,help:document_page_reference.field_document_page__reference
+msgid "Used to find the document, it can contain letters, numbers and _"
+msgstr "Utilizzato per trovare il documento, può contenere lettere, numeri e _"
+
+#. module: document_page_reference
+#: model_terms:ir.ui.view,arch_db:document_page_reference.document_page_form_view
+msgid "internal_reference (autofilled if not value is provided)"
+msgstr "internal_reference (auto compilato se non viene fornito un valore)"

document_page_reference/models/__init__.py

@@ -0,0 +1 @@
+from . import document_page

document_page_reference/models/document_page.py

@@ -0,0 +1,150 @@
+# Copyright 2019 Creu Blanca
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+import logging
+
+from odoo import _, api, fields, models, tools
+from odoo.exceptions import ValidationError
+from odoo.tools.misc import html_escape
+
+from odoo.addons.http_routing.models.ir_http import slugify
+
+_logger = logging.getLogger(__name__)
+
+try:
+    import re
+
+    from jinja2 import Undefined
+    from jinja2.lexer import name_re as old_name_re
+    from jinja2.sandbox import SandboxedEnvironment
+
+    name_re = re.compile("^%s$" % old_name_re.pattern)
+
+    class Context(SandboxedEnvironment.context_class):
+        def resolve(self, key):
+            res = super().resolve(key)
+            if not isinstance(res, Undefined):
+                return res
+            return self.parent["ref"](key)
+
+    class Environment(SandboxedEnvironment):
+        context_class = Context
+
+    mako_template_env = Environment(
+        block_start_string="<%",
+        block_end_string="%>",
+        variable_start_string="${",
+        variable_end_string="}",
+        comment_start_string="<%doc>",
+        comment_end_string="</%doc>",
+        line_statement_prefix="%",
+        line_comment_prefix="##",
+        trim_blocks=True,  # do not output newline after blocks
+        autoescape=False,
+    )
+except Exception:
+    _logger.error("Jinja2 is not available")
+
+
+class DocumentPage(models.Model):
+
+    _inherit = "document.page"
+
+    reference = fields.Char(
+        help="Used to find the document, it can contain letters, numbers and _"
+    )
+    content_parsed = fields.Html(compute="_compute_content_parsed")
+
+    def get_formview_action(self, access_uid=None):
+        res = super().get_formview_action(access_uid)
+        view_id = self.env.ref("document_page.view_wiki_form").id
+        res["views"] = [(view_id, "form")]
+        return res
+
+    @api.depends("history_head")
+    def _compute_content_parsed(self):
+        for record in self:
+            content = record.get_content()
+            if content == "<p>" and self.content != "<p>":
+                _logger.error(
+                    "Template from page with id = %s cannot be processed correctly"
+                    % self.id
+                )
+                content = self.content
+            record.content_parsed = content
+
+    @api.constrains("reference")
+    def _check_reference(self):
+        for record in self:
+            if not record.reference:
+                continue
+            record._validate_reference(record=record)
+
+    @api.model
+    def _validate_reference(self, record=None, reference=None):
+        if not reference:
+            reference = self.reference
+        if not name_re.match(reference):
+            raise ValidationError(_("Reference is not valid"))
+        uniq_domain = [("reference", "=", reference)]
+        if record:
+            uniq_domain += [("id", "!=", record.id)]
+        if self.search(uniq_domain):
+            raise ValidationError(_("Reference must be unique"))
+
+    def _get_document(self, code):
+        # Hook created in order to add check on other models
+        document = self.search([("reference", "=", code)])
+        if document:
+            return document
+        else:
+            return self.env[self._name]
+
+    def get_reference(self, code):
+        element = self._get_document(code)
+        if self.env.context.get("raw_reference", False):
+            return html_escape(element.display_name)
+        text = """<a href="#" class="oe_direct_line"
+        data-oe-model="%s" data-oe-id="%s" name="%s">%s</a>
+        """
+        if not element:
+            text = "<i>%s</i>" % text
+        res = text % (
+            element._name,
+            element and element.id or "",
+            code,
+            html_escape(element.display_name or code),
+        )
+        return res
+
+    def _get_template_variables(self):
+        return {"ref": self.get_reference}
+
+    def get_content(self):
+        try:
+            content = self.content
+            mako_env = mako_template_env
+            template = mako_env.from_string(tools.ustr(content))
+            return template.render(self._get_template_variables())
+        except Exception:
+            _logger.error(
+                "Template from page with id = %s cannot be processed" % self.id
+            )
+            return self.content
+
+    def get_raw_content(self):
+        return self.with_context(raw_reference=True).get_content()
+
+    @api.model_create_multi
+    def create(self, vals_list):
+        for vals in vals_list:
+            if not vals.get("reference"):
+                # Propose a default reference
+                reference = slugify(vals.get("name")).replace("-", "_")
+                try:
+                    self._validate_reference(reference=reference)
+                    vals["reference"] = reference
+                except ValidationError:  # pylint: disable=W7938
+                    # Do not fill reference.
+                    pass
+        return super(DocumentPage, self).create(vals_list)

document_page_reference/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Enric Tobella <etobella@creublanca.es>

document_page_reference/readme/DESCRIPTION.rst

@@ -0,0 +1,2 @@
+This module allows to add a reference name on documents and simplifies the link
+between document pages.

document_page_reference/readme/USAGE.rst

@@ -0,0 +1,3 @@
+When editing a document page add elements like ${XXX} where XXX is the reference
+of another page. Now, when viewing the document, it will link directly to the page.
+Also, the name will be parsed as the display name.

document_page_reference/static/description/index.html

@@ -0,0 +1,429 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
+<title>Document Page Reference</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="document-page-reference">
+<h1 class="title">Document Page Reference</h1>
+
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/knowledge/tree/15.0/document_page_reference"><img alt="OCA/knowledge" src="https://img.shields.io/badge/github-OCA%2Fknowledge-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/knowledge-15-0/knowledge-15-0-document_page_reference"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/118/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
+<p>This module allows to add a reference name on documents and simplifies the link
+between document pages.</p>
+<p><strong>Table of contents</strong></p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#id1">Usage</a></h1>
+<p>When editing a document page add elements like ${XXX} where XXX is the reference
+of another page. Now, when viewing the document, it will link directly to the page.
+Also, the name will be parsed as the display name.</p>
+</div>
+<div class="section" id="bug-tracker">
+<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
+<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/knowledge/issues">GitHub Issues</a>.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+<a class="reference external" href="https://github.com/OCA/knowledge/issues/new?body=module:%20document_page_reference%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<p>Do not contact contributors directly about support or help with technical issues.</p>
+</div>
+<div class="section" id="credits">
+<h1><a class="toc-backref" href="#id3">Credits</a></h1>
+<div class="section" id="authors">
+<h2><a class="toc-backref" href="#id4">Authors</a></h2>
+<ul class="simple">
+<li>Creu Blanca</li>
+</ul>
+</div>
+<div class="section" id="contributors">
+<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
+<ul class="simple">
+<li>Enric Tobella &lt;<a class="reference external" href="mailto:etobella&#64;creublanca.es">etobella&#64;creublanca.es</a>&gt;</li>
+</ul>
+</div>
+<div class="section" id="maintainers">
+<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
+<p>This module is maintained by the OCA.</p>
+<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
+<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.</p>
+<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
+<p><a class="reference external" href="https://github.com/etobella"><img alt="etobella" src="https://github.com/etobella.png?size=40px" /></a></p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/knowledge/tree/15.0/document_page_reference">OCA/knowledge</a> project on GitHub.</p>
+<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
+</div>
+</div>
+</div>
+</body>
+</html>

document_page_reference/static/src/js/editor.js

@@ -0,0 +1,34 @@
+odoo.define("document_page_reference.backend", function (require) {
+    "use strict";
+
+    var field_registry = require("web.field_registry");
+    var FieldTextHtmlSimple = require("web_editor.field.html");
+    var FieldDocumentPage = FieldTextHtmlSimple.extend({
+        events: _.extend({}, FieldTextHtmlSimple.prototype.events, {
+            "click .oe_direct_line": "_onClickDirectLink",
+        }),
+        _onClickDirectLink: function (event) {
+            var self = this;
+            event.preventDefault();
+            event.stopPropagation();
+            var element = $(event.target).closest(".oe_direct_line")[0];
+            var default_reference = element.name;
+            var model = $(event.target).data("oe-model");
+            var id = $(event.target).data("oe-id");
+            var context = this.record.getContext(this.recordParams);
+            if (default_reference) {
+                context.default_reference = default_reference;
+            }
+            this._rpc({
+                model: model,
+                method: "get_formview_action",
+                args: [[parseInt(id, 10)]],
+                context: context,
+            }).then(function (action) {
+                self.trigger_up("do_action", {action: action});
+            });
+        },
+    });
+    field_registry.add("document_page_reference", FieldDocumentPage);
+    return FieldDocumentPage;
+});

document_page_reference/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_document_reference

document_page_reference/tests/test_document_reference.py

@@ -0,0 +1,78 @@
+# Copyright 2019 Creu Blanca
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo.exceptions import ValidationError
+from odoo.tests.common import TransactionCase
+
+
+class TestDocumentReference(TransactionCase):
+    @classmethod
+    def setUpClass(cls):
+        super(TestDocumentReference, cls).setUpClass()
+        cls.page_obj = cls.env["document.page"]
+        cls.history_obj = cls.env["document.page.history"]
+        cls.page1 = cls.page_obj.create(
+            {"name": "Test Page 1", "content": "${r2}", "reference": "R1"}
+        )
+        cls.page2 = cls.page_obj.create(
+            {"name": "Test Page 1", "content": "${r1}", "reference": "r2"}
+        )
+
+    def test_constrains_01(self):
+        with self.assertRaises(ValidationError):
+            self.page2.write({"reference": self.page1.reference})
+
+    def test_constrains_02(self):
+        with self.assertRaises(ValidationError):
+            self.page2.write({"reference": self.page2.reference + "-02"})
+
+    def test_no_contrains(self):
+        self.page1.write({"reference": False})
+        self.page2.write({"reference": False})
+        self.assertEqual(self.page1.reference, self.page2.reference)
+
+    def test_check_raw(self):
+        self.assertEqual(self.page2.display_name, self.page1.get_raw_content())
+
+    def test_check_reference(self):
+        self.assertRegex(self.page1.content_parsed, ".*%s.*" % self.page2.display_name)
+
+    def test_no_reference(self):
+        self.page2.reference = "r3"
+        self.assertRegex(self.page1.content_parsed, ".*r2.*")
+
+    def test_auto_reference(self):
+        """Test if reference is proposed when saving a page without one."""
+        self.assertEqual(self.page1.reference, "R1")
+        new_page = self.page_obj.create(
+            {"name": "Test Page with no rEfErenCe", "content": "some content"}
+        )
+        self.assertEqual(new_page.reference, "test_page_with_no_reference")
+        new_page_duplicated_name = self.page_obj.create(
+            {
+                "name": "test page with no reference",
+                "content": "this should have an empty reference "
+                "because reference must be unique",
+            }
+        )
+        self.assertFalse(new_page_duplicated_name.reference)
+
+    def test_get_formview_action(self):
+        res = self.page1.get_formview_action()
+        view_id = self.env.ref("document_page.view_wiki_form").id
+        expected_result = {
+            "type": "ir.actions.act_window",
+            "context": {},
+            "res_model": "document.page",
+            "res_id": self.page1.id,
+            "view_mode": "form",
+            "view_type": "form",
+            "target": "current",
+            "views": [(view_id, "form")],
+        }
+        self.assertEqual(res, expected_result)
+
+    def test_compute_content_parsed(self):
+        self.page1.content = "<p>"
+        self.page1._compute_content_parsed()
+        self.assertEqual(str(self.page1.content_parsed), "<p></p>")

document_page_reference/views/document_page.xml

@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- Copyright 2019 Creu Blanca
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+<odoo>
+    <record model="ir.ui.view" id="document_page_form_view">
+        <field name="name">document.page.form (in knowledge_reference)</field>
+        <field name="model">document.page</field>
+        <field name="inherit_id" ref="document_page.view_wiki_form" />
+        <field name="arch" type="xml">
+            <xpath expr="//h1" position="before">
+                <h2>
+                    <field
+                        name="reference"
+                        placeholder="internal_reference (autofilled if not value is provided)"
+                    />
+                </h2>
+            </xpath>
+            <field name="content" position="attributes">
+                <attribute name="class">oe_edit_only</attribute>
+            </field>
+            <field name="content" position="before">
+                <field
+                    name="content_parsed"
+                    class="oe_read_only"
+                    widget="document_page_reference"
+                />
+            </field>
+        </field>
+    </record>
+    <record id="view_wiki_menu_form" model="ir.ui.view">
+        <field name="name">document.page.menu.form</field>
+        <field name="model">document.page</field>
+        <field name="inherit_id" ref="document_page.view_wiki_menu_form" />
+        <field name="arch" type="xml">
+            <field name="content" position="attributes">
+                <attribute name="class">oe_edit_only</attribute>
+            </field>
+            <field name="content" position="before">
+                <field
+                    name="content_parsed"
+                    class="oe_read_only"
+                    widget="document_page_reference"
+                />
+            </field>
+        </field>
+    </record>
+    <record model="ir.ui.view" id="document_page_search_view">
+        <field name="name">document.page.search (in knowledge_reference)</field>
+        <field name="model">document.page</field>
+        <field name="inherit_id" ref="document_page.view_wiki_filter" />
+        <field name="arch" type="xml">
+            <field name="parent_id" position="before">
+                <field name="reference" />
+            </field>
+        </field>
+    </record>
+    <record model="ir.ui.view" id="document_page_tree_view">
+        <field name="name">document.page.tree (in knowledge_reference)</field>
+        <field name="model">document.page</field>
+        <field name="inherit_id" ref="document_page.view_wiki_tree" />
+        <field name="arch" type="xml">
+            <field name="name" position="after">
+                <field name="reference" optional="hidden" />
+            </field>
+        </field>
+    </record>
+</odoo>

document_page_reference/views/report_document_page.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <template
+        id="report_documentpage_doc"
+        inherit_id="document_page.report_documentpage_doc"
+    >
+        <xpath expr="//div[@t-raw='doc.content']" position="attributes">
+            <attribute name="t-if">1==0</attribute>
+        </xpath>
+        <xpath expr="//div[@t-raw='doc.content']" position="after">
+            <div t-raw="doc.get_raw_content()" />
+        </xpath>
+    </template>
+</odoo>

setup/document_page_reference/odoo/addons/document_page_reference

@@ -0,0 +1 @@
+../../../../document_page_reference

setup/document_page_reference/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    setup_requires=['setuptools-odoo'],
+    odoo_addon=True,
+)