Author: |
Tecnativa, Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
12.0 |
Repository: |
anhvu-sg/event |
Dependencies: |
event,
html_image_url_extractor,
html_text,
website,
and
website_event |
Languages: |
HTML (410, 57.3%),
PO File (31, 4.3%),
Python (37, 5.2%),
Sass (39, 5.4%),
XML (88, 12.3%),
and
reStructuredText (111, 15.5%) |
Other branches: |
10.0,
11.0,
and
8.0 |
Other repositories: |
AnilKesariya/event,
Antiun/event,
Change2improve/event,
ClearCorp/oca-event,
Dobtor-OCA/event,
ERPLibre/event,
ForgeFlow/event,
Gabinete-Digital/event,
Gofekra/event,
Guobower/event,
Ingeos/event,
KolushovAlexandr/event,
LTechCS/event,
LasLabs/event,
LevelPrime/event,
Martronic-SA/event,
MathBenTech/event,
NL66278/event,
NeatNerdPrime/event,
Nikul-Chaudhary/event,
Numigi/odoo-event,
OCA-MUK/event,
OCA/event,
Ommo73/event,
SanteLibre/event,
SeuMarco/event,
Tecnativa/event,
VishnuPrasad1998/event,
VisiionSolucionesTecnologicas/event,
adolfoeliazat/event,
angelmoya/event,
anishukserg/event,
ap305194/event,
apachesep/event,
apetbiz/event,
archeti-org/event,
aryajimbaran/event,
brain-tec/event,
coopiteasy/event,
cristinamartinrod/event,
dhp-denero/event,
dsasoftware/event,
ecosoft-odoo/event,
emagdalenaC2i/event,
gastonfeng/event,
glm-conseil/event,
haroldtamo/event,
humanilog/event,
iRichGit/event,
initOS/event,
it-projects-llc/event,
j-zaballa/event,
kitworks-systems/event,
kmee/event,
lfreeke/event,
lideritjnma/event,
ntsirintanis/event,
nucleoosystem/event,
odoogap/event,
oihane/event,
open-synergy/event,
popcomputadores-desenv/event,
pscloud/event,
rousseldenis/event,
rsullivan2704/event,
sanube/event,
steingabelgaard/event,
thinkopensolutions/oca-event,
tschanzt/event,
vdedyukhin/event,
yelizariev/event,
and
yveshoyos/event |
<h1 class="title">Excerpt + Image in Events</h1>
<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/event/tree/12.0/website_event_excerpt_img"><img alt="OCA/event" src="https://img.shields.io/badge/github-OCA%2Fevent-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/event-12-0/event-12-0-website_event_excerpt_img"><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/199/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module extends the functionality of website events to support having a
more attractive layout that automatically displays an excerpt of each one, a
"Read more" button, and an image.</p>
<p>It also adds a event priority control in the backend that will display the
event at the top and in a bigger shape in the website.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
<li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id3">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="installation"></a>
<h2><a class="toc-backref" href="#id1">Installation</a></h2>
<p>To install this module, you need to:</p>
<ol class="arabic simple">
<li>Install <a class="reference external" href="https://github.com/OCA/server-tools">OCA/server-tools</a>.</li>
</ol>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id2">Configuration</a></h2>
<p>To configure this module, you need to:</p>
<ol class="arabic simple">
<li>Log in.</li>
<li>Go to <a class="reference external" href="/event">your website events page</a>.</li>
<li>Open the <em>Customize</em> menu.</li>
<li>Enable <em>Images and Description</em>, and you should see events with
an image and description in the layout.</li>
</ol>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>Normal (not highlighted) events will show up a bit clunky if you do not
disable the <em>Filters</em> view from the <em>Customize</em> menu.</p>
<p>You can either highlight all events, or disable that view.</p>
<p class="last">If you still need filters, see module <code>website_event_filter_selector</code>
found in this same repo.</p>
</div>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id3">Usage</a></h2>
<p>To use this module, you need to:</p>
<ol class="arabic simple">
<li>Go to the events page in your website. They have image and description now.</li>
</ol>
<p>You will notice that short description is the excerpt of the first 80
characters of the event's long description. If you want to set a manual
description, you need to:</p>
<ul class="simple">
<li><dl class="first docutils">
<dt>From the frontend:</dt>
<dd><ol class="first last arabic">
<li>Click in that event.</li>
<li>Use the <em>Promote > Optimize SEO</em> tool to set a meta description.</li>
</ol>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>From the backend:</dt>
<dd><ol class="first last arabic">
<li>Go to <em>Events > Events</em>.</li>
<li>Choose one.</li>
<li>Go to <em>Featured content</em>.</li>
<li>Use the <em>Website meta description</em> field for the same purpose.</li>
</ol>
</dd>
</dl>
</li>
</ul>
<p>If you want to change the image, you need to:</p>
<ol class="arabic simple">
<li>Edit the event page.</li>
<li>There, the first image appearing will be the one chosen. Beware, background
images count!</li>
</ol>
<p>If you want to set an event as important:</p>
<ol class="arabic simple">
<li>Go to the event's form in backend.</li>
<li>Publish it.</li>
<li>Go to the <em>Featured content</em> tab.</li>
<li>Add a star in <em>Priority</em> to display the event in a full row on website.</li>
<li>Remove the star to display it in half a row.</li>
</ol>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id4">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/event/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/event/issues/new?body=module:%20website_event_excerpt_img%0Aversion:%2012.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>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id5">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id6">Authors</a></h3>
<ul class="simple">
<li>Tecnativa</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id7">Contributors</a></h3>
<ul class="simple">
<li>Rafael Blasco <<a class="reference external" href="mailto:rafael.blasco@tecnativa.com">rafael.blasco@tecnativa.com</a>></li>
<li>Jairo Llopis <<a class="reference external" href="mailto:jairo.llopis@tecnativa.com">jairo.llopis@tecnativa.com</a>></li>
<li>David Vidal <<a class="reference external" href="mailto:david.vidal@tecnativa.com">david.vidal@tecnativa.com</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id8">Maintainers</a></h3>
<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>This module is part of the <a class="reference external" href="https://github.com/OCA/event/tree/12.0/website_event_excerpt_img">OCA/event</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>