Skip to content

Commit 679b6f2

Browse files
kraftbjkraftbj
committed
Docs: add additional fields
1 parent ef7ff39 commit 679b6f2

27 files changed

+667
-29
lines changed

‎docs/bin/manifest.json

+120
Original file line numberDiff line numberDiff line change
@@ -313,5 +313,125 @@
313313
"slug": "range-tutorial",
314314
"parent": "range",
315315
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/range/tutorial.md"
316+
},
317+
"features/fields/repeater": {
318+
"slug": "repeater",
319+
"parent": "fields",
320+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/repeater/index.md"
321+
},
322+
"features/fields/repeater/tutorial": {
323+
"slug": "repeater-tutorial",
324+
"parent": "repeater",
325+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/repeater/tutorial.md"
326+
},
327+
"features/fields/select": {
328+
"slug": "select",
329+
"parent": "fields",
330+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/select/index.md"
331+
},
332+
"features/fields/select/tutorial": {
333+
"slug": "select-tutorial",
334+
"parent": "select",
335+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/select/tutorial.md"
336+
},
337+
"features/fields/separator": {
338+
"slug": "separator",
339+
"parent": "fields",
340+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/separator/index.md"
341+
},
342+
"features/fields/separator/tutorial": {
343+
"slug": "separator-tutorial",
344+
"parent": "separator",
345+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/separator/tutorial.md"
346+
},
347+
"features/fields/tab": {
348+
"slug": "tab",
349+
"parent": "fields",
350+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/tab/index.md"
351+
},
352+
"features/fields/tab/tutorial": {
353+
"slug": "tab-tutorial",
354+
"parent": "tab",
355+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/tab/tutorial.md"
356+
},
357+
"features/fields/taxonomy": {
358+
"slug": "taxonomy",
359+
"parent": "fields",
360+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/taxonomy/index.md"
361+
},
362+
"features/fields/taxonomy/tutorial": {
363+
"slug": "taxonomy-tutorial",
364+
"parent": "taxonomy",
365+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/taxonomy/tutorial.md"
366+
},
367+
"features/fields/text": {
368+
"slug": "text",
369+
"parent": "fields",
370+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/text/index.md"
371+
},
372+
"features/fields/text/tutorial": {
373+
"slug": "text-tutorial",
374+
"parent": "text",
375+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/text/tutorial.md"
376+
},
377+
"features/fields/textarea": {
378+
"slug": "textarea",
379+
"parent": "fields",
380+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/textarea/index.md"
381+
},
382+
"features/fields/textarea/tutorial": {
383+
"slug": "textarea-tutorial",
384+
"parent": "textarea",
385+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/textarea/tutorial.md"
386+
},
387+
"features/fields/time-picker": {
388+
"slug": "time-picker",
389+
"parent": "fields",
390+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/time-picker/index.md"
391+
},
392+
"features/fields/time-picker/tutorial": {
393+
"slug": "time-picker-tutorial",
394+
"parent": "time-picker",
395+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/time-picker/tutorial.md"
396+
},
397+
"features/fields/true-false": {
398+
"slug": "true-false",
399+
"parent": "fields",
400+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/true-false/index.md"
401+
},
402+
"features/fields/true-false/tutorial": {
403+
"slug": "true-false-tutorial",
404+
"parent": "true-false",
405+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/true-false/tutorial.md"
406+
},
407+
"features/fields/url": {
408+
"slug": "url",
409+
"parent": "fields",
410+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/url/index.md"
411+
},
412+
"features/fields/url/tutorial": {
413+
"slug": "url-tutorial",
414+
"parent": "url",
415+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/url/tutorial.md"
416+
},
417+
"features/fields/user": {
418+
"slug": "user",
419+
"parent": "fields",
420+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/user/index.md"
421+
},
422+
"features/fields/user/tutorial": {
423+
"slug": "user-tutorial",
424+
"parent": "user",
425+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/user/tutorial.md"
426+
},
427+
"features/fields/wysiwyg": {
428+
"slug": "wysiwyg",
429+
"parent": "fields",
430+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/wysiwyg/index.md"
431+
},
432+
"features/fields/wysiwyg/tutorial": {
433+
"slug": "wysiwyg-tutorial",
434+
"parent": "wysiwyg",
435+
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/wysiwyg/tutorial.md"
316436
}
317437
}

‎docs/features/fields/META.md

+5-27
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,19 @@
33
This directory contains documentation for all field types in Secure Custom Fields.
44

55
## Structure
6+
67
Each field type has its own directory containing:
8+
79
- `index.md` - Main documentation for the field
810
- `tutorial.md` - Step-by-step tutorial for implementing the field
911

1012
## Adding New Field Documentation
13+
1114
1. Create a new directory for the field type
1215
2. Create both required files
1316
3. Follow the standard format for each file type
1417
4. Include code examples and use cases
1518

1619
## Documentation Standards
17-
(To be added)
18-
19-
## Available Fields
20-
21-
- [Accordion](accordion/README.md) - Group fields into collapsible sections
22-
- [Button Group](button-group/README.md) - Select one option from a group of buttons
23-
- [Checkbox](checkbox/README.md) - Select one or more choices
24-
- [Color Picker](color-picker/README.md) - Choose colors with a visual picker
25-
- [Date Picker](date-picker/README.md) - Select dates from a calendar
26-
- [Date/Time Picker](date-time-picker/README.md) - Select dates and times
27-
- [Email](email/README.md) - Input and validate email addresses
28-
- [File](file/README.md) - Upload and manage files
29-
- [Flexible Content](flexible-content/README.md) - Create flexible content layouts
30-
- [Gallery](gallery/README.md) - Manage collections of images
31-
- [Google Map](google-map/README.md) - Add location data with Google Maps
32-
- [Group](group/README.md) - Group fields together
33-
- [Icon Picker](icon-picker/README.md) - Select from available icons
34-
- [Image](image/README.md) - Upload and manage images
35-
- [Link](link/README.md) - Create links with titles and targets
36-
- [Message](message/README.md) - Display instructional text
37-
- [Number](number/README.md) - Input numeric values
38-
- [oEmbed](oembed/README.md) - Embed external content
39-
- [Page Link](page-link/README.md) - Link to internal content
40-
- [Password](password/README.md) - Securely input passwords
41-
- [Post Object](post-object/README.md) - Relate to other posts
42-
- [Radio](radio/README.md) - Select one choice from options
43-
- [Range](range/README.md) - Select a numeric value with a slider
20+
21+
(To be added).

‎docs/features/fields/index.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Each field type has its own documentation and tutorial showing how to implement
77
## Available Fields
88

99
- [Accordion](accordion) - Group fields into collapsible sections
10-
- [Clone](clone) - Duplicate and reuse existing field configurations
1110
- [Button Group](button-group) - Select one option from a group of buttons
1211
- [Checkbox](checkbox) - Select one or more choices
12+
- [Clone](clone) - Duplicate and reuse existing field configurations
1313
- [Color Picker](color-picker) - Choose colors with a visual picker
1414
- [Date Picker](date-picker) - Select dates from a calendar
1515
- [Date/Time Picker](date-time-picker) - Select dates and times
@@ -29,4 +29,16 @@ Each field type has its own documentation and tutorial showing how to implement
2929
- [Password](password) - Securely input passwords
3030
- [Post Object](post-object) - Relate to other posts
3131
- [Radio](radio) - Select one choice from options
32-
- [Range](range) - Select a numeric value with a slider
32+
- [Range](range) - Select a numeric value with a slider
33+
- [Repeater](repeater) - Create repeatable groups of fields
34+
- [Select](select) - Choose from dropdown options
35+
- [Separator](separator) - Add visual breaks between fields
36+
- [Tab](tab) - Organize fields into tabbed sections
37+
- [Taxonomy](taxonomy) - Select taxonomy terms
38+
- [Text](text) - Single line text input
39+
- [Textarea](textarea) - Multi-line text input
40+
- [Time Picker](time-picker) - Select time values
41+
- [True/False](true-false) - Toggle switch for yes/no choices
42+
- [URL](url) - Input and validate web addresses
43+
- [User](user) - Select WordPress users
44+
- [WYSIWYG](wysiwyg) - Rich text editor

‎docs/features/fields/repeater/index.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Repeater Field
2+
3+
The Repeater field allows you to create a set of sub fields which can be repeated again and again.
4+
5+
## Key Features
6+
- Flexible row management
7+
- Multiple field types support
8+
- Nested repeater capability
9+
- Row reordering
10+
- Min/max rows control
11+
12+
## Settings
13+
- Sub Fields - Add fields to repeat
14+
- Minimum Rows - Set required rows
15+
- Maximum Rows - Limit total rows
16+
- Layout - Table or block display
17+
- Button Label - Customize add row text

‎docs/features/fields/repeater/tutorial.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Using the Repeater Field
2+
3+
## Basic Setup
4+
1. Create a new Field Group
5+
2. Add a Repeater field
6+
3. Configure options:
7+
- Add sub fields
8+
- Set min/max rows
9+
- Choose layout style
10+
- Configure labels
11+
12+
## Common Use Cases
13+
1. Dynamic Content
14+
- Social media links
15+
- Team members
16+
- Feature lists
17+
18+
2. Content Management
19+
- Gallery items
20+
- Related links
21+
- Service offerings
22+
23+
## Tips
24+
- Plan field structure carefully
25+
- Consider nesting depth
26+
- Use clear labels
27+
- Set appropriate limits

‎docs/features/fields/select/index.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Select Field
2+
3+
The Select field provides a dropdown interface for selecting single or multiple options from a predefined list.
4+
5+
## Key Features
6+
- Single/multiple selection
7+
- Custom choices
8+
- Ajax loading support
9+
- Placeholder text
10+
- Conditional logic
11+
12+
## Settings
13+
- Choices - Define available options
14+
- Default Value - Set initial selection
15+
- Allow Null - Make selection optional
16+
- Multiple - Enable multiple selections
17+
- UI - Enhanced select interface

‎docs/features/fields/select/tutorial.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Using the Select Field
2+
3+
## Basic Setup
4+
1. Create a new Field Group
5+
2. Add a Select field
6+
3. Configure options:
7+
- Add choice options
8+
- Set default value
9+
- Configure UI settings
10+
- Enable/disable features
11+
12+
## Common Use Cases
13+
1. Option Selection
14+
- Status choices
15+
- Category selection
16+
- Preference settings
17+
18+
2. Data Filtering
19+
- View options
20+
- Content filtering
21+
- Display settings
22+
23+
## Tips
24+
- Use clear option labels
25+
- Consider grouping options
26+
- Enable search for long lists
27+
- Set meaningful defaults

‎docs/features/fields/separator/index.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Separator Field
2+
3+
The Separator field provides visual separation between fields in the editing interface. It helps organize and structure field layouts.
4+
5+
## Key Features
6+
- Visual organization
7+
- Custom styling
8+
- Layout control
9+
- Group separation
10+
- Visual hierarchy
11+
12+
## Settings
13+
- Label - Optional separator text
14+
- Instructions - Field description
15+
- Wrapper - CSS class options

‎docs/features/fields/separator/tutorial.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Using the Separator Field
2+
3+
## Basic Setup
4+
1. Create a new Field Group
5+
2. Add a Separator field
6+
3. Configure options:
7+
- Set label text
8+
- Add instructions
9+
- Style wrapper
10+
- Position field
11+
12+
## Common Use Cases
13+
1. Content Organization
14+
- Section breaks
15+
- Field grouping
16+
- Visual hierarchy
17+
18+
2. Form Structure
19+
- Content sections
20+
- Logical breaks
21+
- Visual spacing
22+
23+
## Tips
24+
- Use clear labels
25+
- Keep consistent styling
26+
- Consider spacing
27+
- Group related fields

‎docs/features/fields/tab/index.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Tab Field
2+
3+
The Tab field creates navigation tabs to organize fields into sections. It improves the editing interface by grouping related fields together.
4+
5+
## Key Features
6+
- Field organization
7+
- Visual navigation
8+
- Grouped content
9+
- Layout control
10+
- Conditional display
11+
12+
## Settings
13+
- Placement - Top/Left alignment
14+
- Endpoint - Tab section end
15+
- Label - Tab name
16+
- Instructions - Optional help text

‎docs/features/fields/tab/tutorial.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Using the Tab Field
2+
3+
## Basic Setup
4+
1. Create a new Field Group
5+
2. Add a Tab field
6+
3. Configure options:
7+
- Set tab label
8+
- Choose placement
9+
- Set endpoint
10+
- Add instructions
11+
12+
## Common Use Cases
13+
1. Content Organization
14+
- Content sections
15+
- Settings groups
16+
- Form organization
17+
18+
2. Interface Design
19+
- Complex forms
20+
- Settings panels
21+
- Data grouping
22+
23+
## Tips
24+
- Use clear tab labels
25+
- Group related fields
26+
- Consider tab order
27+
- Plan section breaks

0 commit comments

Comments
 (0)