Skip to content

Commit 6487a9d

Browse files
authored
Merge pull request #60 from php-etl/feature/add-content-to-custom-plugin-page
Feature/add content to custom plugin page
2 parents 3088582 + e228262 commit 6487a9d

File tree

2 files changed

+38
-15
lines changed

2 files changed

+38
-15
lines changed

content/connectivity/custom/_index.en.md

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@ description: "Read transform and write files in any format"
88
weight: 3
99
---
1010

11-
- [What is it ?](#what-is-it-)
11+
- [What is it ?](#definition)
1212
- [Installation](#installation)
1313
- [Usage](#usage)
1414
- [Building an extractor](#building-an-extractor)
1515
- [Building a transformer](#building-a-transformer)
1616
- [Building a loader](#building-a-loader)
17+
- [Usage examples](#usage-examples)
18+
- [Example of an extractor](#example-of-an-extractor)
19+
- [Example of a transformer](#example-of-a-transformer)
20+
- [Example of a loader](#example-of-a-loader)
1721
---
1822

1923
## Definition
@@ -29,42 +33,58 @@ This plugin is already integrated into the Satellite package, so you can’t req
2933

3034
Unlike other plugins, the configuration is the same whether it is an extractor, a transformer or a loader.
3135

32-
First you need to [determine your services](../../feature/services) in your pipeline or workflow and then use the `use`
33-
option which allows you to define which service to use.
34-
3536
### Building an extractor
3637

38+
In the example given, we explain how to configure a custom extractor with the `Bar` class located in the `App\Class` namespace.
39+
40+
Here's a more detailed explanation:
41+
3742
```yaml
3843
custom:
3944
extractor:
40-
use: 'App\Class\Bar'
45+
use: 'App\Class\Bar' # This line specifies the extractor class you want to use.
4146
services:
42-
App\Class\Bar: ~
47+
App\Class\Bar: ~ # Here, we declare the service associated with the Bar class with the syntax App\Class\Bar: ~. This simply indicates that we want to use the default parameters for this service.
4348
```
4449
50+
For more details about service configurations, please visit the [declaring-services](../../feature/services) documentation.
51+
4552
### Building a transformer
4653
54+
In the example given, we explain how to configure a custom extractor with the `Bar` class located in the `App\Class` namespace.
55+
56+
Here's a more detailed explanation:
57+
4758
```yaml
4859
custom:
4960
transformer:
50-
use: 'App\Class\Bar'
61+
use: 'App\Class\Bar' # This line specifies the extractor class you want to use.
5162
services:
52-
App\Class\Bar:
53-
factory:
63+
App\Class\Bar: # Here, we declare the service associated with the Bar class.
64+
factory: # This section indicates that the service must be created by calling the extract method of the App\Class\Bar class.
5465
class: App\Class\Bar
5566
method: extract
56-
arguments:
67+
arguments: # The arguments to be passed to the extract method. In this example, the @foo symbol indicates that the foo service should be injected as an argument. Make sure that the foo service is configured correctly elsewhere in your pipeline.
5768
- '@foo'
69+
foo: ~
5870
```
5971

72+
For more details about service configurations, please visit the [declaring-services](../../feature/services) documentation.
73+
6074
### Building a loader
6175

76+
In the example given, we explain how to configure a custom extractor with the `Bar` class located in the `App\Class` namespace.
77+
78+
Here's a more detailed explanation:
79+
6280
```yaml
6381
custom:
6482
loader:
65-
use: 'App\Class\Bar'
83+
use: 'App\Class\Bar' # This line specifies the extractor class you want to use.
6684
services:
67-
App\Class\Bar:
68-
calls:
69-
- withUsername: [ 'admin' ]
85+
App\Class\Bar: # Here, we declare the service associated with the Bar class.
86+
calls: # This section indicates that specific method calls must be made to the service instance.
87+
- withUsername: [ 'admin' ] # This means that a method call named withUsername must be made to the instance of the Bar class, with the username "admin" passed as an argument.
7088
```
89+
90+
For more details about service configurations, please visit the [declaring-services](../../feature/services) documentation.

themes/middleware/assets/css/style.css

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,10 @@ h1.single-title {
641641

642642
.content h1,
643643
.content h2,
644-
.content h3 {
644+
.content h3,
645+
.content h4,
646+
.content h5,
647+
.content h6 {
645648
padding: 10px 0;
646649
position: sticky;
647650
top: 95px;

0 commit comments

Comments
 (0)