555 lines
17 KiB
HTML
555 lines
17 KiB
HTML
<!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: https://docutils.sourceforge.io/" />
|
||
<title>README.rst</title>
|
||
<style type="text/css">
|
||
|
||
/*
|
||
:Author: David Goodger (goodger@python.org)
|
||
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
|
||
:Copyright: This stylesheet has been placed in the public domain.
|
||
|
||
Default cascading style sheet for the HTML output of Docutils.
|
||
Despite the name, some widely supported CSS2 features are used.
|
||
|
||
See https://docutils.sourceforge.io/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: gray; } /* 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, pre.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">
|
||
|
||
|
||
<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
|
||
<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
|
||
</a>
|
||
<div class="section" id="crm-usability-misc">
|
||
<h1>crm usability misc</h1>
|
||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
!! This file is generated by oca-gen-addon-readme !!
|
||
!! changes will be overwritten. !!
|
||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
!! source digest: sha256:be78325679fda626093147ef1d7023041e2544e8c1cca85c4c7199e4848f8c6f
|
||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||
<p><a class="reference external image-reference" 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 image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/Elabore/crm-tools/tree/16.0/crm_usability_misc"><img alt="Elabore/crm-tools" src="https://img.shields.io/badge/github-Elabore%2Fcrm--tools-lightgray.png?logo=github" /></a></p>
|
||
<p>[ This file must be max 2-3 paragraphs, and is required.</p>
|
||
<p>The goal of this document is to explain quickly the features of this
|
||
module: “what” this module does and “what” it is for. ]</p>
|
||
<p>Example:</p>
|
||
<p>This module extends the functionality of … to support … and to allow
|
||
users to …</p>
|
||
<p><strong>Table of contents</strong></p>
|
||
<div class="contents local topic" id="contents">
|
||
<ul class="simple">
|
||
<li><a class="reference internal" href="#use-cases-context" id="toc-entry-1">Use Cases / Context</a></li>
|
||
<li><a class="reference internal" href="#installation" id="toc-entry-2">Installation</a></li>
|
||
<li><a class="reference internal" href="#configuration" id="toc-entry-3">Configuration</a></li>
|
||
<li><a class="reference internal" href="#usage" id="toc-entry-4">Usage</a></li>
|
||
<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-5">Known issues / Roadmap</a></li>
|
||
<li><a class="reference internal" href="#changelog" id="toc-entry-6">Changelog</a><ul>
|
||
<li><a class="reference internal" href="#x-y-z-yyyy-mm-dd" id="toc-entry-7">11.0.x.y.z (YYYY-MM-DD)</a></li>
|
||
<li><a class="reference internal" href="#x-y-z-yyyy-mm-dd-1" id="toc-entry-8">11.0.x.y.z (YYYY-MM-DD)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-9">Bug Tracker</a></li>
|
||
<li><a class="reference internal" href="#credits" id="toc-entry-10">Credits</a><ul>
|
||
<li><a class="reference internal" href="#authors" id="toc-entry-11">Authors</a></li>
|
||
<li><a class="reference internal" href="#contributors" id="toc-entry-12">Contributors</a></li>
|
||
<li><a class="reference internal" href="#other-credits" id="toc-entry-13">Other credits</a></li>
|
||
<li><a class="reference internal" href="#maintainers" id="toc-entry-14">Maintainers</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="use-cases-context">
|
||
<h2><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h2>
|
||
<p>[ This file is optional but strongly suggested to allow end-users to
|
||
evaluate the module’s usefulness in their context. ]</p>
|
||
<p>BUSINESS NEED: It should explain the “why” of the module:</p>
|
||
<ul class="simple">
|
||
<li>what is the business requirement that generated the need to develop
|
||
this module</li>
|
||
<li>in which context or use cases this module can be useful (practical
|
||
examples are welcome!).</li>
|
||
</ul>
|
||
<p>APPROACH: It could also explain the approach to address the mentioned
|
||
need.</p>
|
||
<p>USEFUL INFORMATION: It can also inform on related modules:</p>
|
||
<ul class="simple">
|
||
<li>modules it depends on and their features</li>
|
||
<li>other modules that can work well together with this one</li>
|
||
<li>suggested setups where the module is useful (eg: multicompany,
|
||
multi-website)</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="installation">
|
||
<h2><a class="toc-backref" href="#toc-entry-2">Installation</a></h2>
|
||
<p>[ This file must only be present if there are very specific installation
|
||
instructions, such as installing non-python dependencies. The audience
|
||
is systems administrators. ]</p>
|
||
<p>To install this module, you need to:</p>
|
||
<ol class="arabic simple">
|
||
<li>Do this …</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="configuration">
|
||
<h2><a class="toc-backref" href="#toc-entry-3">Configuration</a></h2>
|
||
<p>[ This file is not always required; it should explain <strong>how to configure
|
||
the module before using it</strong>; it is aimed at users with administration
|
||
privileges.</p>
|
||
<p>Please be detailed on the path to configuration (eg: do you need to
|
||
activate developer mode?), describe step by step configurations and the
|
||
use of screenshots is strongly recommended.]</p>
|
||
<p>To configure this module, you need to:</p>
|
||
<ul class="simple">
|
||
<li>Go to <em>App</em> > Menu > Menu item</li>
|
||
<li>Activate boolean… > save</li>
|
||
<li>…</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="usage">
|
||
<h2><a class="toc-backref" href="#toc-entry-4">Usage</a></h2>
|
||
<p>[ This file is required and contains the instructions on <strong>“how”</strong> to
|
||
use the module for end-users.</p>
|
||
<p>If the module does not have a visible impact on the user interface, just
|
||
add the following sentence:</p>
|
||
<blockquote>
|
||
This module does not impact the user interface.</blockquote>
|
||
<p>If that’s not the case, please make sure that every usage step is
|
||
covered and remember that images speak more than words!]</p>
|
||
<p>To use this module, you need to:</p>
|
||
<ul>
|
||
<li><p class="first">Go to <em>App</em> > Menu > Menu item</p>
|
||
<p><em>insert screenshot!</em></p>
|
||
</li>
|
||
<li><p class="first">In “Contact” form, add a value to field <em>xyz</em> > save</p>
|
||
<p><em>insert screenshot!</em></p>
|
||
</li>
|
||
<li><p class="first">The value of <em>xyz</em> is now displayed in the list view.</p>
|
||
<p><em>insert screenshot!</em></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="known-issues-roadmap">
|
||
<h2><a class="toc-backref" href="#toc-entry-5">Known issues / Roadmap</a></h2>
|
||
<p>[ Enumerate known caveats and future potential improvements. It is
|
||
mostly intended for end-users, and can also help potential new
|
||
contributors discovering new features to implement. ]</p>
|
||
<ul class="simple">
|
||
<li>…</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="changelog">
|
||
<h2><a class="toc-backref" href="#toc-entry-6">Changelog</a></h2>
|
||
<p>[ The change log. The goal of this file is to help readers understand
|
||
changes between version. The primary audience is end users and
|
||
integrators. Purely technical changes such as code refactoring must not
|
||
be mentioned here.</p>
|
||
<p>This file may contain ONE level of section titles, underlined with the ~
|
||
(tilde) character. Other section markers are forbidden and will likely
|
||
break the structure of the README.rst or other documents where this
|
||
fragment is included. ]</p>
|
||
<div class="section" id="x-y-z-yyyy-mm-dd">
|
||
<h3><a class="toc-backref" href="#toc-entry-7">11.0.x.y.z (YYYY-MM-DD)</a></h3>
|
||
<ul class="simple">
|
||
<li>[BREAKING] Breaking changes come first.
|
||
(<a class="reference external" href="https://github.com/OCA/repo/issues/70">#70</a>)</li>
|
||
<li>[ADD] New feature. (<a class="reference external" href="https://github.com/OCA/repo/issues/74">#74</a>)</li>
|
||
<li>[FIX] Correct this. (<a class="reference external" href="https://github.com/OCA/repo/issues/71">#71</a>)</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="x-y-z-yyyy-mm-dd-1">
|
||
<h3><a class="toc-backref" href="#toc-entry-8">11.0.x.y.z (YYYY-MM-DD)</a></h3>
|
||
<ul class="simple">
|
||
<li>…</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="bug-tracker">
|
||
<h2><a class="toc-backref" href="#toc-entry-9">Bug Tracker</a></h2>
|
||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/Elabore/crm-tools/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 to smash it by providing a detailed and welcomed
|
||
<a class="reference external" href="https://github.com/Elabore/crm-tools/issues/new?body=module:%20crm_usability_misc%0Aversion:%2016.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">
|
||
<h2><a class="toc-backref" href="#toc-entry-10">Credits</a></h2>
|
||
<div class="section" id="authors">
|
||
<h3><a class="toc-backref" href="#toc-entry-11">Authors</a></h3>
|
||
<ul class="simple">
|
||
<li>Elabore</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="contributors">
|
||
<h3><a class="toc-backref" href="#toc-entry-12">Contributors</a></h3>
|
||
<ul class="simple">
|
||
<li>Firstname Lastname <a class="reference external" href="mailto:email.address@example.org">email.address@example.org</a> (optional company website
|
||
url)</li>
|
||
<li>Second Person <a class="reference external" href="mailto:second.person@example.org">second.person@example.org</a> (optional company website url)</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="other-credits">
|
||
<h3><a class="toc-backref" href="#toc-entry-13">Other credits</a></h3>
|
||
<p>[ This file is optional and contains additional credits, other than
|
||
authors, contributors, and maintainers. ]</p>
|
||
<p>The development of this module has been financially supported by:</p>
|
||
<ul class="simple">
|
||
<li>Company 1 name</li>
|
||
<li>Company 2 name</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="maintainers">
|
||
<h3><a class="toc-backref" href="#toc-entry-14">Maintainers</a></h3>
|
||
<p>This module is part of the <a class="reference external" href="https://github.com/Elabore/crm-tools/tree/16.0/crm_usability_misc">Elabore/crm-tools</a> project on GitHub.</p>
|
||
<p>You are welcome to contribute.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html>
|