-
Notifications
You must be signed in to change notification settings - Fork 7.3k
Page format for ERPNext docs
(SEO tags, meta description etc)
---
title: <Title of the page>
add_breadcrumbs: 1
show_sidebar: 0
metatags:
description: <A line or two describing the feature briefly.>
keywords: <feature name>, <related words>, frappe, erpnext new features, erp, open source erp, free erp, security
---
A one line definition explaining the master/transaction in bold.
Paragraph(s) which contain a brief introduction to the doctype, and what it's used for. Add an example/scenario/use case to explain the feature.
(Navigation) To access Sales Order, go to:
Home > Module Name > Section Name > Page Name
(add only where applicable, these will links)
Before creating and using sampledoctype it is advised to create the following first:
- Document 1
- Document 2
This section will contain the steps to create the doctype.
- Go to the sampledoctype list, click on New.
- Enter xyz, select abc in this field (mandatory fields) with basic explanation of the fields.
- Save/Submit/both. (Note that only transactions are submittable documents, masters can only be saved)
There are multiple ways to create certain doctypes, add subsections for those alternate methods. Skip if not present.
There may be additional fields/checkboxes that aren't mandatory or a part of 'features', list them here.
...and so on. These sub sections will list out the various features a doctype offers other than the mandatory fields required to save the doctype. These are usually seen under different sections below the first set of fields and can be expanded by clicking on them. For example: some additional fields/features for the Item doctype would be: Description, Inventory, Auto Re-order etc.
Tip: Indent an image/paragraph by a tab / 4 spaces to continue a numbered list below it. To link to a specific heading in the page, the link should be like this: /docs/user/manual/en/stock/item#26-serial-numbers-and-batches (click on the
#symbol next to the heading on the webpage.
After submitting a sampledoctype, you can perform the following actions: (These can be creating new doctypes from this doctype)
- doctype 1
- doctype 2
- doctype 3
[Add screenshot displaying the dashboard after saving submitting]
If there are any additional actions that can be performed with this document, they go here. For example, in a Payment Entry, there is Multi Currency Payment Entry, Internal Transfer, etc.
- This will be a list of related topics (links) from the manual.
- They can be links to other manual pages and links to other articles, same or different modules. For example, pages in Selling, Buying, and Stock have cross-related topics.
- Keep relevance in mind when adding a link in this section.
A page would usually contain only three main sections, 1. Prerequisites 2. How to Create and 3. Features. But for settings pages like Buying settings, this doesn't apply and the settings can be listed as:
- Section group (H2) 1.1 subsection field/checkbox..., (H3) 1.2... (H3)
- Section group 2.1 subsection/field etc. 2.2...
Examples for reference: Item, Sales Order
Note: Use realistic data for your screenshots and gifs, not test customer, test data. Use realistic names and sentences.
Note: Ensure your screenshots are clean and there's no cut off text.
For pointing out/highlighting buttons/areas use a sharp edged red box around it with the default red color on macOS #EE0000. Preferably use markdown style for linking images, it's just simpler: .
For screenshots/GIFs Ensure that you show the navigation part on the top left so that new users can quickly understand where the page is. Crop the screenshot so that there is only little padding width-wise, refer the item page above.