Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

README: drobne nieścisłości względem kodu i porządki językowe

Open
  • Is something wrong?
#294 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
php
Domain
documentation

Research direction

Start with the cited README.md sections and compare them with the referenced traits, models, classes, and console command; the issue names the relevant locations. Review the beforeRender example and verify its behavior across document types, then check each documentation claim against the cited code. The thread leaves open whether afterRender listeners should compose changes; clarify that decision before considering the documentation complete.

Written by the indexing model from the issue text.

Description

code-review documentation good first issue low-priority

Problem

Nieścisłości względem kodu:

  1. Zlokalizowane widoki (pdf.de.invoice) działają tylko przy włączonej fladze renatio_dynamicpdf_template i jawnym locale: (traits/TranslatesContent.php:25). README (Features, README.md:21-22) przedstawia je jako alternatywę dla tłumaczeń multisite.
  2. Notka „If the PDF template does not exist in the system, this code will attempt to find a PDF view with the same code” (README.md:196-197) dotyczy tylko kodów zarejestrowanych (traits/FollowsView.php:31-33). Istniejący, ale niezarejestrowany widok daje ModelNotFoundException.
  3. title i name są opisane jako „required” (README.md:140, 183), a od #256 brak daje kod jako nazwę (models/Template.php:141, models/Layout.php:193).
  4. Domyślna orientation to default_paper_orientation z konfiguracji dompdf, a nie „portrait” (README.md:187, classes/PDFWrapper.php:166).
  5. allowRemoteApplicationAssets() jest opisane jako „Limit remote resources…” (README.md:383), a w rzeczywistości włącza zasoby zdalne dla hostów aplikacji (classes/RemoteAssetPolicy.php:21).
  6. Przykład beforeRender (README.md:276-279) wywołuje $data['order']->isDraft(). Listener działa dla każdego dokumentu, więc każdy inny render kończy się Undefined array key "order" (sonda Pest).
  7. afterRender: każdy listener dostaje oryginalny HTML i wygrywa ostatni zwrócony string (classes/TemplateRenderer.php:61-65). Dwa listenery, np. znak wodny i stopka, się nie składają. Do decyzji: opisać to w README albo przekazywać HTML kolejno przez listenery.
  8. „Basic Twig tags and expressions are supported in PDF views” (README.md:112, 175) jest nieaktualne. Widoki renderuje pełny Twig CMS z filtrami pluginów.

Porządki językowe i struktura:

  • Brak krótkiego Quick start: pierwszy kod generujący PDF jest w ok. 618. linii.
  • Brak linku do UPGRADE.md.
  • „back-end” (6×: README.md:65, 69, 193, 201, 290, 292) obok „backend”.
  • Brytyjska pisownia przy amerykańskiej w reszcie: „customised” w UPGRADE.md:79, „Synchronise” w opisie komendy (console/Sync.php:12).
  • Zdania do poprawienia:
    • README.md:64 „PDF can be created” → „PDFs can be created”;
    • :145 comma splice „These behave just like CMS layouts, they contain…”;
    • :403 „through Facade class” → „through the facade class”;
    • :614-616 „shows invoice”, „shows usage of” → „shows an invoice”, „shows the use of”;
    • :635 „In HTML template” → „In the HTML template”.

Dowód

Odczyt wskazanych linii README i kodu. Punkty 1, 2 i 6 potwierdzone sondą Pest lub w tinker.

Skutek

Programista trafia na zachowanie inne niż opisane. Przykład beforeRender wprost psuje pozostałe dokumenty.

Proponowane rozwiązanie

Poprawić punkty 1–8 i listę językową. W punkcie 7 rozstrzygnąć, czy afterRender ma składać zmiany listenerów.

Kryteria akceptacji

  • Punkty 1–8 zgodne z kodem (albo kod zmieniony w punkcie 7).
  • Przykład beforeRender nie psuje innych dokumentów.
  • Jednolita pisownia „backend” i amerykańska ortografia.

Powiązane issues

#199/#249, #223, #119/#144, #134/#158, #181, #256.

Dominant language
PHP
Stars
30
Forks
22
Avg merge
3h 48m
Merged PRs (30d)
102

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mplodowski/dynamicpdf-plugin

All issues in mplodowski/dynamicpdf-plugin

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.