/
mkdocs.yml
261 lines (256 loc) · 14.2 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
site_name: eZ Platform Developer Documentation
repo_url: https://github.com/ezsystems/developer-documentation
copyright: "Copyright 1999-2017 eZ Systems AS and others"
pages:
- 'Documentation': 'index.md'
- Getting started:
- 'Quickstart': 'getting_started/quickstart.md'
- 'Requirements': 'getting_started/requirements.md'
- 'Install eZ Platform': 'getting_started/install_ez_platform.md'
- 'Install eZ Enterprise': 'getting_started/install_ez_enterprise.md'
- 'First steps': 'getting_started/first_steps.md'
- 'Bundles starter pack': 'getting_started/bundles_starter_pack.md'
- 'Troubleshooting': 'getting_started/troubleshooting.md'
- Tutorials:
- eZ Platform beginner:
- 'eZ Platform beginner tutorial': 'tutorials/platform_beginner/building_a_bicycle_route_tracker_in_ez_platform.md'
- '1. Get ready': 'tutorials/platform_beginner/1_get_ready.md'
- '2. Create the content model': 'tutorials/platform_beginner/2_create_the_content_model.md'
- '3. Customize the front page': 'tutorials/platform_beginner/3_customize_the_front_page.md'
- '4. Display a list of content items': 'tutorials/platform_beginner/4_display_a_list_of_content_items.md'
- '5. Improve configuration': 'tutorials/platform_beginner/5_improve_configuration.md'
- '6. Embed content': 'tutorials/platform_beginner/6_embed_content.md'
- '7. Enable account registration': 'tutorials/platform_beginner/7_enable_account_registration.md'
- eZ Enterprise beginner:
- 'eZ Enterprise beginner tutorial': 'tutorials/enterprise_beginner/ez_enterprise_beginner_tutorial_-_its_a_dogs_world.md'
- '1. Get a starter website': 'tutorials/enterprise_beginner/1_get_a_starter_website.md'
- '2. Prepare the Landing Page': 'tutorials/enterprise_beginner/2_prepare_the_landing_page.md'
- '3. Use existing blocks': 'tutorials/enterprise_beginner/3_use_existing_blocks.md'
- '4. Create a custom block': 'tutorials/enterprise_beginner/4_create_a_custom_block.md'
- Create a Field Type:
- 'Create a Tweet Field Type': 'tutorials/field_type/creating_a_tweet_field_type.md'
- '1. Create the bundle': 'tutorials/field_type/1_create_the_bundle.md'
- '2. Implement the Tweet\Value Class': 'tutorials/field_type/2_implement_the_tweet_value_class.md'
- '3. Implement the Tweet\Type Class': 'tutorials/field_type/3_implement_the_tweet_type_class.md'
- '4. Register the Field Type as a service': 'tutorials/field_type/4_register_the_field_type_as_a_service.md'
- '5. Implement the legacy storage engine': 'tutorials/field_type/5_implement_the_legacy_storage_engine_converter.md'
- '6. Introduce a template': 'tutorials/field_type/6_introduce_a_template.md'
- '7. Allow adding and editing the Field in Back Office': 'tutorials/field_type/7_allow_adding_and_editing_the_field_in_back_office.md'
- '8. Add a validation': 'tutorials/field_type/8_add_a_validation.md'
- Extending Admin UI:
- 'Extending Admin UI': 'tutorials/extending_admin_ui/extending_admin_ui.md'
- '1. Creating a bundle': 'tutorials/extending_admin_ui/1_creating_a_bundle.md'
- '2. Creating a Dashboard tab': 'tutorials/extending_admin_ui/2_creating_a_dashboard_tab.md'
- '3. Creating a content list': 'tutorials/extending_admin_ui/3_creating_a_content_list.md'
- '4. Filtering the content list': 'tutorials/extending_admin_ui/4_filtering_the_content_list.md'
- '5. Creating a UDW tab': 'tutorials/extending_admin_ui/5_creating_a_udw_tab.md'
- '6. Creating a custom tag': 'tutorials/extending_admin_ui/6_adding_a_custom_tag.md'
- API:
- REST API guide:
- 'REST API guide': 'api/rest_api_guide.md'
- 'REST API usage': 'api/general_rest_usage.md'
- 'Extending the REST API': 'api/extending_the_rest_api.md'
- 'JavaScript client': 'api/js_client.md'
- 'REST API reference': 'api/rest_api_reference.md'
- Public PHP API:
- 'Public PHP API': 'api/public_php_api.md'
- 'Customization': 'api/public_php_api_customization.md'
- 'Browsing, finding, viewing': 'api/public_php_api_browsing.md'
- 'Managing Content': 'api/public_php_api_managing_content.md'
- 'Locations': 'api/public_php_api_locations.md'
- Field Type:
- 'Field Type API': 'api/field_type_api.md'
- 'Reference': 'api/field_type_reference.md'
- 'REST API interaction': 'api/field_type_REST.md'
- 'Public API interaction': 'api/field_type_public.md'
- 'Schema': 'api/field_type_setting_schema.md'
- 'Template': 'api/field_type_template.md'
- 'Registration': 'api/field_type_registration.md'
- 'Testing': 'api/field_type_testing.md'
- 'Storage': 'api/field_type_storage.md'
- 'Search': 'api/field_type_search.md'
- Guide:
- 'Architecture': 'guide/architecture.md'
- 'Bundles': 'guide/bundles.md'
- 'Configuration': 'guide/configuration.md'
- Content rendering:
- 'Content model': 'guide/content_model.md'
- 'Content rendering': 'guide/content_rendering.md'
- 'Controllers': 'guide/controllers.md'
- 'Templates': 'guide/templates.md'
- 'Design engine': 'guide/design_engine.md'
- 'Page rendering': 'guide/page_rendering.md'
- 'Twig functions reference': 'guide/twig_functions_reference.md'
- Content management:
- 'Images': 'guide/images.md'
- 'File management': 'guide/file_management.md'
- 'URL management': 'guide/url_management.md'
- 'User-generated content': 'guide/user_generated_content.md'
- Permissions:
- 'Permissions': 'guide/permissions.md'
- 'Limitations': 'guide/limitations.md'
- 'User management': 'guide/user_management.md'
- 'Custom Policies': 'guide/custom_policies.md'
- 'Backup': 'guide/backup.md'
- Search:
- 'Search': 'guide/search.md'
- 'Solr search engine': 'guide/solr.md'
- 'Other search engines': 'guide/search_engines.md'
- Multisite:
- 'Multisite': 'guide/multisite.md'
- 'SiteAccess': 'guide/siteaccess.md'
- 'Languages': 'guide/internationalization.md'
- Repository:
- 'Repository': 'guide/repository.md'
- 'SignalSlots': 'guide/signalslots.md'
- Cache:
- 'HTTP cache': 'guide/http_cache.md'
- 'Persistence cache': 'guide/persistence_cache.md'
- 'Clustering': 'guide/clustering.md'
- DevOps:
- 'DevOps': 'guide/devops.md'
- 'Performance': 'guide/performance.md'
- 'Environments': 'guide/environments.md'
- 'Sessions': 'guide/sessions.md'
- Security:
- 'Development Security': 'guide/security.md'
- 'Reporting Issues': 'guide/reporting_issues.md'
- Extending eZ Platform:
- 'Extending eZ Platform': 'guide/extending_ez_platform.md'
- 'Extending modules': 'guide/extending_modules.md'
- 'Extending the Online Editor': 'guide/extending_online_editor.md'
- 'Extending Page': 'guide/extending_page.md'
- 'Extending Form Builder': 'guide/extending_form_builder.md'
- 'Service container': 'guide/service_container.md'
- 'Personalization': 'guide/personalization.md'
- Cookbook:
- 'Accept header-based REST API response': 'cookbook/creating_custom_rest_api_response.md'
- 'Adding Field Types': 'cookbook/adding_new_field_types.md'
- 'API search result pagination': 'cookbook/paginating_api_search_results.md'
- 'AWS S3 clustering': 'cookbook/setting_up_amazon_aws_s3_clustering.md'
- 'Binary attachments via REST API': 'cookbook/creating_content_with_binary_attachments_via_rest_api.md'
- 'Cross-origin HTTP requests': 'cookbook/making_cross_origin_http_requests.md'
- 'Displaying Content children': 'cookbook/displaying_children_of_a_content_item.md'
- 'Executing long commands': 'cookbook/executing_long_running_console_commands.md'
- 'Importing settings from a bundle': 'cookbook/importing_settings_from_a_bundle.md'
- 'Installing on Mac OS or Windows': 'cookbook/installing-on-mac-os-and-windows.md'
- 'Injecting parameters in content views': 'cookbook/injecting_parameters_in_content_views.md'
- 'Listening to core events': 'cookbook/listening_to_core_events.md'
- 'Multi-language SiteAccesses': 'cookbook/setting_up_multi_language_siteaccesses.md'
- 'Multiple user providers': 'cookbook/authenticating_a_user_with_multiple_user_providers.md'
- 'Notifications': 'cookbook/sending_notifications.md'
- 'Request parameters as API objects': 'cookbook/converting_request_parameters_into_api_objects.md'
- 'Retrieving root Location': 'cookbook/retrieving_root_location.md'
- 'RouteReference': 'cookbook/using_routereference.md'
- 'Siteaccess-aware bundle configuration': 'cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md'
- 'Using simple templates': 'cookbook/displaying_content_with_simple_templates.md'
- Resources and community:
- 'Resources': 'community_resources/resources.md'
- Contributing:
- 'How to contribute': 'community_resources/contributing.md'
- 'Report and follow issues': 'community_resources/report_follow_issues.md'
- 'Development guidelines': 'community_resources/development_guidelines.md'
- 'Contribute translations': 'community_resources/translations.md'
- 'Contribute documentation': 'community_resources/documentation.md'
- UI Guidelines:
- 'Introduction': 'guidelines/Introduction.md'
- Components:
- 'Buttons': 'guidelines/components/buttons.md'
- 'Tables': 'guidelines/components/tables.md'
- 'Tabs': 'guidelines/components/tabs.md'
- Resources:
- 'Typography': 'guidelines/resources/typography.md'
- 'Colors': 'guidelines/resources/colors.md'
- 'Icons': 'guidelines/resources/icons.md'
- Design Principles:
- 'Philosophy': 'guidelines/design_principles/Philosophy.md'
- 'Accessibility': 'guidelines/design_principles/Accessibility.md'
- Migrating to eZ Platform:
- 'Migrating from eZ Publish Platform': 'migrating/migrating_from_ez_publish_platform.md'
- 'Migrating from eZ Publish': 'migrating/migrating_from_ez_publish.md'
- 'Common issues': 'migrating/common_issues.md'
- Releases:
- 'Updating eZ Platform': 'releases/updating_ez_platform.md'
- 'eZ Platform v2.3': 'releases/ez_platform_v2.3.md'
- 'eZ Platform v2.2.0': 'releases/ez_platform_v2.2.0.md'
- 'eZ Platform v2.1.0': 'releases/ez_platform_v2.1.0.md'
- 'eZ Platform v2.0.0': 'releases/ez_platform_v2.0.0.md'
- 'eZ Platform v1.13.0 LTS': 'releases/ez_platform_v1.13.0_lts.md'
- 'eZ Platform v1.12.0': 'releases/ez_platform_v1.12.0.md'
- 'eZ Platform v1.11.0': 'releases/ez_platform_v1.11.0.md'
- 'eZ Platform v1.10.0': 'releases/ez_platform_v1.10.0.md'
- 'eZ Platform v1.9.0': 'releases/ez_platform_v1.9.0.md'
- 'eZ Platform v1.8.0': 'releases/ez_platform_v1.8.0.md'
- 'eZ Platform v1.7.0 LTS': 'releases/ez_platform_v1.7.0_lts.md'
- 'eZ Platform v1.6.0': 'releases/ez_platform_and_ez_enterprise_v1.6.0.md'
- eZ Enterprise release notes:
- 'eZ Enterprise v1.5.0': 'releases/ez_enterprise_v1.5.0_release_notes.md'
- 'eZ Enterprise v1.4.0': 'releases/ez_enterprise_v1.4_release_notes.md'
- 'eZ Studio 2016.04': 'releases/ez_studio_2016.04_release_notes.md'
- 'eZ Studio 16.02': 'releases/ez_studio_16.02_release_notes.md'
- 'eZ Studio 15.12.1': 'releases/ez_studio_15.12.1_release_notes.md'
- 'eZ Studio 15.12': 'releases/ez_studio_15.12_release_notes.md'
- eZ Platform release notes:
- 'eZ Platform v1.5.1': 'releases/ez_platform_1.5.1_release_notes.md'
- 'eZ Platform v1.5.0': 'releases/ez_platform_v1.5.0_release_notes.md'
- 'eZ Platform v1.4.2': 'releases/ez_platform_1.4.2_release_notes.md'
- 'eZ Platform v1.4.0': 'releases/ez_platform_v1.4.0_release_notes.md'
- 'eZ Platform 2016.04': 'releases/ez_platform_2016.04_release_notes.md'
- 'eZ Platform 16.02': 'releases/ez_platform_16.02_release_notes.md'
- 'eZ Platform 15.12.1': 'releases/ez_platform_15.12.1_release_notes.md'
- 'eZ Platform 15.12': 'releases/ez_platform_15.12_release_notes.md'
- 'Earlier releases': 'releases/earlier_releases.md'
- 'References': 'references.md'
theme:
name: null
custom_dir: 'material'
favicon: 'img/favicon.ico'
language: 'en'
palette:
primary: 'blue grey'
accent: 'deep orange'
font: false
logo: 'images/eZ-Brandmark.png'
feature:
tabs: false
search_index_only: false
theme_dir: material
extra:
version_warning:
latest: ['2.3']
previous_lts: ['1.7']
lts: ['1.13']
ft: ['2.2']
dev: ['master']
append_bootstrap:
- '/guidelines/'
extra_css:
- fonts/MavenPro.css
- css/custom.css
- '//cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css'
extra_javascript: [js/jquery.min.js, js/custom.js, '//cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js']
markdown_extensions:
- admonition
- codehilite:
guess_lang: false
linenums: true
- def_list
- footnotes
- meta
- toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- pymdownx.details
- ez_code_example