Add documentation for how to create template PDF files #547
Conversation
| used several times which will be list the used dependencies with PURL, file name, license and copyright notes. The | ||
| back.pdf file is the last page of the attribution document which is appended without any changes. | ||
|
|
||
| After the document is finished, each individual page is exported as the respective template PDF file. |
There was a problem hiding this comment.
I believe it's a bit confusing to speak about PDF files before this sentence. The workflow as I understand it is that first do the full design in Word, not knowing / caring that you would export to PDF later. You basically only care about the paper size and the number of pages at this point. And only at the very end I'd explain that you need to export the first page to a PDF file named cover.pdf, the second page to a PDF called copyright.pdf and so on.
There was a problem hiding this comment.
I rewrite the section before this sentence without mentioning PDF files.
| * back.pdf | ||
|
|
||
| The page size is A4 at 72 PPI with 595x842 pixels. The cover.pdf file will be the cover page of the attribution document | ||
| which will contain the project name and version starting at 80x547. The copyright.pdf file will be the second page of |
There was a problem hiding this comment.
Ah, so the contents of the cover page are filled in at a fixed pixel position? I always thought the pages would need to contain special makers, like $REPLACE_ME_WITH_THE_PROJECT_NAME_AND_VERSION, which get replaced with the contents...
There was a problem hiding this comment.
How do you control the font properties (type, size, style) of the text being inserted?
There was a problem hiding this comment.
Yes all content is fix at a pixel position not only the cover page.
The font type will be loaded from the pdf file, but the size and style are hardcoded.
There was a problem hiding this comment.
The font type will be loaded from the pdf file
Ok, so that hardens my assumption that the cause of the font issues we're seeing are caused by not all characters of the font being embedded into the PDF.
but the size and style are hardcoded.
Please add this bit to the docs then.
| The page size is A4 at 72 PPI with 595x842 pixels. The cover.pdf file will be the cover page of the attribution document | ||
| which will contain the project name and version starting at 80x547. The copyright.pdf file will be the second page of | ||
| the attribution document which will contain the project copyright notes starting at 70x659. The content.pdf file will be | ||
| used several times which will be list the used dependencies with PURL, file name, license and copyright notes. The |
There was a problem hiding this comment.
Is there also a pixel position for this file?
There was a problem hiding this comment.
Yes, it's written on the page at 40,80 until the page bottom margin is reached.
There was a problem hiding this comment.
Please add this bit to the docs then.
bs-ondem
force-pushed
the
bs-ondem/docs/attribution-document
branch
from
d30a408 to
cf7a5be
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
| ### Basic folder structure | ||
|
|
||
|
|
There was a problem hiding this comment.
Nit: Unrelated code change that should be undone.
Currently, there is only the documentation for the AttributionDocumentGenerator which describes how to create a template bundle JAR file. This adds a further documentation for how to create those template PDF files. Resolves eclipse-archived#546. Signed-off-by: Onur Demirci <[email protected]>
bs-ondem
force-pushed
the
bs-ondem/docs/attribution-document
branch
from
cf7a5be to
60eac12
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
|
Some remarks from my side. I think the description by @bs-ondem is a quite exact specification. However I think it is tricky for users to actually create a template based on this. This is the reason, the example bundle exists which also features a basic odt file which can be used. And if you want to polish the text a little more, I think it is worth to structure the text block into different things. Starting with a section on what is needed for the bundle (which pages .. what are they for) then a section how to create them (e.g. starting with the example and then a section on the exact specification. |
Currently, there is only the documentation for the
AttributionDocumentGenerator which describes how to create a template
bundle JAR file. This adds a further documentation for how to create
those template PDF files.
Resolves #546.
Request Reviewer
@sschuberth
Type of Change
documentation