seitime-frappe/frappe/docs/current/models/core/page.html
Ashish Acharya 3a65d7a1ff Base Code
2015-11-26 20:46:18 +05:30

292 lines
No EOL
6.2 KiB
HTML

<!-- title: Page -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.10.1</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/frappe/core/doctype/page"
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>tabPage</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 class="info">
<td>1</td>
<td ><code>page_html</code></td>
<td >
Section Break</td>
<td >
Page HTML
</td>
<td></td>
</tr>
<tr >
<td>2</td>
<td class="danger" title="Mandatory"><code>page_name</code></td>
<td >
Data</td>
<td >
Page Name
</td>
<td></td>
</tr>
<tr >
<td>3</td>
<td ><code>title</code></td>
<td >
Data</td>
<td >
Title
</td>
<td></td>
</tr>
<tr >
<td>4</td>
<td ><code>icon</code></td>
<td >
Data</td>
<td >
icon
</td>
<td></td>
</tr>
<tr >
<td>5</td>
<td ><code>column_break0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>6</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>7</td>
<td class="danger" title="Mandatory"><code>standard</code></td>
<td >
Select</td>
<td >
Standard
</td>
<td>
<pre>
Yes
No</pre>
</td>
</tr>
<tr class="info">
<td>8</td>
<td ><code>section_break0</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>9</td>
<td ><code>roles</code></td>
<td >
Table</td>
<td >
Roles
</td>
<td>
<a href="https://frappe.github.io/frappe/current/models/core/page_role">Page Role</a>
</td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>frappe.core.doctype.page.page</h4>
<h3 style="font-weight: normal;">Class <b>Page</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="as_dict" href="#as_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>as_dict</b>
<i class="text-muted">(self, no_nulls=False)</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="autoname" href="#autoname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>autoname</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Creates a url friendly name for this page.
Will restrict the name to 30 characters, if there exists a similar name,
it will add name-1, name-2 etc.</p>
</div>
<br>
<p class="docs-attr-name">
<a name="is_permitted" href="#is_permitted" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>is_permitted</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Returns true if Page Role is not set or the user is allowed.</p>
</div>
<br>
<p class="docs-attr-name">
<a name="load_assets" href="#load_assets" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>load_assets</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>Writes the .txt for this page and if write_content is checked,
it will write out a .html file</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>
</div>
<hr>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->