mkdocs.yml 15.1 KB
Newer Older
1
site_name: Developer Guide
2
repo_url: https://github.com/civicrm/civicrm-dev-docs
3
4
site_description: A guide for CiviCRM developers.
site_author: The CiviCRM community
Sean Madsen's avatar
Sean Madsen committed
5
theme: material
6

MikeyMJCO's avatar
MikeyMJCO committed
7
nav:
8
- Home: index.md
Sean Madsen's avatar
Sean Madsen committed
9
- Basics:
Sean Madsen's avatar
Sean Madsen committed
10
  - Developer Community: basics/community.md
11
  - Requirements: basics/requirements.md
Sean Madsen's avatar
Sean Madsen committed
12
13
  - Useful Skills: basics/skills.md
  - Planning Your Project: basics/planning.md
Sean Madsen's avatar
Sean Madsen committed
14
- Tools:
Sean Madsen's avatar
Sean Madsen committed
15
  - Development Tools: tools/index.md
Sean Madsen's avatar
Sean Madsen committed
16
17
18
  - Buildkit: tools/buildkit.md
  - civibuild: tools/civibuild.md
  - cividist: tools/cividist.md
mickadoo's avatar
mickadoo committed
19
  - civilint: tools/civilint.md
20
  - civi-test-run: tools/civi-test-run.md
21
22
  - Issue Tracking: tools/issue-tracking.md
  - Git, GitHub, & GitLab: tools/git.md
23
  - Jenkins: tools/jenkins.md
24
25
  - PhpStorm: tools/phpstorm.md
  - Debugging: tools/debugging.md
totten's avatar
totten committed
26
  - Universe: tools/universe.md
Sean Madsen's avatar
Sean Madsen committed
27
- Core:
Sean Madsen's avatar
Sean Madsen committed
28
29
  - When to Edit Core: core/hacking.md
  - How to Contribute: core/contributing.md
wmortada's avatar
wmortada committed
30
  - Reviewing a PR: core/pr-review.md
31
  - Verifying a Bug Fix: core/verify-fix.md
32
  - Release Process: core/release-process.md
JoeMurray's avatar
JoeMurray committed
33
34
- Financial:
  - Overview: financial/overview.md
MikeyMJCO's avatar
MikeyMJCO committed
35
36
  - Order API: financial/orderAPI.md
  - Payment API: financial/paymentAPI.md
MikeyMJCO's avatar
MikeyMJCO committed
37
  - Entities: financial/financialentities.md
Sean Madsen's avatar
Sean Madsen committed
38
- Extensions:
Sean Madsen's avatar
Sean Madsen committed
39
  - Basics: extensions/index.md
Sean Madsen's avatar
Sean Madsen committed
40
  - Packaging Options: extensions/packaging.md
Sean Madsen's avatar
Sean Madsen committed
41
  - civix: extensions/civix.md
42
  - Extension Structure: extensions/structure.md
Sean Madsen's avatar
Sean Madsen committed
43
  - info.xml File: extensions/info-xml.md
Sean Madsen's avatar
Sean Madsen committed
44
  - Publishing Extensions: extensions/publish.md
45
  - Extension Lifecycle: extensions/lifecycle.md
Sean Madsen's avatar
Sean Madsen committed
46
  - Troubleshooting: extensions/troubleshooting.md
Sean Madsen's avatar
Sean Madsen committed
47
  - Advanced Patterns: extensions/advanced.md
Sean Madsen's avatar
Sean Madsen committed
48
49
  - Payment Processors:
    - Payment Processors: extensions/payment-processors/index.md
50
    - Payment Processor Types: extensions/payment-processors/types.md
Sean Madsen's avatar
Sean Madsen committed
51
    - Creating a Payment Processor: extensions/payment-processors/create.md
52
  - CMS-specific development: extensions/cms-specific.md
53
- API:
Seamus Lee's avatar
Seamus Lee committed
54
55
  - API Intro: api/index.md
  - API Interfaces: api/interfaces.md
56
57
  - APIv4:
    - APIv4 Usage: api/v4/usage.md
58
    - APIv4 Actions: api/v4/actions.md
59
60
    - APIv4 Joins: api/v4/joins.md
    - APIv4 Chaining: api/v4/chaining.md
61
    - APIv4 Custom Data: api/v4/custom-data.md
colemanw's avatar
colemanw committed
62
    - APIv4 Architecture: api/v4/architecture.md
colemanw's avatar
colemanw committed
63
    - Differences Between Api v3 and v4: api/v4/differences-with-v3.md
64
    - APIv4 Changelog: api/v4/changes.md
Seamus Lee's avatar
Seamus Lee committed
65
66
67
68
69
70
71
72
  - APIv3:
    - APIv3 Usage: api/v3/usage.md
    - APIv3 Actions: api/v3/actions.md
    - APIv3 Options: api/v3/options.md
    - APIv3 Joins: api/v3/joins.md
    - APIv3 Chaining: api/v3/chaining.md
    - APIv3 Custom Data: api/v3/custom-data.md
    - APIv3 Examples: api/v3/examples.md
73
    - APIv3 Changelog: api/v3/changes.md
MikeyMJCO's avatar
MikeyMJCO committed
74
    - WordPress REST Interface: api/v3/wp-rest.md
75
- Hooks:
76
  - Hooks Introduction: hooks/index.md
77
  - Hooks Changelog: hooks/changes.md
78
  - Usage:
ayduns's avatar
ayduns committed
79
80
81
82
83
    - Hooks in Extensions: hooks/usage/extension.md
    - Hooks in Symfony: hooks/usage/symfony.md
    - Hooks in Drupal: hooks/usage/drupal.md
    - Hooks in Joomla: hooks/usage/joomla.md
    - Hooks in WordPress: hooks/usage/wordpress.md
84
  - All Hooks: hooks/list.md
Sean Madsen's avatar
Sean Madsen committed
85
  - Batch Hooks:
Andie Hunt's avatar
Andie Hunt committed
86
87
    - hook_civicrm_batchItems: hooks/hook_civicrm_batchItems.md
    - hook_civicrm_batchQuery: hooks/hook_civicrm_batchQuery.md
Sean Madsen's avatar
Sean Madsen committed
88
  - Case Hooks:
Andie Hunt's avatar
Andie Hunt committed
89
90
91
92
    - hook_civicrm_caseChange: hooks/hook_civicrm_caseChange.md
    - hook_civicrm_caseTypes: hooks/hook_civicrm_caseTypes.md
    - hook_civicrm_post_case_merge: hooks/hook_civicrm_post_case_merge.md
    - hook_civicrm_pre_case_merge: hooks/hook_civicrm_pre_case_merge.md
Sean Madsen's avatar
Sean Madsen committed
93
  - Database Hooks:
94
    - hook_civicrm_alterLocationMergeData: hooks/hook_civicrm_alterLocationMergeData.md
95
96
97
98
99
    - hook_civicrm_copy: hooks/hook_civicrm_copy.md
    - hook_civicrm_custom: hooks/hook_civicrm_custom.md
    - hook_civicrm_managed: hooks/hook_civicrm_managed.md
    - hook_civicrm_merge: hooks/hook_civicrm_merge.md
    - hook_civicrm_post: hooks/hook_civicrm_post.md
totten's avatar
totten committed
100
    - hook_civicrm_postCommit: hooks/hook_civicrm_postCommit.md
Andie Hunt's avatar
Andie Hunt committed
101
    - hook_civicrm_postSave_table_name: hooks/hook_civicrm_postSave_table_name.md
102
103
    - hook_civicrm_pre: hooks/hook_civicrm_pre.md
    - hook_civicrm_referenceCounts: hooks/hook_civicrm_referenceCounts.md
104
105
106
107
    - hook_civicrm_triggerInfo: hooks/hook_civicrm_triggerInfo.md
  - Dedupe Hooks:
    - hook_civicrm_dupeQuery: hooks/hook_civicrm_dupeQuery.md
    - hook_civicrm_findDuplicates: hooks/hook_civicrm_findDuplicates.md
Sean Madsen's avatar
Sean Madsen committed
108
  - Entity Hooks:
Andie Hunt's avatar
Andie Hunt committed
109
    - hook_civicrm_entityTypes: hooks/hook_civicrm_entityTypes.md
mattwire's avatar
mattwire committed
110
  - Extension Lifecycle Hooks:
111
112
113
    - hook_civicrm_disable: hooks/hook_civicrm_disable.md
    - hook_civicrm_enable: hooks/hook_civicrm_enable.md
    - hook_civicrm_install: hooks/hook_civicrm_install.md
Andie Hunt's avatar
Andie Hunt committed
114
    - hook_civicrm_postInstall: hooks/hook_civicrm_postInstall.md
115
116
    - hook_civicrm_uninstall: hooks/hook_civicrm_uninstall.md
    - hook_civicrm_upgrade: hooks/hook_civicrm_upgrade.md
Sean Madsen's avatar
Sean Madsen committed
117
  - Form Hooks:
118
    - hook_civicrm_alterAngular: hooks/hook_civicrm_alterAngular.md
119
    - hook_civicrm_alterContent: hooks/hook_civicrm_alterContent.md
Andie Hunt's avatar
Andie Hunt committed
120
    - hook_civicrm_alterTemplateFile: hooks/hook_civicrm_alterTemplateFile.md
121
    - hook_civicrm_buildForm: hooks/hook_civicrm_buildForm.md
Andie Hunt's avatar
Andie Hunt committed
122
    - hook_civicrm_idsException: hooks/hook_civicrm_idsException.md
123
124
    - hook_civicrm_postProcess: hooks/hook_civicrm_postProcess.md
    - hook_civicrm_preProcess: hooks/hook_civicrm_preProcess.md
125
    - <del>hook_civicrm_validate</del>: hooks/hook_civicrm_validate.md
Andie Hunt's avatar
Andie Hunt committed
126
    - hook_civicrm_validateForm: hooks/hook_civicrm_validateForm.md
Sean Madsen's avatar
Sean Madsen committed
127
  - GUI Hooks:
128
    - hook_civicrm_activeTheme: hooks/hook_civicrm_activeTheme.md
Pradeep Nayak's avatar
Typo    
Pradeep Nayak committed
129
    - hook_civicrm_alterCustomFieldDisplayValue: hooks/hook_civicrm_alterCustomFieldDisplayValue.md
130
    - hook_civicrm_alterEntityRefParams: hooks/hook_civicrm_alterEntityRefParams.md
Andie Hunt's avatar
Andie Hunt committed
131
    - hook_civicrm_alterMenu: hooks/hook_civicrm_alterMenu.md
132
133
    - hook_civicrm_buildAmount: hooks/hook_civicrm_buildAmount.md
    - hook_civicrm_caseSummary: hooks/hook_civicrm_caseSummary.md
Andie Hunt's avatar
Andie Hunt committed
134
    - hook_civicrm_contact_get_displayname: hooks/hook_civicrm_contact_get_displayname.md
135
    - <del>hook_civicrm_customFieldOptions</del>: hooks/hook_civicrm_customFieldOptions.md
136
    - hook_civicrm_dashboard: hooks/hook_civicrm_dashboard.md
Andie Hunt's avatar
Andie Hunt committed
137
    - hook_civicrm_dashboard_defaults: hooks/hook_civicrm_dashboard_defaults.md
MikeyMJCO's avatar
MikeyMJCO committed
138
    - hook_civicrm_entityRefFilters: hooks/hook_civicrm_entityRefFilters.md
Andie Hunt's avatar
Andie Hunt committed
139
    - hook_civicrm_fieldOptions: hooks/hook_civicrm_fieldOptions.md
140
141
142
143
144
145
146
    - hook_civicrm_links: hooks/hook_civicrm_links.md
    - hook_civicrm_navigationMenu: hooks/hook_civicrm_navigationMenu.md
    - hook_civicrm_pageRun: hooks/hook_civicrm_pageRun.md
    - hook_civicrm_searchColumns: hooks/hook_civicrm_searchColumns.md
    - hook_civicrm_searchTasks: hooks/hook_civicrm_searchTasks.md
    - hook_civicrm_summary: hooks/hook_civicrm_summary.md
    - hook_civicrm_summaryActions: hooks/hook_civicrm_summaryActions.md
Seamus Lee's avatar
Seamus Lee committed
147
    - hook_civicrm_themes: hooks/hook_civicrm_themes.md
148
    - <del>hook_civicrm_tabs</del>: hooks/hook_civicrm_tabs.md
149
    - hook_civicrm_tabset: hooks/hook_civicrm_tabset.md
Andie Hunt's avatar
Andie Hunt committed
150
    - hook_civicrm_xmlMenu: hooks/hook_civicrm_xmlMenu.md
Sean Madsen's avatar
Sean Madsen committed
151
  - Mail Hooks:
Andie Hunt's avatar
Andie Hunt committed
152
153
    - hook_civicrm_alterMailContent: hooks/hook_civicrm_alterMailContent.md
    - hook_civicrm_alterMailer: hooks/hook_civicrm_alterMailer.md
154
    - hook_civicrm_alterMailParams: hooks/hook_civicrm_alterMailParams.md
155
    - hook_civicrm_alterMailingRecipients: hooks/hook_civicrm_alterMailingRecipients.md
156
157
158
159
160
    - hook_civicrm_emailProcessor: hooks/hook_civicrm_emailProcessor.md
    - hook_civicrm_emailProcessorContact: hooks/hook_civicrm_emailProcessorContact.md
    - hook_civicrm_mailingGroups: hooks/hook_civicrm_mailingGroups.md
    - hook_civicrm_postEmailSend: hooks/hook_civicrm_postEmailSend.md
    - hook_civicrm_postMailing: hooks/hook_civicrm_postMailing.md
Andie Hunt's avatar
Andie Hunt committed
161
    - hook_civicrm_unsubscribeGroups: hooks/hook_civicrm_unsubscribeGroups.md
162
163
164
  - Membership Hooks:
    - hook_civicrm_alterCalculatedMembershipStatus: hooks/hook_civicrm_alterCalculatedMembershipStatus.md
    - hook_civicrm_membershipTypeValues: hooks/hook_civicrm_membershipTypeValues.md
Sean Madsen's avatar
Sean Madsen committed
165
  - Permission Hooks:
166
167
168
    - hook_civicrm_aclGroup: hooks/hook_civicrm_aclGroup.md
    - hook_civicrm_aclWhereClause: hooks/hook_civicrm_aclWhereClause.md
    - hook_civicrm_alterAPIPermissions: hooks/hook_civicrm_alterAPIPermissions.md
169
    - hook_civicrm_notePrivacy: hooks/hook_civicrm_notePrivacy.md
170
    - hook_civicrm_permission: hooks/hook_civicrm_permission.md
Andie Hunt's avatar
Andie Hunt committed
171
    - hook_civicrm_permission_check: hooks/hook_civicrm_permission_check.md
172
    - hook_civicrm_selectWhereClause: hooks/hook_civicrm_selectWhereClause.md
Sean Madsen's avatar
Sean Madsen committed
173
  - Profile Hooks:
Andie Hunt's avatar
Andie Hunt committed
174
175
176
177
178
179
    - hook_civicrm_buildProfile: hooks/hook_civicrm_buildProfile.md
    - hook_civicrm_buildUFGroupsForModule: hooks/hook_civicrm_buildUFGroupsForModule.md
    - hook_civicrm_processProfile: hooks/hook_civicrm_processProfile.md
    - hook_civicrm_searchProfile: hooks/hook_civicrm_searchProfile.md
    - hook_civicrm_validateProfile: hooks/hook_civicrm_validateProfile.md
    - hook_civicrm_viewProfile: hooks/hook_civicrm_viewProfile.md
Sean Madsen's avatar
Sean Madsen committed
180
  - Report Hooks:
Andie Hunt's avatar
Andie Hunt committed
181
    - hook_civicrm_alterReportVar: hooks/hook_civicrm_alterReportVar.md
Sean Madsen's avatar
Sean Madsen committed
182
  - SMS Hooks:
183
    - hook_civicrm_inboundSMS: hooks/hook_civicrm_inboundSMS.md
184
185
186
187
  - Scheduled Job / cron Hooks:
    - hook_civicrm_cron: hooks/hook_civicrm_cron.md
    - hook_civicrm_preJob: hooks/hook_civicrm_preJob.md
    - hook_civicrm_postJob: hooks/hook_civicrm_postJob.md
Sean Madsen's avatar
Sean Madsen committed
188
  - Uncategorized Hooks:
189
    - hook_civicrm_alterBadge: hooks/hook_civicrm_alterBadge.md
Andie Hunt's avatar
Andie Hunt committed
190
    - hook_civicrm_alterBarcode: hooks/hook_civicrm_alterBarcode.md
191
    - hook_civicrm_alterExternUrl: hooks/hook_civicrm_alterExternUrl.md
Andie Hunt's avatar
Andie Hunt committed
192
193
    - hook_civicrm_alterLogTables: hooks/hook_civicrm_alterLogTables.md
    - hook_civicrm_alterMailingLabelParams: hooks/hook_civicrm_alterMailingLabelParams.md
194
195
196
    - hook_civicrm_alterPaymentProcessorParams: hooks/hook_civicrm_alterPaymentProcessorParams.md
    - hook_civicrm_alterSettingsFolders: hooks/hook_civicrm_alterSettingsFolders.md
    - hook_civicrm_alterSettingsMetaData: hooks/hook_civicrm_alterSettingsMetaData.md
197
    - hook_civicrm_alterUFFIelds: hooks/hook_civicrm_alterUFFields.md
Andie Hunt's avatar
Andie Hunt committed
198
    - hook_civicrm_angularModules: hooks/hook_civicrm_angularModules.md
199
    - hook_civicrm_apiWrappers: hooks/hook_civicrm_apiWrappers.md
200
    - hook_civicrm_buildAsset: hooks/hook_civicrm_buildAsset.md
201
    - hook_civicrm_buildStateProvinceForCountry: hooks/hook_civicrm_buildStateProvinceForCountry.md
Andie Hunt's avatar
Andie Hunt committed
202
    - hook_civicrm_check: hooks/hook_civicrm_check.md
203
    - hook_civicrm_config: hooks/hook_civicrm_config.md
204
    - <del>hook_civicrm_contactListQuery</del>: hooks/hook_civicrm_contactListQuery.md
Andie Hunt's avatar
Andie Hunt committed
205
206
207
208
    - hook_civicrm_container: hooks/hook_civicrm_container.md
    - hook_civicrm_coreResourceList: hooks/hook_civicrm_coreResourceList.md
    - hook_civicrm_crudLink: hooks/hook_civicrm_crudLink.md
    - hook_civicrm_eventDiscount: hooks/hook_civicrm_eventDiscount.md
209
    - hook_civicrm_export: hooks/hook_civicrm_export.md
Andie Hunt's avatar
Andie Hunt committed
210
211
    - hook_civicrm_fileSearches: hooks/hook_civicrm_fileSearches.md
    - hook_civicrm_geocoderFormat: hooks/hook_civicrm_geocoderFormat.md
212
    - hook_civicrm_getAssetUrl: hooks/hook_civicrm_getAssetUrl.md
213
    - hook_civicrm_import: hooks/hook_civicrm_import.md
Andie Hunt's avatar
Andie Hunt committed
214
    - <del>hook_civicrm_optionValues</del>: hooks/hook_civicrm_optionValues.md
215
    - hook_civicrm_postIPNProcess: hooks/hook_civicrm_postIPNProcess.md
Andie Hunt's avatar
Andie Hunt committed
216
    - hook_civicrm_queryObjects: hooks/hook_civicrm_queryObjects.md
217
    - hook_civicrm_recent: hooks/hook_civicrm_recent.md
Andie Hunt's avatar
Andie Hunt committed
218
219
    - hook_civicrm_tokens: hooks/hook_civicrm_tokens.md
    - hook_civicrm_tokenValues: hooks/hook_civicrm_tokenValues.md
220
    - hook_civicrm_unhandledException: hooks/hook_civicrm_unhandledException.md
221
- Testing:
222
  - Testing: testing/index.md
223
  - Continuous Integration: testing/continuous-integration.md
224
225
  - PHP:
    - PHPUnit Tests: testing/phpunit.md
226
    # - Codeception Tests: testing/codeception.md
227
228
229
    - Selenium Tests: testing/selenium.md
  - Javascript:
    - Karma Tests: testing/karma.md
230
    # - Protractor Tests: testing/protractor.md
231
232
233
234
    - QUnit Tests: testing/qunit.md
  - Other:
    - Upgrade Tests: testing/upgrades.md
    - Manual Tests: testing/manual.md
235
236
237
238
239
240
241
- Security:
  - Secure Coding: security/index.md
  - Securing Inputs: security/inputs.md
  - Securing Outputs: security/outputs.md
  - Permissions: security/permissions.md
  - Access Control: security/access.md
  - Reporting Vulnerabilities: security/reporting.md
totten's avatar
totten committed
242
- Framework:
243
244
245
246
247
248
249
250
251
252
253
  - AJAX Pages and Forms Reference: framework/ajax.md
  - AngularJS:
    - AngularJS Intro: framework/angular/index.md
    - AngularJS Quick Start: framework/angular/quickstart.md
    - AngularJS File Names: framework/angular/files.md
    - AngularJS Loader: framework/angular/loader.md
    - AngularJS Changesets:  framework/angular/changeset.md
  - Asset Builder: framework/asset-builder.md
  - Bootstrap Process: framework/bootstrap.md
  - Backbone Reference: framework/backbone.md
  - Cache Reference: framework/cache.md
Sean Madsen's avatar
Sean Madsen committed
254
  - CiviMail: framework/civimail.md
255
  - CiviReport: framework/civireport.md
256
  - Codebase: framework/codebase.md
257
258
259
260
261
  - Database:
    - Overview: framework/database/index.md
    - XML Schema definition: framework/database/schema-definition.md
    - Schema Design: framework/database/schema-design.md
    - Transaction Reference: framework/database/transactions.md
262
  - File System: framework/filesystem.md
263
264
265
266
  - PseudoConstant Reference: framework/pseudoconstant.md
  - QuickForm Reference:
     - QuickForm: framework/quickform/index.md
     - Entity Reference Field: framework/quickform/entityref.md
Rich's avatar
Rich committed
267
  - Queue Reference: framework/queues/index.md
268
  - Region Reference: framework/region.md
Sean Madsen's avatar
Sean Madsen committed
269
  - Routing: framework/routing.md
270
271
  - Resources Reference: framework/resources.md
  - Setting Reference: framework/setting.md
totten's avatar
totten committed
272
273
274
275
276
277
  - Setup Reference:
    - Overview: framework/setup/index.md
    - Getting Started: framework/setup/getting-started.md
    - New Installer: framework/setup/new-installer.md
    - New Plugin: framework/setup/new-plugin.md
    - Manage Plugins: framework/setup/plugins.md
278
279
280
281
  - Template Reference:
    - Templates: framework/templates/index.md
    - Customizing Templates: framework/templates/customizing.md
    - Extending Smarty: framework/templates/extending-smarty.md
totten's avatar
totten committed
282
  - Theme Reference: framework/theme.md
283
  - Token Reference: framework/token.md
284
285
  - UI Reference: framework/ui.md
  - Upgrade Reference: framework/upgrade.md
bgm's avatar
bgm committed
286
- Translation:
287
  - Translation: translation/index.md
bgm's avatar
bgm committed
288
289
  - Extensions Translation: translation/extensions.md
  - Database localized fields and upgrades: translation/database.md
totten's avatar
totten committed
290
- Standards:
291
292
293
294
295
  - Coding Standards: standards/index.md
  - PHP Standards: standards/php.md
  - Javascript Standards: standards/javascript.md
  - Database Standards: standards/database.md
  - Review Standards: standards/review.md
296
- Documentation:
Sean Madsen's avatar
Sean Madsen committed
297
  - Writing Documentation: documentation/index.md
298
  - Documenting Extensions: documentation/extensions.md
Sean Madsen's avatar
Sean Madsen committed
299
  - Markdown: documentation/markdown.md
Sean Madsen's avatar
Sean Madsen committed
300
  - Style Guide: documentation/style-guide.md
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322


markdown_extensions:
  - attr_list
  - admonition
  - def_list
  - toc:
      permalink: true
  - pymdownx.highlight:
      guess_lang: true
      extend_pygments_lang:
        - name: php
          lang: php
          options:
            startinline: true
  - pymdownx.superfences:
      css_class: codehilite
  - pymdownx.inlinehilite:
      css_class: codehilite
  - pymdownx.tilde
  - pymdownx.betterem
  - pymdownx.mark