Metadata-Version: 2.1
Name: odoo12-addon-website-snippet-anchor
Version: 12.0.1.1.0
Summary: Allow to reach a concrete section in the page
Home-page: https://github.com/OCA/website
Author: Tecnativa, Onestein, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: LGPL-3
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Requires-Python: >=3.5
Requires-Dist: odoo (<12.1dev,>=12.0a)

====================
Set Snippet's Anchor
====================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! 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-LGPL--3-blue.png
    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
    :alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github
    :target: https://github.com/OCA/website/tree/12.0/website_snippet_anchor
    :alt: OCA/website
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/website-12-0/website-12-0-website_snippet_anchor
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
    :target: https://runbot.odoo-community.org/runbot/186/12.0
    :alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5| 

This module extends the functionality of the website editor to support setting
an anchor to any section of your web page and allow you to link to them very
easily.

Anchors are just the HTML ``id`` attribute, which is commonly used to add it
to any URL and get directly to the element with that anchor, in the form of
https://www.tecnativa.com/#anchor-name.

**Table of contents**

.. contents::
   :local:

Usage
=====

Valid character ranges for anchors are: ``[A-Z][a-z][0-9]_-``

To add an anchor to any element, you need to:

#. Edit any web page.
#. Go to **Add blocks > Structure**.
#. Insert any block in your page.
#. Click on the snippet's option **Customize > Choose anchor**.
#. Set an anchor. If it is already used or has an invalid format, you will be asked to use another.

To link to any page's anchor, you need to:

#. Edit any web page.
#. Select some text.
#. Press **Link** in the editor toolbar.
#. Write the anchor, in the *URL or Email* field, prefixed by the ``#`` symbol.
   You have some suggestions below that field that indicate you which anchors
   are available in the current page.
#. Press **Save**.

Known issues / Roadmap
======================

* This module won't be needed in v13 thanks to `odoo/odoo@59cc261
  <https://github.com/odoo/odoo/commit/
  59cc261448b67c424051a623c5c8d76ddd20aa71>`_.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/website/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/website/issues/new?body=module:%20website_snippet_anchor%0Aversion:%2012.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
~~~~~~~

* Tecnativa
* Onestein

Contributors
~~~~~~~~~~~~

* Rafael Blasco <rafael.blasco@tecnativa.com>
* Jairo Llopis <jairo.llopis@tecnativa.com>
* Dennis Sluijk <d.sluijk@onestein.nl>
* Cristina Martin R.

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.

This module is part of the `OCA/website <https://github.com/OCA/website/tree/12.0/website_snippet_anchor>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.


