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

[Docs] Updated Documentations

Browse Source
This commit is contained in:
frappe
2018-02-23 07:27:03 +02:00
parent 7c80a62722
commit 70b2035361
1617 changed files with 10381 additions and 4071 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
foundation/www/docs/user/manual/en/using-erpnext/articles/Global-search.md
View File

@@ -11,9 +11,9 @@ Global Search helps users find information quickly. It’s located in the upper
### Using Awesome bar for Global Search.
<img alt="Global Search" class="screenshot" src="/docs/assets/img/articles/Global Search .gif">
<img alt="Global Search" class="screenshot" src="{{docs_base_url}}/assets/img/articles/Global Search .gif">
### Enable Global Search for fields in a Doctype.
<img alt="Global Search" class="screenshot" src="/docs/assets/img/articles/Enable Global Search .gif">
<img alt="Global Search" class="screenshot" src="{{docs_base_url}}/assets/img/articles/Enable Global Search .gif">

2
foundation/www/docs/user/manual/en/using-erpnext/articles/adding-attachments-to-outgoing-messages.md
View File

@@ -5,6 +5,6 @@ ERPNext has in-built file manager. Click [here](/docs/user/videos/learn/file-man
If you have file attached to the document (say Purchase Order), and same file needs to be emailed as attachment, following is how you can achieve it.
<img alt="Emailing Attachments" class="screenshot" src="/docs/assets/img/articles/email-file-attachment.gif">
<img alt="Emailing Attachments" class="screenshot" src="{{docs_base_url}}/assets/img/articles/email-file-attachment.gif">
<!-- markdown -->

6
foundation/www/docs/user/manual/en/using-erpnext/articles/adding-file-as-a-attachment.md
View File

@@ -9,11 +9,11 @@ There are several ways to attach file to the document.
####From Browser
<img alt="Sales Order File Attachment" class="screenshot" src="/docs/assets/img/articles/attach-file-1.gif">
<img alt="Sales Order File Attachment" class="screenshot" src="{{docs_base_url}}/assets/img/articles/attach-file-1.gif">
####By drag and drop
<img alt="Sales Order File Attachment" class="screenshot" src="/docs/assets/img/articles/attach-file-2.gif">
<img alt="Sales Order File Attachment" class="screenshot" src="{{docs_base_url}}/assets/img/articles/attach-file-2.gif">
Click on Attach to browse and select the file.
@@ -21,7 +21,7 @@ Click on Attach to browse and select the file.
If you use separate server for files, or use online service like Dropbox, you can attach file by providing link of a particular file.
<img alt="Sales Order Select File" class="screenshot" src="/docs/assets/img/articles/attach-file-3.gif">
<img alt="Sales Order Select File" class="screenshot" src="{{docs_base_url}}/assets/img/articles/attach-file-3.gif">
`For hosted users, limit of 5 MB is applied on file size.`

4
foundation/www/docs/user/manual/en/using-erpnext/articles/bulk-rename.md
View File

@@ -11,7 +11,7 @@ You can rename ids of upto 500 records at a time. Following are step to bulk ren
In a spreadsheet file, enter old Item IDs in the first column, and new Item Ids in the second column. Save spreadsheet file in a CSV format.
<img alt="Data File" class="screenshot" src="/docs/assets/img/articles/rename-docs-1.png">
<img alt="Data File" class="screenshot" src="{{docs_base_url}}/assets/img/articles/rename-docs-1.png">
#### Step 2: Upload Data File
@@ -21,7 +21,7 @@ To upload data file go to,
Select DocType which you want to rename. Here DocType will be Item. Then Browse and Upload data file.
![Upload Data](/docs/assets/img/articles/Selection_0173436a8.png)
![Upload Data]({{docs_base_url}}/assets/img/articles/Selection_0173436a8.png)
{next}

4
foundation/www/docs/user/manual/en/using-erpnext/articles/check-link-between-documents.md
View File

@@ -3,7 +3,7 @@
Links option shows one document is linked to which other documents. Check Menu for the Links options.
<img alt="Cancel Doc" class="screenshot" src="/docs/assets/img/articles/links-1.gif">
<img alt="Cancel Doc" class="screenshot" src="{{docs_base_url}}/assets/img/articles/links-1.gif">
####Scenario
@@ -19,6 +19,6 @@ If I check Links in the Purchase Receipt, will it list Purchase Order from which
Links only shows forward linkages. For the backward links, you should check current document itself. In the Purchase Receipt Item table table, you can check which Purchase Order it is linked to.
<img alt="Cancel Doc" class="screenshot" src="/docs/assets/img/articles/links-2.gif">
<img alt="Cancel Doc" class="screenshot" src="{{docs_base_url}}/assets/img/articles/links-2.gif">
<!-- markdown -->

6
foundation/www/docs/user/manual/en/using-erpnext/articles/delete-submitted-document.md
View File

@@ -13,18 +13,18 @@ Following are step to delete submitted documents.
You will find option to Cancel in the submitted document. If document is at draft stage, it can delete directly. Also if document is not submittable, but only save, it can be deleted directly.
<img alt="Cancel Doc" class="screenshot" src="/docs/assets/img/articles/delete-submitted-doc-1.png">
<img alt="Cancel Doc" class="screenshot" src="{{docs_base_url}}/assets/img/articles/delete-submitted-doc-1.png">
####Step 2: Delete Document
After cancellation, go to Menu and click on Delete.
<img alt="Delete Doc" class="screenshot" src="/docs/assets/img/articles/delete-submitted-doc-2.png">
<img alt="Delete Doc" class="screenshot" src="{{docs_base_url}}/assets/img/articles/delete-submitted-doc-2.png">
####Step 3: Deleting from List
For bulk deletion, you can select multiple Cancelled records and delete at once from the List View.
<img alt="Delete Doc from List" class="screenshot" src="/docs/assets/img/articles/delete-submitted-doc-3.gif">
<img alt="Delete Doc from List" class="screenshot" src="{{docs_base_url}}/assets/img/articles/delete-submitted-doc-3.gif">
<!-- markdown -->

2
foundation/www/docs/user/manual/en/using-erpnext/articles/duplicate-record.md
View File

@@ -11,6 +11,6 @@ You will find Copy option under:
`Menu > Copy`
<img alt="Duplicate" class="screenshot" src="/docs/assets/img/articles/duplicate.gif">
<img alt="Duplicate" class="screenshot" src="{{docs_base_url}}/assets/img/articles/duplicate.gif">
<!-- markdown -->

4
foundation/www/docs/user/manual/en/using-erpnext/articles/letter-head-in-the-report.md
View File

@@ -5,11 +5,11 @@ In the reports, Letter Head is fetched from the Company master. To have company'
`Explore > Accounts > Company`
<img class="screenshot" alt="Company Letter" src="/docs/assets/img/articles/report-header-1.png">
<img class="screenshot" alt="Company Letter" src="{{docs_base_url}}/assets/img/articles/report-header-1.png">
In a Company master, if no Letter Head is set as default, then in the reports, Letter Head having Default field checked will be fetched.
<img class="screenshot" alt="Default Letter Head" src="/docs/assets/img/articles/report-header-2.png">
<img class="screenshot" alt="Default Letter Head" src="{{docs_base_url}}/assets/img/articles/report-header-2.png">
If you are managing multiple companies in a single ERPNext account, then ensure that for each Company, default Letter Head is set in the Company master.

4
foundation/www/docs/user/manual/en/using-erpnext/articles/merging-documents.md
View File

@@ -13,7 +13,7 @@ Following are step to merge documents. Let's assume we are merging two Accounts.
For an Account to be merged, click on the "Rename" option.
<img alt="Sales Order File Attachment" class="screenshot" src="/docs/assets/img/articles/merge-docs-1.png">
<img alt="Sales Order File Attachment" class="screenshot" src="{{docs_base_url}}/assets/img/articles/merge-docs-1.png">
#### Step 3: Merge Account
@@ -21,7 +21,7 @@ In the New Name field, enter another account name with which this account will b
Following is how the merged account will appear in the Chart of Accounts master.
<img alt="Sales Order File Attachment" class="screenshot" src="/docs/assets/img/articles/merge-docs-2.gif">
<img alt="Sales Order File Attachment" class="screenshot" src="{{docs_base_url}}/assets/img/articles/merge-docs-2.gif">
###Effect of Merging

2
foundation/www/docs/user/manual/en/using-erpnext/articles/pos-view.md
View File

@@ -5,7 +5,7 @@ POS (point of sale) view renders form in a different layout, optimized for the q
Using POS View, you can only create Sales Invoice, without switching to standard form view. For other transactions, like Sales Order, Delivery Note, Purchase Order, Purchase Receipt etc., POS View is only used for Item selection. For entering other values in the transaction, you should switch to form view.
<img alt="POS View" class="screenshot" src="/docs/assets/img/articles/pos-view.gif">
<img alt="POS View" class="screenshot" src="{{docs_base_url}}/assets/img/articles/pos-view.gif">
For creating POS Invoice, check following help video.

2
foundation/www/docs/user/manual/en/using-erpnext/articles/renaming-documents.md
View File

@@ -9,7 +9,7 @@ Using Renaming feature, you can change ID of a master documents like Item, Wareh
#### 2. Rename
<img alt="Renamed Item" class="screenshot" src="/docs/assets/img/articles/rename-a-doc.gif">
<img alt="Renamed Item" class="screenshot" src="{{docs_base_url}}/assets/img/articles/rename-a-doc.gif">
###Effect of Renaming

8
foundation/www/docs/user/manual/en/using-erpnext/articles/search-filter.md
View File

@@ -9,20 +9,20 @@ Each filter option has three fields.
Select field of the document based on which you wish to filter records.
<img alt="Search Filter Field" class="screenshot" src="/docs/assets/img/articles/search-filter-field.gif">
<img alt="Search Filter Field" class="screenshot" src="{{docs_base_url}}/assets/img/articles/search-filter-field.gif">
#### Based On
With Field, you will provide a value. In the based on field, you can define a criterion that when filter should be applied in record. It will be when value define for the field if filter is:
<img alt="Search Filter Based On" class="screenshot" src="/docs/assets/img/articles/search-filter-based-on.gif">
<img alt="Search Filter Based On" class="screenshot" src="{{docs_base_url}}/assets/img/articles/search-filter-based-on.gif">
#### Value
A value should be entered in this field based on while records will be filtered. After filter is applied, records will be filtered based on it. And filter will shrunk under one field/button.
<img alt="Search Filter Based On" class="screenshot" src="/docs/assets/img/articles/search-filter-result.png">
<img alt="Search Filter Based On" class="screenshot" src="{{docs_base_url}}/assets/img/articles/search-filter-result.png">
You can apply multiple filters at a time. To remove specific filter, just click on cancelled (X) sign ahead of it.
@@ -31,6 +31,6 @@ You can apply multiple filters at a time. To remove specific filter, just click
From the list views, you can also apply filters by clicking on the Status field.
<img alt="Renamed Item" class="screenshot" src="/docs/assets/img/articles/search-filter-auto.gif">
<img alt="Renamed Item" class="screenshot" src="{{docs_base_url}}/assets/img/articles/search-filter-auto.gif">
<!-- markdown -->

4
foundation/www/docs/user/manual/en/using-erpnext/articles/tree-master-renaming.md
View File

@@ -13,12 +13,12 @@ Following are the steps to be followed for renaming ID of a master which is main
When click on the Account, you will find Rename option.
<img alt="Account" class="screenshot" src="/docs/assets/img/articles/rename-account.png">
<img alt="Account" class="screenshot" src="{{docs_base_url}}/assets/img/articles/rename-account.png">
#### Step 2: Rename Account
On clicking Rename, you will get field to enter New Name. After entering new name for the Account, click on the "Rename" button.
<img alt="Renamed Account" class="screenshot" src="/docs/assets/img/articles/rename-account-2.gif">
<img alt="Renamed Account" class="screenshot" src="{{docs_base_url}}/assets/img/articles/rename-account-2.gif">
<!-- markdown -->

8
foundation/www/docs/user/manual/en/using-erpnext/assignment.md
View File

@@ -13,13 +13,13 @@ Following are the steps to assign document to another user.
Assign to option is located at the footer of document. Clicking on Assignment Icon on the tool bar will fast-forward you to footer of same document.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/assign-1.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-1.png">
#### Step 2: Assign to User
In the Assign To section, you will find option to select User to whom this document will be assigned to. You can assign one document to multiple people at a time.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/assign-2.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-2.png">
With assignment, you can also leave a comment for the review of assignee.
@@ -27,13 +27,13 @@ With assignment, you can also leave a comment for the review of assignee.
This transaction will appear in the To-do list of the user in “Todo” section.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/assign-3.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-3.png">
####Removing Assignment
User will be able to remove assignment by clicking on "Assignment Completed" button in the document.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/assign-4.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-4.png">
Once assignment is set as completed, the Status of its ToDo record will be set as Closed.

12
foundation/www/docs/user/manual/en/using-erpnext/calendar.md
View File

@@ -5,7 +5,7 @@ The Calendar is a tool where you can create and share Events and also see auto-g
You can switch calendar view based on Month, Week and Day.
<img class="screenshot" alt="Calendar" src="/docs/assets/img/collaboration-tools/calendar-1.png">
<img class="screenshot" alt="Calendar" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-1.png">
### Creating Events in Calendar
@@ -15,7 +15,7 @@ To create event manually, you should first determine Calendar View. If Event's s
This view will 24 hours of a day broken in various slots. You should click on slot for Event Start Time, and drag it down till you reach event end time.
<img class="screenshot" alt="Calendar" src="/docs/assets/img/collaboration-tools/calendar-2.gif">
<img class="screenshot" alt="Calendar" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-2.gif">
Based on the selection of time slot, Start Time and End Time will be updated in the Event master. Then you can set subject for an event, and save it.
@@ -23,7 +23,7 @@ Based on the selection of time slot, Start Time and End Time will be updated in
In the Lead form, you will find a field called Next Contact By and Next Contact Date. Event will be auto created for date and person specified in this field.
<img class="screenshot" alt="Lead Event" src="/docs/assets/img/collaboration-tools/calendar-3.png">
<img class="screenshot" alt="Lead Event" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-3.png">
#### Birthday Event
@@ -34,7 +34,7 @@ Birthday Event is created based on Date of Birth specified in the Employee maste
You can set events as recurring in specific interval by Checking the "Repeat This
Event".
<img class="screenshot" alt="Calendar Recurring Event" src="/docs/assets/img/collaboration-tools/calendar-4.png">
<img class="screenshot" alt="Calendar Recurring Event" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-4.png">
### Event Reminders
@@ -44,7 +44,7 @@ There are two ways you can receive email reminder for an event.
In the Event master, checking "Send an email reminder in the morning" will trigger notification email to all the participants for this event.
<img class="screenshot" alt="Calendar Recurring Event" src="/docs/assets/img/collaboration-tools/calendar-6.png">
<img class="screenshot" alt="Calendar Recurring Event" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-6.png">
#### Create Email Digest
@@ -54,6 +54,6 @@ Email Digest can be set from:
`Setup > Email > Email Digest`
<img class="screenshot" alt="Calendar Recurring Event" src="/docs/assets/img/collaboration-tools/calender-email-digest.png">
<img class="screenshot" alt="Calendar Recurring Event" src="{{docs_base_url}}/assets/img/collaboration-tools/calender-email-digest.png">
{next}

4
foundation/www/docs/user/manual/en/using-erpnext/chat.md
View File

@@ -8,10 +8,10 @@ You can send and receive messages from the system by using the Messages tool.
If you send a message to a user, and the user is logged in, it will appear as a popup message and the unread messages counter in the top toolbar will be
updated.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/chat-1.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/chat-1.png">
You can choose to send message to all the users, or to specific user.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/chat-2.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/chat-2.png">
{next}

4
foundation/www/docs/user/manual/en/using-erpnext/collaborating-around-forms.md
View File

@@ -12,13 +12,13 @@ If some document requires an action from User, you can Assign that document to t
Comments are a great way to add information about a transaction that is not a
part of the transactions. Like some background information etc.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/comments-1.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/comments-1.png">
###Share
You can share document with the specific User. If Document is shared with the specific User, he/she will be able to access it, even if that User doesn't have permission to access that document or Document Type.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/share-1.gif">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/share-1.gif">
### Tags

6
foundation/www/docs/user/manual/en/using-erpnext/document-versioning.md
View File

@@ -7,16 +7,16 @@ The document versioning feature allows you to track all the changes made in the
Document Versioning can be enabled for one Document Type as a time. Let's assume that we need to enable it from Purchase Order. Then, we will check Customize Form tool for Purchase Order and check field `Track Changes`. With this, document versioning will be enabled for all the Purchase Orders create and edited hence forth.
<img class="screenshot" alt="Enable Versioning" src="/docs/assets/img/collaboration-tools/enable-versioning.png">
<img class="screenshot" alt="Enable Versioning" src="{{docs_base_url}}/assets/img/collaboration-tools/enable-versioning.png">
####Version Log
Following is link of version in a Purchase Order form. Each time a document is edited, a version's link will be added in that document. To check more details on specific version, click on it's link.
<img class="screenshot" alt="Version Links" src="/docs/assets/img/collaboration-tools/version-links.png">
<img class="screenshot" alt="Version Links" src="{{docs_base_url}}/assets/img/collaboration-tools/version-links.png">
####Version Details
In the Version document, you will find log of all the fields and values changes in it.
<img class="screenshot" alt="Version Details" src="/docs/assets/img/collaboration-tools/version-details.png">
<img class="screenshot" alt="Version Details" src="{{docs_base_url}}/assets/img/collaboration-tools/version-details.png">

4
foundation/www/docs/user/manual/en/using-erpnext/notes.md
View File

@@ -9,12 +9,12 @@ You can store your long notes under this section. It can contain your partner li
Enter Title and Context.
<img class="screenshot" alt="Note New" src="/docs/assets/img/collaboration-tools/note-1.png">
<img class="screenshot" alt="Note New" src="{{docs_base_url}}/assets/img/collaboration-tools/note-1.png">
####Set Permissions to select Users
To make Note accessible for all, check "Public" under links section. Else you can share it with the specific User by using Share feature.
<img class="screenshot" alt="Note New" src="/docs/assets/img/collaboration-tools/share-1.gif">
<img class="screenshot" alt="Note New" src="{{docs_base_url}}/assets/img/collaboration-tools/share-1.gif">
{next}

8
foundation/www/docs/user/manual/en/using-erpnext/restore-deleted-docs.md
View File

@@ -3,7 +3,7 @@
In ERPNext, you can delete a records if not needed. They can be masters like Items, Customer or transactions like Sales Order, Payment Entries etc.
<img class="screenshot" alt="Delete a Docuemnt" src="/docs/assets/img/collaboration-tools/delete-a-doc.png">
<img class="screenshot" alt="Delete a Docuemnt" src="{{docs_base_url}}/assets/img/collaboration-tools/delete-a-doc.png">
If you have deleted an entry by mistake and wish to restore it back into your ERPNext account.
@@ -15,18 +15,18 @@ Steps below to restore a deleted document.
For the list of deleted document, just type Deleted Document in the Search Bar and go to list.
<img class="screenshot" alt="Deleted Docs List" src="/docs/assets/img/collaboration-tools/deleted-docs-list.gif">
<img class="screenshot" alt="Deleted Docs List" src="{{docs_base_url}}/assets/img/collaboration-tools/deleted-docs-list.gif">
####Step 2: Open Doc and Restore
Open the document to be restored from the list. Click on Restore button.
<img class="screenshot" alt="Restored Doc" src="/docs/assets/img/collaboration-tools/restore-a-doc.png">
<img class="screenshot" alt="Restored Doc" src="{{docs_base_url}}/assets/img/collaboration-tools/restore-a-doc.png">
####Step 3: Restored
Once a document is restored, you will be able to use it for creating entries in your ERPNext account.
<img class="screenshot" alt="Restored Doc" src="/docs/assets/img/collaboration-tools/restored-doc.png">
<img class="screenshot" alt="Restored Doc" src="{{docs_base_url}}/assets/img/collaboration-tools/restored-doc.png">
> If canceled document is deleted, then it will not be restored.

4
foundation/www/docs/user/manual/en/using-erpnext/tags.md
View File

@@ -3,10 +3,10 @@
Like Assignments and Comments, you can also add your own tags to each type of transactions. These tags can help you search a document and also classify it.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/tags-1.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/tags-1.png">
ERPNext will also show you all the important tags in the document list.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/tags-2.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/tags-2.png">
{next}

4
foundation/www/docs/user/manual/en/using-erpnext/to-do.md
View File

@@ -3,10 +3,10 @@
To Do is a simple tool where all the activities [assigned](/docs/user/manual/en/using-erpnext/assignments.html) to you and assigned by you are listed. You can also add your own to-do items in the list.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/assign-3.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-3.png">
When task is completed, you should simply remove assignment from the assigned document. With this, task will be removed from your Todo list as well. For Todo which are not assigned via document, you can set their status as Closed from the Todo master itself.
<img class="screenshot" alt="Assign" src="/docs/assets/img/collaboration-tools/assign-4.png">
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-4.png">
{next}