PDF Standards

Intro

All PDF reports generated by SGiv10 must follow this standard (see image bellow). Avoid the use of custom header files in favor of the standard header.

Header Standards

The header has the ability to have up to three lines. The first line identifies the content of the report and the second line identifies the object of the report (example above the title is "Audit Checklists" and the second line is the name of the audit.

When using the PdfExporter class, the new second and third line are filled in as follows:

$pdf
    ->setTitle(trans('report.title.audit-report'))
    ->setTitleLine2(trans('form.field.audit') . ' ' . $audit->code . ' - ' . $audit->name)
    ->setTitleLine3('stuff')

Body Standards

If the report is composed of various logical parts (for example, audit and checklists), you can preface each part with a title using the following code

<div class="wemake-section-title">{{ trans('form.field.audit') }}</div>

Tables meant for simple listing must have the classes table table-bordered table-framed while tables meant to display detailed information about a single object can only use the table class.

For more complex reports, you may create a bolder header for tables using the class table-title like so:

<table class="table">
    <thead>
        <tr>
            <th colspan="8" class="table-title">{{ trans('form.field.plan-information') }}</th>
        </tr>
    </thead>
    ...
</table>

This will create a blue header that separates the various sections of the same table like so:

Spaces between tables are handled with the classes wemake-<size>-space and wemake-<size>-margin-bottom-sequential where size can be small or medium.

The margin-bottom-sequential classes are used on looped items and add a bottom margin on all elements except the last (usefull in foreach loops).

If you want to indicate that some information is subordinate to information above (for example the tables for action executions are subordinate to the action table) then envelop the subordinate elements in a div with the class wemake-grouper-blue, to indent and add a blue line to the side of the subordinate elements, like so:

Helper Classes