Skip to content

Commit 8aedb37

Browse files
Remove word 'step' and link to docs main page
1 parent 97590cf commit 8aedb37

File tree

13 files changed

+91
-103
lines changed

13 files changed

+91
-103
lines changed

docs/developer_guide/module_development/areas.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ A working sample module for the described scenario can be accessed at the provid
5757

5858
The key steps in module development are as follows:
5959

60-
### Step 1: Create the Module Scaffold
60+
### Create the Module Scaffold
6161

6262
Start by creating a new directory for your module (e.g., `spp_custom_area`) and populate it
6363
with the basic Odoo module files (`__init__.py`, `__manifest__.py`) and the directory structure shown above.
6464

65-
### Step 2: Define Module Manifest
65+
### Define Module Manifest
6666

6767
Create a manifest file that includes the proper dependencies and data files:
6868

@@ -89,7 +89,7 @@ Create a manifest file that includes the proper dependencies and data files:
8989
}
9090
```
9191

92-
### Step 3: Extend the Area Model
92+
### Extend the Area Model
9393

9494
Create a Python file named `area.py` that extends the `spp.area` model and add it to `models/__init__.py`:
9595

@@ -119,7 +119,7 @@ class SPPArea(models.Model):
119119
], string="Population Source", default="census")
120120
```
121121

122-
### Step 4: Create View Extensions
122+
### Create View Extensions
123123

124124
Create a new file called `views/area_views.xml` in the module and add it to the manifest file:
125125

@@ -179,7 +179,7 @@ Create a new file called `views/area_views.xml` in the module and add it to the
179179
</odoo>
180180
```
181181

182-
### Step 5: Add Security Access (Optional)
182+
### Add Security Access (Optional)
183183

184184
If you introduce new models, add access rights. For simple field additions, this is not required. Example:
185185

@@ -192,7 +192,7 @@ access_spp_your_custom_model_admin,spp.your.custom.model.admin,spp_area_custom.m
192192
- **`g2p_registry_base.group_g2p_registrar`** for Registrar Access
193193
- **`g2p_registry_base.group_g2p_admin`** for Admin Access.
194194

195-
### Step 6: Add Custom Area Types (Optional)
195+
### Add Custom Area Types (Optional)
196196

197197
Create `data/area_kind_data.xml` to add custom area types:
198198

@@ -206,7 +206,7 @@ Create `data/area_kind_data.xml` to add custom area types:
206206
</odoo>
207207
```
208208

209-
### Step 7: Adding Computed Fields, Constrains, and Validations (Optional)
209+
### Adding Computed Fields, Constrains, and Validations (Optional)
210210

211211
On your `models/area.py` you can add computed fields, constrains, and validations:
212212

@@ -249,7 +249,7 @@ from odoo.exceptions import ValidationError
249249
```
250250
Then add the custom computed field to the `area_views.xml` file
251251

252-
### Step 8: Install and Test
252+
### Install and Test
253253

254254
1. Install or upgrade the module through the Apps menu.
255255
2. Test the new fields in the area forms and lists
@@ -262,5 +262,4 @@ The following screenshot shows the added population fields in the newly develope
262262

263263
For more information on extending OpenSPP modules, refer to:
264264
- [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
265-
- [OpenSPP Documentation](https://docs.openspp.org/)
266265
- [Area Management Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_area_base)

docs/developer_guide/module_development/audit.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ In this example, we customize the audit rule to include an `active` flag, allowi
5454

5555
A working sample module is available at [this link](https://github.com/OpenSPP/documentation_code/tree/main/howto/developer_guides/customizations/spp_audit_log_custom).
5656

57-
### Step 1: Create the Module Scaffold
57+
### Create the Module Scaffold
5858

5959
Start by creating a new directory for your module (e.g., `spp_audit_log_custom`) and populate it
6060
with the basic Odoo module files (`__init__.py`, `__manifest__.py`) and the directory structure shown above.
6161

62-
### Step 2: Define Module Manifest
62+
### Define Module Manifest
6363

6464
Create a manifest file with the correct dependencies and data files:
6565

@@ -87,7 +87,7 @@ Create a manifest file with the correct dependencies and data files:
8787
}
8888
```
8989

90-
### Step 3: Extend the Audit Rule Model
90+
### Extend the Audit Rule Model
9191

9292
Create `models/spp_audit_rule.py` and update `models/__init__.py`:
9393

@@ -103,7 +103,7 @@ class CustomAuditRule(models.Model):
103103
)
104104
```
105105

106-
### Step 4: Create View Extensions
106+
### Create View Extensions
107107

108108
Create `views/spp_audit_rule_views.xml` and add it to the manifest:
109109

@@ -122,7 +122,7 @@ Create `views/spp_audit_rule_views.xml` and add it to the manifest:
122122
</odoo>
123123
```
124124

125-
### Step 5: Add Security Access (Optional)
125+
### Add Security Access (Optional)
126126

127127
If you introduce new models, add access rights. For simple field additions, this is not required. Example:
128128

@@ -134,7 +134,7 @@ access_custom_spp_audit_rule,custom.spp.audit.rule,spp_audit_log.model_spp_audit
134134
- Group ID: **`g2p_registry_base.group_g2p_registrar`** for Registrar Access
135135
- Group ID: **`g2p_registry_base.group_g2p_admin`** for Admin Access.
136136

137-
### Step 6: Add Preconfigured Rules (Optional)
137+
### Add Preconfigured Rules (Optional)
138138

139139
Seed rules using `data/audit_rule_data.xml` and the `spp.audit.rule.create_rules` helper:
140140

@@ -153,7 +153,7 @@ Seed rules using `data/audit_rule_data.xml` and the `spp.audit.rule.create_rules
153153

154154
For parent/child rules (requires `spp_audit_post`), also pass `parent_rule_name` and `connecting_field_name`.
155155

156-
### Step 7: Install and Test
156+
### Install and Test
157157

158158
1. Install or upgrade the module through the Apps menu.
159159
2. Create or update records in the configured models (e.g., Individual or Group Registry).
@@ -169,7 +169,6 @@ For parent/child rules (requires `spp_audit_post`), also pass `parent_rule_name`
169169

170170
For more information on extending OpenSPP modules, refer to:
171171
- [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
172-
- [OpenSPP Documentation](https://docs.openspp.org/)
173172
- Audit module sources:
174173
- [`spp_audit_log`](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_audit_log)
175174
- [`spp_audit_post`](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_audit_post)

docs/developer_guide/module_development/change_requests.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ spp_change_request_add_children_demo/
5555

5656
## Step-by-Step Guide
5757

58-
### Step 1: Create the Module Scaffold
58+
### Create the Module Scaffold
5959

6060
Start by creating a new directory for your module (e.g., `spp_change_request_custom_type`) and populate it
6161
with the basic Odoo module files (`__init__.py`, `__manifest__.py`) and the directory structure shown above.
6262

63-
### Step 2: Define the Manifest (`__manifest__.py`)
63+
### Define the Manifest (`__manifest__.py`)
6464

6565
The manifest file declares your module's metadata and dependencies. It's crucial to list all the modules your
6666
CR type will interact with. For our "Add Child/Member" example, the dependencies are:
@@ -97,7 +97,7 @@ CR type will interact with. For our "Add Child/Member" example, the dependencies
9797

9898
Your dependencies will vary based on the data you need to access and modify.
9999

100-
### Step 3: Create the Change Request Models
100+
### Create the Change Request Models
101101

102102
This is the heart of your module. You'll create a new model that holds the specific data for your change
103103
request type.
@@ -220,7 +220,7 @@ request type.
220220
return selection
221221
```
222222

223-
### Step 4: Create the User Interface (Views)
223+
### Create the User Interface (Views)
224224

225225
Define the form view for your custom CR type.
226226

@@ -310,7 +310,7 @@ Define the form view for your custom CR type.
310310
sequence="10"/>
311311
```
312312

313-
### Step 5: Define Data Files
313+
### Define Data Files
314314

315315
Use XML data files to configure aspects of your CR type.
316316

@@ -358,7 +358,7 @@ Use XML data files to configure aspects of your CR type.
358358
</odoo>
359359
```
360360

361-
### Step 6: Set Up Security
361+
### Set Up Security
362362

363363
Grant users access to your new model in security/ir.model.access.csv. At a minimum, you need to provide access
364364
to the base user group.
@@ -369,7 +369,7 @@ id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
369369
access_spp_change_request_add_children_user,spp.change.request.add.children.user,model_spp_change_request_add_children,base.group_user,1,1,1,1
370370
```
371371

372-
### Step 7: Install and Test
372+
### Install and Test
373373

374374
1. Install or upgrade the module through the Apps menu.
375375
2. Create a new change request.
@@ -383,6 +383,5 @@ Always start with a clear definition of the data you need to collect and the sys
383383

384384
For more information on extending OpenSPP modules, refer to:
385385
- [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
386-
- [OpenSPP Documentation](https://docs.openspp.org/)
387386
- [Change Request Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_change_request)
388387
- [OpenSPP Change Request Demo: Add Child/Member Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_change_request_add_children_demo)

docs/developer_guide/module_development/cycles.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ spp_cycle_manager_fixed_interval/
5151

5252
## Step-by-Step Guide
5353

54-
### Step 1: Create the Module Scaffold
54+
### Create the Module Scaffold
5555

5656
Start by creating a new directory for your module (e.g., `spp_cycle_manager_fixed_interval`) and populate it with the basic Odoo module files and the directory structure shown above.
5757

58-
### Step 2: Define the Manifest (`__manifest__.py`)
58+
### Define the Manifest (`__manifest__.py`)
5959

6060
The manifest file declares your module's metadata and dependencies. Our cycle manager depends on `g2p_programs` and `spp_programs` for the base manager framework.
6161

@@ -84,7 +84,7 @@ The manifest file declares your module's metadata and dependencies. Our cycle ma
8484
}
8585
```
8686

87-
### Step 3: Create the Cycle Manager Model
87+
### Create the Cycle Manager Model
8888

8989
This is the core of your module. You will create a new model that inherits from the default cycle manager and overrides its behavior.
9090

@@ -110,7 +110,7 @@ This is the core of your module. You will create a new model that inherits from
110110
return start_date + relativedelta(months=6, days=-1)
111111
```
112112

113-
### Step 4: Register the New Manager
113+
### Register the New Manager
114114

115115
To make OpenSPP aware of your new manager, you must add it to the list of available cycle managers.
116116

@@ -133,7 +133,7 @@ To make OpenSPP aware of your new manager, you must add it to the list of availa
133133
return selection
134134
```
135135

136-
### Step 5: Create the User Interface
136+
### Create the User Interface
137137

138138
Create a form view for your manager. Since we are inheriting from the default manager, we can also inherit its view and modify it to hide the fields that are no longer relevant (like the recurrence rules).
139139

@@ -159,7 +159,7 @@ Create a form view for your manager. Since we are inheriting from the default ma
159159
</record>
160160
```
161161

162-
### Step 6: Extend the Program Creation Wizard
162+
### Extend the Program Creation Wizard
163163

164164
To improve user experience, add a selection to the "Create Program" wizard so users can choose your new manager from the start.
165165

@@ -245,7 +245,7 @@ To improve user experience, add a selection to the "Create Program" wizard so us
245245
</record>
246246
```
247247

248-
### Step 7: Set Up Security
248+
### Set Up Security
249249

250250
Grant users access to your new model in `security/ir.model.access.csv`.
251251

@@ -256,7 +256,7 @@ g2p_cycle_manager_fixed_interval_admin,Cycle Manager Fixed Interval Admin Access
256256
g2p_cycle_manager_fixed_interval_program_manager,Cycle Manager Fixed Interval Program Manager Access,spp_cycle_manager_fixed_interval.model_g2p_cycle_manager_fixed_interval,g2p_programs.g2p_program_manager,1,1,1,0
257257
```
258258

259-
### Step 8: Install and Test
259+
### Install and Test
260260

261261
1. Install or upgrade the module through the Apps menu.
262262
2. Navigate to **Programs** and click **Create Program**.
@@ -268,5 +268,4 @@ g2p_cycle_manager_fixed_interval_program_manager,Cycle Manager Fixed Interval Pr
268268

269269
For more information on extending OpenSPP modules, refer to:
270270
- [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
271-
- [OpenSPP Documentation](https://docs.openspp.org/)
272271
- [OpenSPP Programs Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_programs)

docs/developer_guide/module_development/dashboard.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ spp_custom_dashboard/
5050

5151
## Step-by-Step Guide
5252

53-
### Step 1: Create the Module Scaffold
53+
### Create the Module Scaffold
5454

5555
Start by creating a new directory for your module (e.g., `spp_custom_dashboard`) and populate it with the basic Odoo module files and the directory structure shown above.
5656

57-
### Step 2: Define the Manifest (`__manifest__.py`)
57+
### Define the Manifest (`__manifest__.py`)
5858

5959
The manifest file declares your module's metadata and dependencies. It's crucial to list all the modules your customization will interact with. Our dashboard depends on `spp_dashboard_base` for the core dashboard components and `spp_farmer_registry_base` for the data.
6060

@@ -85,7 +85,7 @@ The manifest file declares your module's metadata and dependencies. It's crucial
8585
}
8686
```
8787

88-
### Step 3: Prepare the Data on the Server (Python)
88+
### Prepare the Data on the Server (Python)
8989

9090
The dashboard needs data to display. We'll create a method on an existing model to gather and format this data. For our example, we'll extend the `res.partner` model, which represents farms and farmers in the `spp_farmer_registry_base` module.
9191

@@ -132,7 +132,7 @@ The dashboard needs data to display. We'll create a method on an existing model
132132
}
133133
```
134134

135-
### Step 4: Create the Dashboard Component (JavaScript)
135+
### Create the Dashboard Component (JavaScript)
136136

137137
The client-side component is responsible for calling the server to get the data and rendering the dashboard template.
138138

@@ -173,7 +173,7 @@ The client-side component is responsible for calling the server to get the data
173173
registry.category("actions").add("spp_custom_dashboard_tag", CustomDashboard);
174174
```
175175

176-
### Step 5: Design the Dashboard Layout (XML)
176+
### Design the Dashboard Layout (XML)
177177

178178
The XML template defines the structure and appearance of your dashboard. It uses the data prepared by the JavaScript component.
179179

@@ -225,7 +225,7 @@ The XML template defines the structure and appearance of your dashboard. It uses
225225
</templates>
226226
```
227227

228-
### Step 6: Register the Dashboard
228+
### Register the Dashboard
229229

230230
Finally, create a client action and a menu item to make your dashboard accessible in the Odoo interface.
231231

@@ -253,7 +253,7 @@ Finally, create a client action and a menu item to make your dashboard accessibl
253253
</odoo>
254254
```
255255

256-
### Step 7: Install and View Your Dashboard
256+
### Install and View Your Dashboard
257257

258258
1. Install or upgrade the module through the Apps menu.
259259
2. Refresh your browser.
@@ -263,5 +263,4 @@ Finally, create a client action and a menu item to make your dashboard accessibl
263263

264264
For more information on extending OpenSPP modules, refer to:
265265
- [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
266-
- [OpenSPP Documentation](https://docs.openspp.org/)
267266
- [OpenSPP Dashboard Base Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_dashboard_base)

docs/developer_guide/module_development/dms.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ spp_dms_school_documents/
3939

4040
## Step-by-Step Guide
4141

42-
### Step 1: Create the Module Scaffold
42+
### Create the Module Scaffold
4343

4444
Begin by creating a new directory for your module (e.g., `spp_dms_school_documents`) and add the basic Odoo module files: `__init__.py` and `__manifest__.py`. Then, create the `data` subdirectory.
4545

46-
### Step 2: Define the Manifest (`__manifest__.py`)
46+
### Define the Manifest (`__manifest__.py`)
4747

4848
The manifest file declares your module's metadata and its dependencies. Our module only needs to depend on `spp_dms` to get access to the `spp.dms.category` model.
4949

@@ -68,7 +68,7 @@ The manifest file declares your module's metadata and its dependencies. Our modu
6868
}
6969
```
7070

71-
### Step 3: Create the Data File
71+
### Create the Data File
7272

7373
This is where you define the new document categories. In the `data/` directory, create an XML file named `dms_category_data.xml`.
7474

@@ -93,7 +93,7 @@ This file will contain one or more `<record>` tags that create new entries in th
9393
```
9494
The `noupdate="1"` attribute prevents the data from being overwritten if the module is updated, which is standard practice for configuration data that users might modify.
9595

96-
### Step 4: Install and Use Your New Categories
96+
### Install and Use Your New Categories
9797

9898
1. Install or upgrade the module through the Apps menu.
9999
2. Install your new module (`spp_dms_school_documents`).
@@ -104,5 +104,4 @@ The `noupdate="1"` attribute prevents the data from being overwritten if the mod
104104

105105
For more information on extending OpenSPP modules, refer to:
106106
- [Odoo 17 Developer Documentation](https://www.odoo.com/documentation/17.0/developer/)
107-
- [OpenSPP Documentation](https://docs.openspp.org/)
108107
- [OpenSPP DMS Module Source](https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_dms)

0 commit comments

Comments
 (0)