erpnext/foundation
1
0
Fork 0
mirror of https://github.com/erpnext/foundation.git synced 2026-10-16 18:00:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Updated Documentations

Browse Source
This commit is contained in:
frappe
2018-01-09 12:20:14 +02:00
parent 66395822d7
commit e84e4929b6
806 changed files with 2498 additions and 1190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
foundation/www/docs/user/manual/en/customize-erpnext/articles/making-custom-reports-in-erpnext.md
View File

@@ -7,7 +7,7 @@ There are three kind of reports in ERPNext.
Report Builder is an in-built report customization tool in ERPNext. This allows you to define specific fields of the form which shall be added in the report. Also you can set required filters, sorting and give preferred name to report.
<iframe width="660" height="371" src="https://www.youtube.com/embed/y0o5iYZOioU" frameborder="0" allowfullscreen></iframe>
<iframe width="660" height="371" src="https://www.youtube.com/watch?v=TxJGUNarcQs" frameborder="0" allowfullscreen></iframe>
### 2. Query Report

10
foundation/www/docs/user/manual/en/customize-erpnext/custom-doctype.md
View File

@@ -37,7 +37,7 @@ Fields are much more than database columns, they can be:
1. Actions (button)
1. Attachments or Images
<img alt="Doc fields" class="screenshot" src="/docs/assets/img/setup/customize/doctype-all-fields.png">
<img alt="Doc fields" class="screenshot" src="/docs/assets/img/setup/customize/Doctype-all-fields.png">
When you add fields, you need to enter the **Type**. **Label** is optional for Section Break and Column Break. **Name** (`fieldname`) is the name of the database table column.
@@ -53,13 +53,13 @@ In this section, you can define criteria based on which document for this doctyp
In this table, you should select roles and define permission roles for them for this Doctype.
<img alt="Doctype Permissions" class="screenshot" src="/docs/assets/img/setup/customize/doctype-permissions.png">
<img alt="Doctype Permissions" class="screenshot" src="/docs/assets/img/setup/customize/Doctype-permissions.png">
#### Save DocType
On saving doctype, you will get pop-up to provide name for this Doctype.
<img alt="Doctype Save" class="screenshot" src="/docs/assets/img/setup/customize/doctype-save.png">
<img alt="Doctype Save" class="screenshot" src="/docs/assets/img/setup/customize/Doctype-save.png">
#### DocType in System
@@ -68,12 +68,12 @@ Human Resource module, to access this doctype, go to:
`Human Resource > Document > Book`
<img alt="Doctype List" class="screenshot" src="/docs/assets/img/setup/customize/doctype-list-view.png">
<img alt="Doctype List" class="screenshot" src="/docs/assets/img/setup/customize/Doctype-list-view.png">
#### Book master
Using the fields entered, following is the master one book.
<img alt="Doctype Form" class="screenshot" src="/docs/assets/img/setup/customize/doctype-book-added.png">
<img alt="Doctype Form" class="screenshot" src="/docs/assets/img/setup/customize/Doctype-book-added.png">
{next}

13
foundation/www/docs/user/manual/en/education/admission/program-enrollment-tool.md
View File

@@ -1,17 +1,22 @@
<!-- add-breadcrumbs -->
# Program Enrollment Tool
The Program Enrollment tool allows the bulk enrollment of the **Student Applicants** in a Program.
The Program Enrollment tool allows the bulk enrollment of the new and old students in a Program. If you are enrolling a new student, you can fetch the students from the **Student Applicant** or if you are promoting the older students you can fetch them from the **Program Enrollment** itself
> Note: Academic Term is optional in the Program Enrollment Tool
You can create the the Program Enrollment for :
You can create the Program Enrollment for :
1. **Student Applicants** >> List of Student Applicants will be fetched for the selected **Program** and **Academic year**.
1. **Student Applicants**: List of Student Applicants will be fetched for the selected **Program**, **Academic year** and **Academic Term** (if provided).
<img class="screenshot" alt="Student Applicant Enrollment" src="/docs/assets/img/education/admission/program-enrollment-tool.gif">
2. **Program Enrollment** >> You can bulk update the **Program** for the students from one academic year to another in the same **Program** or a new **Program**.
2. **Program Enrollment**: List of students already enrolled in selected **Program** for the given **Academic Year**, **Academic Term** (if provided) and **Student Batch** will be fetched and can be used to enroll students from one academic year/term to another in the same **Program** or a new **Program**.
<img class="screenshot" alt="Student Applicant Enrollment" src="/docs/assets/img/education/admission/program-enrollment-tool01.gif">
**New Student Batch**: This can be selected for the entire students fetched in the table. Priority will be given to the Batch selected in the table (for individual students).
For promoting the students, the new academic year, academic term and program can also be selected for the enrollment of the fetched students list.
{next}

19
foundation/www/docs/user/manual/en/education/admission/program-enrollment.md
View File

@@ -1,13 +1,22 @@
<!-- add-breadcrumbs -->
# Program Enrollment
Program Enrollment describes an educational model where students must complete a defined set of courses towards their academic objective in a specified sequence. Enrollment is a program driven process in which the student select the Program to enrol for in a Academic Year.
**Program Enrollment** is the record of enrollment of a student in a given program and choose courses for a particular Academic Year and Academic Term (optional). If a student is enrolled in a program then his/her Program Enrollment must be created. The mandatory course in that program is automatically filled in Enrolled Courses table while the elective/optional courses can be selected manually.
Once a student have applied for the **Program** and the application is approved, the program enrollment is done for that student.
If the student has applied online for the admission in a particular **Program** and the application is approved, then the Program Enrollment can be created from within the Student Applicant record via clicking on the **Enroll** button.
Else, to create the new Program Enrollment manually, go to:
> Education > Program Enrollment > New
<img class="screenshot" alt="Student Applicant Enrollment" src="/docs/assets/img/education/admission/program-enrollment.gif">
- A student can be enrolled in multiple Course for a program in a given academeic year.
- Based on the Fee structure selected at the time of enrollment Fee detials are created of the student.
If any institution has skipped the online admission process then Program Enrollment can also be considered as the confirmation of the admission in a particular Program.
{next}
> TIP: Academic Term is optional in the Program Enrollment. If your institution has only annual curriculum, you can skip the Academic Term
Student Batch: To categorize student into different sections/batches, you can assign the batch to the student. On the basis of this field, later student groups can be created.
Student Category: For the Institutions having multiple Fees Structure, this field can be used to differentiate the student enrollment in a given fee category.
{next}

16
foundation/www/docs/user/manual/en/education/setup/instructor.md
View File

@@ -1,19 +1,21 @@
<!-- add-breadcrumbs -->
# Instructor
An instructoe is a teacher, or professor, of a specialised subject that involves skill.
An Instructor can be a teacher, tutor, coach, or professor, of a specialised subject that involves any skill.
You can create an Instructor and link it to the Employee master and a Departmemt.
To create new Instructor go to:
> Education > Instructor > New
<img class="screenshot" alt="Instructor" src="/docs/assets/img/education/setup/instructor.png">
An **Instructor** is further linked to a **Course Schedule**, where you can define the schedule for a **Course** for a give date and **Room no**.
An **Instructor** can also be linked to a **Course Schedule**, where you can define the schedule for a **Course** for a give date and **Room no**.
<img class="screenshot" alt="Instructor" src="/docs/assets/img/education/setup/instructor.gif">
It is also linked to **Student group** where an **Instructor** is assigned to the Student group.
It is also linked to **Student group** where an **Instructor** is assigned to the Student Group.
<img class="screenshot" alt="Instructor" src="/docs/assets/img/education/setup/student-group-instructor.gif">
While creating the **Assessment Plan** for a Student Group, **Instructor** can be linked as the Examiner or the Supervisor for that assessment.
Further, the log for the Instructor can be entered in the Instructor Log table which can be used for keeping the records of subjects taught by that Instructor.
An **Instructor** is also linked to an **Assesment Plan** for a Student group. The Instructor can be an Examiner or the supervisor for the assesment.
{next}

10
foundation/www/docs/user/manual/en/manufacturing/subcontracting.md
View File

@@ -28,10 +28,14 @@ other items which go into the making of pen, will be categorized as sub-items.
<img class="screenshot" alt="Sub-Contracting" src="/docs/assets/img/manufacturing/subcontract2.png">
__Step 2:__ Make a Purchase Order for the processed Item. When you “Save”, in the “Raw Materials Supplied”, all your un-processed Items will be updated based on your Bill of Materials.
__Step 2:__ Make a Purchase Order for the processed Item. When you “Save”, in the “Raw Materials Supplied”, all your un-processed Items will be updated based on your Bill of Materials. You can also select the warehouse from which the material would be reserved for sub contracting.
<img class="screenshot" alt="Sub-Contracting" src="/docs/assets/img/manufacturing/subcontract3.png">
Once the PO is submitted, you can view the reserved quantity of the item from the item dashboard as well.
<img class="screenshot" alt="Sub-Contracting" src="/docs/assets/img/manufacturing/subcontract3-reserved-material.png">
__Step 3:__ Make a Stock Entry to deliver the raw material Items to your Supplier.
<img class="screenshot" alt="Sub-Contracting" src="/docs/assets/img/manufacturing/subcontract4.png">
@@ -47,6 +51,10 @@ correct stock is maintained at the Supplier’s end.
> Note 2: ERPNext will automatically add the raw material rate for your
valuation purpose when you receive the finished Item in your stock.
> Note 3: ERPNext will automatically default the Reserve Warehouse in the PO
from the BOM. If not found in the BOM, it would default it from the default
warehouse setup in the Item.
### Video Help
<iframe width="660" height="371" src="https://www.youtube.com/embed/ThiMCC2DtKo" frameborder="0" allowfullscreen></iframe>

2
foundation/www/docs/user/manual/en/setting-up/setup-wizard/index.md
View File

@@ -1,7 +1,7 @@
<!-- add-breadcrumbs -->
# Setup Wizard
The Setup Wizard helps you quickly setup ERPnext as per your locale and sets up your organisation.
The Setup Wizard helps you quickly setup ERPnext as per your locale and sets up your organization.
Here is a quick overview of the steps:

17
foundation/www/docs/user/manual/en/setting-up/setup-wizard/index.txt
View File

@@ -1,5 +1,12 @@
step-1-language
step-2-currency-and-timezone
step-3-user-details
step-4-two-factor-authentication
step-5-company-details
step-01-language
step-02-currency-and-timezone
step-03-user-details
step-04-select-domain
step-05-the-brand
step-06-your-organization
step-07-setup-company-complete
step-08-set-sales-target
step-09-customers
step-10-letterhead
step-11-suppliers
step-12-users

0
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-1-language.md → foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-01-language.md
View File

16
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-02-currency-and-timezone.md Normal file
View File

@@ -0,0 +1,16 @@
<!-- add-breadcrumbs -->
# Step 2: Country, Currency and Time Zone
Set your Country Name, Time Zone and Currency.
<img alt="Currency" class="screenshot" src="/docs/assets/img/setup-wizard/step-2.png">
### Default Currency
For most countries, your currency and time zone will be automatically set.
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

12
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-03-user-details.md Normal file
View File

@@ -0,0 +1,12 @@
<!-- add-breadcrumbs -->
# Step 3: User Details
Enter the First User. Give the Full Name, Email Address (as User ID) and Password. This first user will be setup as a System Manager with privileges similar to the Administrator account.
<img alt="User" class="screenshot" src="/docs/assets/img/setup-wizard/step-3.png">
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

12
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-04-select-domain.md Normal file
View File

@@ -0,0 +1,12 @@
<!-- add-breadcrumbs -->
# Step 4: Select Domain
Select the domain(s) that will be enabled after setup.
<img alt="Domains" class="screenshot" src="/docs/assets/img/setup-wizard/step-4.png">
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

18
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-05-the-brand.md Normal file
View File

@@ -0,0 +1,18 @@
<!-- add-breadcrumbs -->
# Step 5: The Brand
Enter Company Name, Abbreviation and add a logo.
<img alt="Company Details" class="screenshot" src="/docs/assets/img/setup-wizard/step-5.png">
### Company Abbreviation
These will be appended to your **Account** Heads, for example if your abbreviation is **WPL**, then your Sales account will be **Sales - WPL**
For Example: East Wind will be abbreviated as EW. Shades of Green will be abbreviated as SOG. In case you wish to give your own abbreviation, you can do so. The text field allows any type of text.
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

24
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-06-your-organization.md Normal file
View File

@@ -0,0 +1,24 @@
<!-- add-breadcrumbs -->
# Step 6: Your Organization
Enter in a short sentence of what your company does. This is often a mission statement or vision statement.
Add the name of the organization's primary financial institution. This information will populate **Accounts**.
<img alt="Company Details" class="screenshot" src="/docs/assets/img/setup-wizard/step-6.png">
### Chart of Accounts
Select whether the organization will use a standard chart of accounts without number or a standard chart of accounts with numbers. The out of box chart of accounts is the same either way.
### Financial Year
Any annual period at the end of which a firm's accounts are made up is called a Financial Year. Some countries have their account year starting from 1st January and some 1st April.
The end date will be set automatically
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

16
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-07-setup-company-complete.md Normal file
View File

@@ -0,0 +1,16 @@
<!-- add-breadcrumbs -->
# Step 7: Initial Setup Complete
The initial setup wizard will create all the settings needed including the first system manager user.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-6a.png">
When complete, the Setup Wizard will go to the Desk and begin a secondary set of steps. This screen shows that the initial setup wizard is complete and begins the secondary setup wizard.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-7.png">
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

16
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-08-set-sales-target.md Normal file
View File

@@ -0,0 +1,16 @@
<!-- add-breadcrumbs -->
# Step 8: Set Sales Target
Set a monthly sales target for the organization in the currency selected during Step 2.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-8.png">
If a sales target is not known, then clicking **Mark as Done** will complete the step.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-8a.png">
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

16
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-09-customers.md Normal file
View File

@@ -0,0 +1,16 @@
<!-- add-breadcrumbs -->
# Step 9: Add Customers
Add known customers to the system.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-9.png">
If customers are not known, then clicking **Mark as Done** will complete the step.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-9a.png">
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

16
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-10-letterhead.md Normal file
View File

@@ -0,0 +1,16 @@
<!-- add-breadcrumbs -->
# Step 10: Company Letter Head
Add a company logo to be used as a standard letter head on all printed invoices and other document types. Ideally the logo is 900px by 100px.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-10.png">
If a letter head logo file is not available, the clicking **Mark as Done** will complete the step.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-10a.png">
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

21
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-11-suppliers.md Normal file
View File

@@ -0,0 +1,21 @@
<!-- add-breadcrumbs -->
# Step 11: Add Suppliers
Add known suppliers to the system.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-11.png">
If suppliers are not known, then clicking **Mark as Done** will complete the step.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-11a.png">
## Step 11a: Other Domain Specific Steps
Depending on the domain(s) selected in Step 4, there will be more screens to fill in for the secondary setup wizard.
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

16
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-12-users.md Normal file
View File

@@ -0,0 +1,16 @@
<!-- add-breadcrumbs -->
# Step 12: Add Users
The last step in the secondary setup wizard will prompt to add more users to the system. These users will be regular non-privileged users.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-12.png">
If users are not known, then clicking **Mark as Done** will complete the step.
<img alt="Language" class="screenshot" src="/docs/assets/img/setup-wizard/step-12a.png">
---
Translations are contributed by the ERPNext Community. If you want to contribute, [please checkout the translator portal](https://translate.erpnext.com).
{next}

14
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-2-currency-and-timezone.md
View File

@@ -1,14 +0,0 @@
<!-- add-breadcrumbs -->
# Step 2: Currency and Timezone
Set your country name, currency and timezone.
<img alt="Currency" class="screenshot" src="/docs/assets/img/setup-wizard/step-2.png">
---
### Default Currency
For most countries, your currency and timezone will be automatically set
{next}

12
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-3-user-details.md
View File

@@ -1,12 +0,0 @@
<!-- add-breadcrumbs -->
# Step 3: User Details
Enter Users Profile Details like Name, User ID and preferred password.
<img alt="User" class="screenshot" src="/docs/assets/img/setup-wizard/step-3.png">
---
Note: Add your own photograph, not your company's
{next}

14
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-4-two-factor-authentication.md
View File

@@ -1,14 +0,0 @@
<!-- add-breadcrumbs -->
# Step 4: Two Factor Authentication
Enable Two Factor Athentication
<img alt="TwoFactor" class="screenshot" src="/docs/assets/img/setup-wizard/twofactor.png">
---
###Authentication Method
Whenevever each user logs in, based on the role set for that user,
they will be asked for a **One Time Password** after they input
their login details.
{next}

22
foundation/www/docs/user/manual/en/setting-up/setup-wizard/step-5-company-details.md
View File

@@ -1,22 +0,0 @@
<!-- add-breadcrumbs -->
# Step 5: Company Details
Enter Company Details like Name, Abbreviation and Financial Year Details.
<img alt="Company Details" class="screenshot" src="/docs/assets/img/setup-wizard/step-4.png">
---
### Company Abbreviation
These will be appened to your **Account** Heads, for example if your abbreviation is **WP**, then your Sales account will be **Sales - WPL**
For Example: East Wind will be abbreviated as EW. Shades of Green will be abbreviated as SOG. In case you wish to give your own abbreviation, you can do so. The text field allows any type of text.
### Financial Year
Any annual period at the end of which a firm's accounts are made up is called a Financial Year. Some countries have their account year starting from 1st January and some 1st April.
The end date will be set automatically
{next}