629 lines
No EOL
14 KiB
HTML
629 lines
No EOL
14 KiB
HTML
<!-- title: Website Theme -->
|
|
|
|
|
|
|
|
|
|
|
|
<div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.x.x</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/frappe/website/doctype/website_theme"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<p><b>Table Name:</b> <code>tabWebsite Theme</code></p>
|
|
|
|
|
|
|
|
|
|
<h3>Fields</h3>
|
|
|
|
<table class="table table-bordered" style="table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 5%">Sr</th>
|
|
<th style="width: 25%">Fieldname</th>
|
|
<th style="width: 20%">Type</th>
|
|
<th style="width: 25%">Label</th>
|
|
<th style="width: 25%">Options</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr >
|
|
<td>1</td>
|
|
<td class="danger" title="Mandatory"><code>theme</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Theme
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>2</td>
|
|
<td class="danger" title="Mandatory"><code>module</code></td>
|
|
<td >
|
|
Link</td>
|
|
<td >
|
|
Module
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/core/module_def">Module Def</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>3</td>
|
|
<td ><code>apply_style</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Apply Style
|
|
<p class="text-muted small">
|
|
This must be checked if the below style settings are applicable</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>4</td>
|
|
<td ><code>custom</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Custom?
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>5</td>
|
|
<td ><code>column_break_2</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>6</td>
|
|
<td ><code>bootstrap</code></td>
|
|
<td >
|
|
Small Text</td>
|
|
<td >
|
|
Link to Bootstrap CSS
|
|
<p class="text-muted small">
|
|
Link to your Bootstrap theme</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>7</td>
|
|
<td ><code>section_break_14</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>8</td>
|
|
<td ><code>font_size</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Font Size
|
|
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
12px
|
|
13px
|
|
14px
|
|
15px
|
|
16px
|
|
17px
|
|
18px</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>9</td>
|
|
<td ><code>text_webfont</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Google Font (Text)
|
|
<p class="text-muted small">
|
|
Add the name of a "Google Web Font" e.g. "Open Sans"</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>10</td>
|
|
<td ><code>heading_webfont</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Google Font (Heading)
|
|
<p class="text-muted small">
|
|
Add the name of a "Google Web Font" e.g. "Open Sans"</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>11</td>
|
|
<td ><code>column_break_18</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>12</td>
|
|
<td ><code>text_color</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Text Color
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>13</td>
|
|
<td ><code>link_color</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Link Color
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>14</td>
|
|
<td ><code>heading_style</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Heading Style
|
|
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
UPPERCASE
|
|
Title Case
|
|
lowercase</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>15</td>
|
|
<td ><code>section_break_8</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>16</td>
|
|
<td ><code>top_bar_color</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Top Bar Color
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>17</td>
|
|
<td ><code>top_bar_text_color</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Top Bar Text Color
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>18</td>
|
|
<td ><code>no_sidebar</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Hide Sidebar
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>19</td>
|
|
<td ><code>column_break_11</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>20</td>
|
|
<td ><code>footer_color</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Footer Color
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>21</td>
|
|
<td ><code>footer_text_color</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Footer Text Color
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>22</td>
|
|
<td ><code>section_break_4</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>23</td>
|
|
<td ><code>background_color</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Background Color
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>24</td>
|
|
<td ><code>column_break_6</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>25</td>
|
|
<td ><code>background_image</code></td>
|
|
<td >
|
|
Attach Image</td>
|
|
<td >
|
|
Background Image
|
|
<p class="text-muted small">
|
|
If image is selected, color will be ignored.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>26</td>
|
|
<td ><code>section_break_21</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>27</td>
|
|
<td ><code>css</code></td>
|
|
<td >
|
|
Code</td>
|
|
<td >
|
|
Style using CSS
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>28</td>
|
|
<td ><code>js</code></td>
|
|
<td >
|
|
Code</td>
|
|
<td >
|
|
JavaScript
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
<h3>Controller</h3>
|
|
<h4>frappe.website.doctype.website_theme.website_theme</h4>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>WebsiteTheme</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p></p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="clear_cache_if_current_theme" href="#clear_cache_if_current_theme" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>clear_cache_if_current_theme</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="export_doc" href="#export_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>export_doc</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Export to standard folder <code>[module]/website_theme/[name]/[name].json</code>.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="is_standard_and_not_valid_user" href="#is_standard_and_not_valid_user" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>is_standard_and_not_valid_user</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="on_trash" href="#on_trash" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>on_trash</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="on_update" href="#on_update" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>on_update</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="use_theme" href="#use_theme" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>use_theme</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate" href="#validate" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate_colors" href="#validate_colors" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_colors</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate_if_customizable" href="#validate_if_customizable" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_if_customizable</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.website.doctype.website_theme.website_theme.add_website_theme" href="#frappe.website.doctype.website_theme.website_theme.add_website_theme" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.website.doctype.website_theme.website_theme.<b>add_website_theme</b>
|
|
<i class="text-muted">(context)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.website.doctype.website_theme.website_theme.get_active_theme" href="#frappe.website.doctype.website_theme.website_theme.get_active_theme" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.website.doctype.website_theme.website_theme.<b>get_active_theme</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.website.doctype.website_theme.website_theme.use_theme</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.website.doctype.website_theme.website_theme.use_theme" href="#frappe.website.doctype.website_theme.website_theme.use_theme" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.website.doctype.website_theme.website_theme.<b>use_theme</b>
|
|
<i class="text-muted">(theme)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Linked In:</h4>
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/website/website_settings">Website Settings</a>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<!-- autodoc -->
|
|
<!-- jinja -->
|
|
<!-- static --> |