Skip to content

Commit 3335d74

Browse files
committed
update readme again
1 parent edac19e commit 3335d74

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ CDS plugin for SAP Print service (package `@cap-js/print`) is a CDS plugin that
1111

1212
## Requirements and Setup
1313

14-
15-
Usage of this plugin requires a valid subscription of the [SAP Print Service](https://help.sap.com/docs/SCP_PRINT_SERVICE).
14+
Using this plugin requires a valid subscription of the [SAP Print Service](https://help.sap.com/docs/SCP_PRINT_SERVICE).
1615

1716
## Usage
1817

@@ -21,14 +20,14 @@ To use this plugin to print documents, there are two main steps:
2120
1. Ensure your model meets the requirements
2221
2. Annotate your CDS model with `@PDF.Printable`
2322

24-
### Model requirements
23+
### Model Requirements
2524

2625
- The attribute(s) you want to print are of type `LargeBinary`
2726
- Those attributes have the annotation `@Core.ContentDisposition: fileName`, where `fileName` is the attribute that specifies the file name or a hardcoded string with the file name
2827

2928
### Annotations in CDS model
3029

31-
To use the print plugin, simply annotate your entity with `@PDF.Printable`:
30+
To use the print plugin, annotate your entity with `@PDF.Printable`:
3231

3332
```cds
3433
@PDF.Printable
@@ -38,8 +37,8 @@ entity Books as projection on my.Books;
3837
This annotation does the following things in the background:
3938

4039
- Adds an action `print` to the annotated entity with the following parameters:
41-
- `Queue`: Name of the print queue to use
42-
- `Copies`: Number of copies to print
40+
- `Queue`: Name of the print queue to use.
41+
- `Copies`: Number of copies to print.
4342
- `File`: Only added if the entity has multiple `LargeBinary` attributes. Allows selecting which file should be printed. Ensure that the `LargeBinary` properties are annotated with `@Common.Label`.
4443
- This action is added to the UI and a handler is generated to process the print request.
4544
- An entity `PrintServiceQueues` is added to the service to provide available print queues in a value help.
@@ -52,7 +51,7 @@ You can also use the print service to print documents manually, i.e., without th
5251
Use cases for a manual approach could be:
5352
- You want to print documents that are not part of your CDS model, i.e., files generated at runtime
5453
- Your model does not meet the requirements for the automatic approach
55-
- You want to print another file type than PDF
54+
- You want to print a file type other than PDF
5655

5756
For this, you can use the `cds.connect.to` API of CAP to connect to the print service and invoke the `print` action manually.
5857

@@ -74,11 +73,11 @@ await printService.send("print", {
7473
const queues = await printService.get("/Queues");
7574
```
7675

77-
It is possible that for LargeBinaries retrieved from the database, the content is provided as a stream. In this case, the stream needs to be converted to base64 before passing it to the print service. For example, have a look at the sample application in `test/bookshop/`
76+
It is possible that for LargeBinaries retrieved from the database, the content is provided as a stream. In this case, the stream needs to be converted to base64 before passing it to the print service. For example, see the sample application in `test/bookshop/`
7877

7978
## Local Development
8079

81-
When running the application locally, i.e., `cds watch`, the print service is mocked. This mock implementation prints the print job details to the console instead of sending them to the actual print service. It also provides a number of sample print queues for selection.
80+
When running the application locally, the print service is mocked. This mock implementation prints the print job details to the console instead of sending them to the actual print service. It also provides a number of sample print queues for selection.
8281

8382
## Hybrid Testing
8483

@@ -103,11 +102,11 @@ For CI, the hybrid integration tests are automatically run against a SAP Print S
103102

104103
## Support, Feedback, Contributing
105104

106-
This project is open to feature requests/suggestions, bug reports, etc. via [GitHub issues](https://github.com/cap-js/print/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
105+
This project is open to feature requests/suggestions, bug reports, etc. via [GitHub issues](https://github.com/cap-js/print/issues). Contributions and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
107106

108107
## Security / Disclosure
109108

110-
If you find any bug that may be a security problem, please follow the instructions [in our security policy](https://github.com/cap-js/print/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
109+
If you find a bug that may be a security problem, please follow the instructions [in our security policy](https://github.com/cap-js/print/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
111110

112111
## Code of Conduct
113112

0 commit comments

Comments
 (0)