mirror of
https://github.com/frappe/erpnext.git
synced 2026-04-27 18:48:31 +00:00
[docs] new pages on doctype and markup
This commit is contained in:
Priya
@@ -22,34 +22,34 @@ Accounting Entries
|
||||
|
||||
The balance of account can be increased / decreased, depending on account type and transaction type.
|
||||
|
||||
<table class="table table-bordered">
|
||||
<table class="table table-bordered text-center">
|
||||
<thead>
|
||||
<tr class="active">
|
||||
<td style="text-align: center;">Account Type</td>
|
||||
<td style="text-align: center;">Transaction Type</td>
|
||||
<td style="text-align: center;">Effect on account balance</td>
|
||||
<td>Account Type</td>
|
||||
<td>Transaction Type</td>
|
||||
<td>Effect on account balance</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align: center;">Debit</td>
|
||||
<td style="text-align: center;">Debit</td>
|
||||
<td style="text-align: center;">Increases</td>
|
||||
<td>Debit</td>
|
||||
<td>Debit</td>
|
||||
<td>Increases</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: center;">Debit</td>
|
||||
<td style="text-align: center;">Credit</td>
|
||||
<td style="text-align: center;">Decreases</td>
|
||||
<td>Debit</td>
|
||||
<td>Credit</td>
|
||||
<td>Decreases</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: center;">Credit</td>
|
||||
<td style="text-align: center;">Credit</td>
|
||||
<td style="text-align: center;">Increases</td>
|
||||
<td>Credit</td>
|
||||
<td>Credit</td>
|
||||
<td>Increases</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: center;">Credit</td>
|
||||
<td style="text-align: center;">Debit</td>
|
||||
<td style="text-align: center;">Decreases</td>
|
||||
<td>Credit</td>
|
||||
<td>Debit</td>
|
||||
<td>Decreases</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -62,48 +62,48 @@ This means that every accounting entry has two parts, one debit and one credit a
|
||||
|
||||
As the company will receive a payment from customer, the customer is considered as an asset account. For booking income, company maintains an account called "Sales of Laptop". So, entries will be done in the following manner:
|
||||
|
||||
<table class="table table-bordered">
|
||||
<table class="table table-bordered text-center">
|
||||
<thead>
|
||||
<tr class="active">
|
||||
<td style="text-align: center;">Account</td>
|
||||
<td style="text-align: center;">Debit</td>
|
||||
<td style="text-align: center;">Credit</td>
|
||||
<td>Account</td>
|
||||
<td>Debit</td>
|
||||
<td>Credit</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align: center;">Customer A</td>
|
||||
<td style="text-align: center;">50000</td>
|
||||
<td style="text-align: center;"></td>
|
||||
<td>Customer A</td>
|
||||
<td>50000</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: center;">Sales of Laptop</td>
|
||||
<td style="text-align: center;"></td>
|
||||
<td style="text-align: center;">50000</td>
|
||||
<td>Sales of Laptop</td>
|
||||
<td></td>
|
||||
<td>50000</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Customer A has made the payment, so customer balance should decreased based on the paid amount, which will increase "Cash" balance.
|
||||
|
||||
<table class="table table-bordered">
|
||||
<table class="table table-bordered text-center">
|
||||
<thead>
|
||||
<tr class="active">
|
||||
<td style="text-align: center;">Account</td>
|
||||
<td style="text-align: center;">Debit</td>
|
||||
<td style="text-align: center;">Credit</td>
|
||||
<td>Account</td>
|
||||
<td>Debit</td>
|
||||
<td>Credit</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align: center;">Customer A</td>
|
||||
<td style="text-align: center;"></td>
|
||||
<td style="text-align: center;">50000</td>
|
||||
<td>Customer A</td>
|
||||
<td></td>
|
||||
<td>50000</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: center;">Cash</td>
|
||||
<td style="text-align: center;">50000</td>
|
||||
<td style="text-align: center;"></td>
|
||||
<td>Cash</td>
|
||||
<td>50000</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
16
docs/user/knowledge/docs.user.knowledge.attachment_csv.md
Normal file
16
docs/user/knowledge/docs.user.knowledge.attachment_csv.md
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
{
|
||||
"_label": "Attachement and CSV files"
|
||||
}
|
||||
---
|
||||
|
||||
#### How to Attach files?
|
||||
|
||||
When you open a form, on the right sidebar, you will see a section to attach files. Click on “Add” and select the file you want to attach. Click on “Upload” and you are set.
|
||||
|
||||
#### What is a CSV file?
|
||||
|
||||
A CSV (Comma Separated Value) file is a data file that you can upload into ERPNext to update various data. Any spreadsheet file from popular spreadsheet applications like MS Excel or Open Office Spreadsheet can be saved as a CSV file.
|
||||
|
||||
If you are using Microsoft Excel and using non-English characters, make sure to save your file encoded as UTF-8. For older versions of Excel, there is no clear way of saving as UTF-8. So save your file as a CSV, then open it in Notepad, and save as “UTF-8”. (Sorry blame Microsoft for this!)
|
||||
|
||||
267
docs/user/knowledge/docs.user.knowledge.doctype.md
Normal file
267
docs/user/knowledge/docs.user.knowledge.doctype.md
Normal file
@@ -0,0 +1,267 @@
|
||||
---
|
||||
{
|
||||
"_label": "DocType"
|
||||
}
|
||||
---
|
||||
|
||||
|
||||
|
||||
ERPNext is a based on a “metadata” (data about data) framework that helps define all the different types of documents in the system. The basic building block of ERPNext is a DocType.
|
||||
|
||||
A DocType represents both a table in the database and a form from which a user can enter data.
|
||||
|
||||
Many DocTypes are single tables, but some work in groups. For example, Quotation has a “Quotation” DocType and a “Quotation Item” doctype for the Items table, among others. DocTypes contain a collection of fields called DocFields that form the basis of the columns in the database and the layout of the form.
|
||||
|
||||
<table class="table table-bordered text-left">
|
||||
<thead>
|
||||
<tr class="active">
|
||||
<td width="30%">Column</td>
|
||||
<td>Description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Name of the record</td>
|
||||
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Owner</td>
|
||||
<td>Creator and Owner of the record</td>
|
||||
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Created on</td>
|
||||
<td>Date and Time of Creation</td>
|
||||
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Modified On </td>
|
||||
<td>Date and Time of Modification</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Docstatus</td>
|
||||
<td>Status of the record<br>
|
||||
0 = Saved/Draft<br>
|
||||
1 = Submitted<br>
|
||||
2 = Cancelled/Deleted
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Parent</td>
|
||||
<td>Name of the Parent</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Parent Type</td>
|
||||
<td>Type of Parent</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Parent Field</td>
|
||||
<td>Specifying the relationship with the parent (there can be multiple child relationships with the same DocType).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Index(idx)</td>
|
||||
<td>Index (sequence) of the record in the child table.</td>
|
||||
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### Single DocType
|
||||
|
||||
There are a certain type of DocTypes that are “Single”, i.e. they have no table associated and have only one record of its fields. DocTypes such as Global Defaults, Production Planning Tool are “Single” DocTypes.
|
||||
|
||||
#### Field Columns
|
||||
|
||||
In the fields table, there are many columns, here is an explanation of the columns of the field table.
|
||||
|
||||
<table class="table table-bordered text-left">
|
||||
<thead>
|
||||
<tr class="active">
|
||||
<td width="30%">Column</td>
|
||||
<td>Description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Label</td>
|
||||
<td>Field Label (that appears in the form).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Type</td>
|
||||
<td>Field Type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Column name in the database, must be code friendly with no white spaces, special characters and capital letters.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>options</td>
|
||||
<td>Field settings:<br>
|
||||
For Select: List of options (each on a new line).<br>
|
||||
For Link: DocType that is “linked”.<br>
|
||||
For HTML: HTML Content
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Perm Level</td>
|
||||
<td>Permission level (number) of the field. You can group fields by numbers, called levels, and apply rules on the levels.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Width</td>
|
||||
<td>Width of the field (in pixels) - useful for “Table” types.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Reqd</td>
|
||||
<td>Checked if field is mandatory (required).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>In Filter</td>
|
||||
<td>Checked if field appears as a standard filter in old style reports.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Hidden</td>
|
||||
<td>Checked if field is hidden.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Print Hide</td>
|
||||
<td>Checked if field is hidden in Print Formats.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Report Hide</td>
|
||||
<td>Checked if field is hidden in old style reports.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Allow on Submit</td>
|
||||
<td>Checked if this field can be edited after the document is “Submitted”.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Depends On</td>
|
||||
<td>The fieldname of the field that will decide whether this field will be shown or hidden. It is useful to hide un-necessary fields.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Description</td>
|
||||
<td>Description of the field</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Default</td>
|
||||
<td>Default value when a new record is created.<br>
|
||||
Note: “user” will set the current user as default and “today” will set today’s date (if the field is a Date field).</td>
|
||||
</tr>
|
||||
<tbody>
|
||||
<table>
|
||||
|
||||
#### Field Types and Options
|
||||
|
||||
Here is a list of the different types of fields used to make / customize forms in ERPNext.
|
||||
|
||||
<table class="table table-bordered text-left">
|
||||
<thead>
|
||||
<tr class="active">
|
||||
<td width="30%">Type</td>
|
||||
<td>Description</td>
|
||||
<td>Options/Setting</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Data</td>
|
||||
<td>Single line text field with 180 characters</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Select</td>
|
||||
<td>Select from a pre-determined items in a drop-down.</td>
|
||||
<td>The “Options” contains the drop-down items, each on a new row</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Link</td>
|
||||
<td>Link an existing document / record</td>
|
||||
<td>Options contains the name of the type of document (DocType)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Currency</td>
|
||||
<td>Number with 2 decimal places, that will be shown separated by commas for thousands etc. in Print.</td>
|
||||
<td>e.g. 1,000,000.00</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Float</td>
|
||||
<td>Number with 6 decimal places.</td>
|
||||
<td>e.g. 3.141593</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Int</td>
|
||||
<td>Integer (no decimals)</td>
|
||||
<td>e.g. 100</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Date</td>
|
||||
<td>Date</td>
|
||||
<td>Format can be selected in Global Defaults</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Time</td>
|
||||
<td>Time</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3" class="active">Text</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Text</td>
|
||||
<td>Multi-line text box without formatting features</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Text editor</td>
|
||||
<td>Multi-line text box with formatting toolbar etc</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Code</td>
|
||||
<td>Code Editor</td>
|
||||
<td>Options can include the type of language for syntax formatting.
|
||||
Eg JS / Python / HTML</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3" class="active">Table (Grid)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Table</td>
|
||||
<td>Table of child items linked to the record.</td>
|
||||
<td>Options contains the name of the DocType of the child table. For example “Sales Invoice Item” for “Sales Invoice”</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3" class="active">Layout</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Section Break</td>
|
||||
<td>Break into a new horizontal section.</td>
|
||||
<td>The layout in ERPNext is evaluated from top to bottom.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Column Break</td>
|
||||
<td>Break into a new vertical column.</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>HTML</td>
|
||||
<td>Add a static text / help / link etc in HTML</td>
|
||||
<td>Options contains the HTML.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3" class="active">Action</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Button</td>
|
||||
<td>Button</td>
|
||||
<td>[for developers only]</td>
|
||||
</tr>
|
||||
<tbody>
|
||||
<table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
84
docs/user/knowledge/docs.user.knowledge.markdown.md
Normal file
84
docs/user/knowledge/docs.user.knowledge.markdown.md
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
{
|
||||
"_label": "Format Using Markdown"
|
||||
}
|
||||
---
|
||||
|
||||
Markdown is a simple way of writing text to format your content. Markdown allows you easy ways to format.
|
||||
|
||||
1. Headings (h1 (largest), h2, h3, h4 and so on)
|
||||
1. Paragraphs
|
||||
1. Lists (numbered or bulleted)
|
||||
1. Hyper links (links to other pages)
|
||||
1. Images
|
||||
1. Code
|
||||
1. Embed HTML (HTML tags within your text)
|
||||
|
||||
#### Headings
|
||||
|
||||
Headings are specified by adding a `#` (hash) at the beginning of the line. The more the number of hashes, the smaller the heading:
|
||||
|
||||
# This is a large heading.
|
||||
|
||||
### This is a smaller heading.
|
||||
|
||||
#### Paragraphs
|
||||
|
||||
To start a new paragraph, just make sure that there is an empty line at the beginning and end of the paragraph.
|
||||
|
||||
To format text as **bold** or with _italics_ format as follows:
|
||||
|
||||
**This text** is **bold** and _this one_ is with _italics_
|
||||
|
||||
#### Lists
|
||||
|
||||
To define numbered lists, start your link with a number and a dot (.) and ensure there is a blank line before and after the list. The numbers are automatically generated so it does not matter what number you put:
|
||||
|
||||
1. list 1st item
|
||||
1. second item
|
||||
1. and so on
|
||||
1. and so forth
|
||||
|
||||
To define bulleted lists, start your items with a hyphen (-)
|
||||
|
||||
- item 1
|
||||
- item 2
|
||||
- item 3
|
||||
|
||||
To nest lists within one another, put four spaces to indent your inner list as follows:
|
||||
|
||||
1. item 1
|
||||
1. item 2
|
||||
- sub item 1
|
||||
- sub item 2
|
||||
1. item 3
|
||||
|
||||
#### Links (to other pages)
|
||||
|
||||
Links to other pages can be defined by adding your text in box brackets [] followed by the link in round brackets ()
|
||||
|
||||
[This is an external link](http://example.com)
|
||||
[A link within the site](my-page.html)
|
||||
|
||||
#### Images
|
||||
|
||||
Images can be added by adding an exclamation ! before the link.
|
||||
|
||||
|
||||
|
||||
|
||||
#### Code
|
||||
|
||||
To add a code block, just leave a blank line before and after the block and make sure all code line are indented by four spaces:
|
||||
|
||||
This is normal text
|
||||
|
||||
This is a code block
|
||||
|
||||
#### HTML
|
||||
|
||||
You can embed any kind of HTML tags within your code. Any content written within HTML tags will not be formatted.
|
||||
|
||||
[Detailed description of the markdown format](http://daringfireball.net/projects/markdown/syntax)
|
||||
|
||||
|
||||
@@ -4,8 +4,12 @@
|
||||
"_toc": [
|
||||
"docs.user.knowledge.fiscal_year",
|
||||
"docs.user.knowledge.accounting",
|
||||
"docs.user.knowledge.accounting_entries"
|
||||
"docs.user.knowledge.accounting_entries",
|
||||
"docs.user.knowledge.doctype",
|
||||
"docs.user.knowledge.attachment_csv",
|
||||
"docs.user.knowledge.markdown"
|
||||
]
|
||||
}
|
||||
---
|
||||
Knowledge Library contains definitions and explanations of various management concepts. This page is created for users who wish to elaborate their conceptual knowledge.
|
||||
Knowledge Library contains definitions and explanations of various management concepts. This page is created for users who wish to elaborate their conceptual knowledge.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user