698 lines
No EOL
17 KiB
HTML
698 lines
No EOL
17 KiB
HTML
<!-- title: Website Settings -->
|
|
|
|
|
|
|
|
|
|
|
|
<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_settings"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
<span class="label label-info">Single</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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 class="info">
|
|
<td>1</td>
|
|
<td ><code>sb0</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Landing Page
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>2</td>
|
|
<td ><code>home_page</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Home Page
|
|
<p class="text-muted small">
|
|
Link that is the website home page. Standard Links (index, login, products, blog, about, contact)</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>3</td>
|
|
<td ><code>home_page_is_products</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Home Page is Products
|
|
<p class="text-muted small">
|
|
If checked, the Home page will be the default Item Group for the website.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>4</td>
|
|
<td ><code>cb4</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>5</td>
|
|
<td ><code>title_prefix</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Title Prefix
|
|
<p class="text-muted small">
|
|
Show title in browser window as "Prefix - title"</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>6</td>
|
|
<td ><code>section_break_6</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>7</td>
|
|
<td ><code>website_theme</code></td>
|
|
<td >
|
|
Link</td>
|
|
<td >
|
|
Website Theme
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/website/website_theme">Website Theme</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>8</td>
|
|
<td ><code>website_theme_image</code></td>
|
|
<td >
|
|
Image</td>
|
|
<td class="text-muted" title="Hidden">
|
|
Website Theme Image
|
|
|
|
</td>
|
|
<td>
|
|
<pre>website_theme_image_link</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>9</td>
|
|
<td ><code>website_theme_image_link</code></td>
|
|
<td >
|
|
Small Text</td>
|
|
<td class="text-muted" title="Hidden">
|
|
Website Theme Image Link
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>10</td>
|
|
<td ><code>banner</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Banner
|
|
<p class="text-muted small">
|
|
Add a banner to the site. (small banners are usually good)</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>11</td>
|
|
<td ><code>banner_image</code></td>
|
|
<td >
|
|
Attach Image</td>
|
|
<td >
|
|
Banner Image
|
|
<p class="text-muted small">
|
|
Select an image of approx width 150px with a transparent background for best results.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>12</td>
|
|
<td ><code>set_banner_from_image</code></td>
|
|
<td >
|
|
Button</td>
|
|
<td >
|
|
Set Banner from Image
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>13</td>
|
|
<td ><code>column_break_14</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>14</td>
|
|
<td ><code>banner_html</code></td>
|
|
<td >
|
|
Small Text</td>
|
|
<td >
|
|
Banner HTML
|
|
<p class="text-muted small">
|
|
Banner is above the Top Menu Bar.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>15</td>
|
|
<td ><code>top_bar</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Top Bar
|
|
<p class="text-muted small">
|
|
Menu items in the Top Bar. For setting the color of the Top Bar, go to selected Website Theme.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>16</td>
|
|
<td ><code>brand_html</code></td>
|
|
<td >
|
|
Small Text</td>
|
|
<td >
|
|
Brand HTML
|
|
<p class="text-muted small">
|
|
Brand is what appears on the top-left of the toolbar. If it is an image, make sure it
|
|
has a transparent background and use the <img /> tag. Keep size as 200px x 30px</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>17</td>
|
|
<td ><code>top_bar_items</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td >
|
|
Top Bar Items
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/website/top_bar_item">Top Bar Item</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>18</td>
|
|
<td ><code>sidebar</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Sidebar
|
|
<p class="text-muted small">
|
|
Sidebar Links for Home Page only</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>19</td>
|
|
<td ><code>sidebar_items</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td >
|
|
Sidebar Items
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/website/top_bar_item">Top Bar Item</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>20</td>
|
|
<td ><code>footer</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Footer
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>21</td>
|
|
<td ><code>copyright</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Copyright
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>22</td>
|
|
<td ><code>address</code></td>
|
|
<td >
|
|
Text Editor</td>
|
|
<td >
|
|
Address
|
|
<p class="text-muted small">
|
|
Address and other legal information you may want to put in the footer.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>23</td>
|
|
<td ><code>footer_items</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td >
|
|
Footer Items
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/website/top_bar_item">Top Bar Item</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>24</td>
|
|
<td ><code>hide_footer_signup</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Hide Footer Signup
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>25</td>
|
|
<td ><code>integrations</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Integrations
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>26</td>
|
|
<td ><code>google_analytics_id</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Google Analytics ID
|
|
<p class="text-muted small">
|
|
Add Google Analytics ID: eg. UA-89XXX57-1. Please search help on Google Analytics for more information.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>27</td>
|
|
<td ><code>column_break_17</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>28</td>
|
|
<td ><code>google_plus_one</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Google Plus One
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>29</td>
|
|
<td ><code>facebook_share</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Facebook Share
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>30</td>
|
|
<td ><code>linked_in_share</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Linked In Share
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>31</td>
|
|
<td ><code>twitter_share</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Twitter Share
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>32</td>
|
|
<td ><code>twitter_share_via</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Twitter Share via
|
|
<p class="text-muted small">
|
|
Tweet will be shared via your user account (if specified)</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>33</td>
|
|
<td ><code>misc_section</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
More Information
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>34</td>
|
|
<td ><code>favicon</code></td>
|
|
<td >
|
|
Attach</td>
|
|
<td >
|
|
FavIcon
|
|
<p class="text-muted small">
|
|
An icon file with .ico extension. Should be 16 x 16 px. Generated using a favicon generator. [favicon-generator.org]</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>35</td>
|
|
<td ><code>subdomain</code></td>
|
|
<td >
|
|
Text</td>
|
|
<td >
|
|
Subdomain
|
|
<p class="text-muted small">
|
|
Sub-domain provided by erpnext.com</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>36</td>
|
|
<td ><code>column_break_28</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>37</td>
|
|
<td ><code>disable_signup</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Disable Signup
|
|
<p class="text-muted small">
|
|
Disable Customer Signup link in Login page</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>38</td>
|
|
<td ><code>section_break_38</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>39</td>
|
|
<td ><code>head_html</code></td>
|
|
<td >
|
|
Code</td>
|
|
<td >
|
|
<head> HTML
|
|
<p class="text-muted small">
|
|
Added HTML in the <head> section of the web page, primarily used for website verification and SEO</p>
|
|
</td>
|
|
<td>
|
|
<pre>HTML</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
<h3>Controller</h3>
|
|
<h4>frappe.website.doctype.website_settings.website_settings</h4>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>WebsiteSettings</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" href="#clear_cache" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>clear_cache</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="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_footer_items" href="#validate_footer_items" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_footer_items</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>clear parent label in footer</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate_home_page" href="#validate_home_page" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_home_page</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_top_bar_items" href="#validate_top_bar_items" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_top_bar_items</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>validate url in top bar items</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.website.doctype.website_settings.website_settings.get_website_settings" href="#frappe.website.doctype.website_settings.website_settings.get_website_settings" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.website.doctype.website_settings.website_settings.<b>get_website_settings</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc -->
|
|
<!-- jinja -->
|
|
<!-- static --> |