Guideline for PDF-Printing Page Editor Content

1 Guideline

This guideline page includes all the descriptions that have already been scheduled for ILIAS 5.3.
Due to the formal error that the guideline was created in the wrong format, it was not valid despite positive opinion of JourFixe.
» See PDF-Printing Page Editor Content

Changes was made ...

• ... on certificates. There are already other developments for 5.4, which are pointed out.
• ... on cover page. The requirements of JourFixe are incorporated.

This article set outs definitions of how elements that can be added to a page using the page editor should be renered by Phantom JS. 

These definitions apply to the PDF-ing of that content, we reasonably hope this heals many of the issues with printing vis the Browser as well. But speciffically add the vaeat, that this article concerns itself with PDF-ing. 

Cover page

All PDFs created by clicking the [PDF]-Button get a cover page. 

Note: Copyright-Line is only shown, if there is an information. 

Handling of Style in Prints

All PDFs created by clicking the [PDF]-Button will strip most of the style of the page elements in the PDF: 

• all content of a tab / page is encapsuled with a grey line. 
• Items (i.e. file box, Personal Profile or accordions)  and paragraph styles loose their filling but not the color outline. 

Handling of different elements of Page-Content

All PDFs created by clicking the [PDF]-Button get the following output for the following eelements: 

Headline & Content Affiliation

• Headlines and page editor content affiliated with the headline are supposed to stay together. 

Text

• Text is printed as it is. Font size should not vary between different tabs unless caused by different styles. 
• All Links are provided as clickable Links in the PDF. 

• Images that were created with relative width (100% or 50%) are handed to the PDF renderer with this information. 
• Captions are printed immediately underneath picture. 
• Videos are represented in by a placeholder:
  • Placeholder in size of the player with Play-Symbol in the middle
  • Title of Video (if applicable)
  • Vorschaubild  (if possible / applicable)
  • Caption (if applicable)
  • If there is a link to the video the placeholder should be a link area pointing to that site
• Audio is represented by a placeholder: as for videos
• Full Screen versions of images are NOT attached but merely indicated to be available  by the looking glas. 

File List

• Files are represented by a placeholder mimicking more or less the File List Container. They are NOT magically  appended to the print. 
  • Filelist Title (if applicable)
  • Title of File (if applicable) 
  • Ending of File
  • Size of File
• File Links remain clickable in the PDF. This may require Permanent Links for Files to be used here. 

• Are "organised" text and printed as it is.
• Borders and stuff are printed as indicated. 

• Pictures and all other page content elements are subjected to normal HTML-/ CSS-Rules.
• Advanced tables are supposed to "fight back" against page breaks if they fit on one page. 

• Pictures and all other page content elements are subjected to normal HTML-/ CSS-Rules.
• Advanced Lists are supposed to "fight back" against page breaks if they fit on one page. 

• Are printed according to the style

• There should be a visual clue that the Accordion is a something to be opened: the arrow should be printed. 
• Accordions are all opened and all of the content they comprise should be printed.
• Horizontal Accordions no longer stacked from left to right but are pinted underneath each other
• Items of Carousells are are pinted underneath each other, they should take on the normal Accoridion look. 

Interactive Image

• Interactive Image are high-media elements and will be represented by the basic interactive imange with out any Trigger Areas, Overlays Images or PopUps. 
• Caption is printed immediately underneath. 
• A Permanent Link to the page on which the Interactive Image resides is provided.  

• Code is printed as displayed. 

• Content Snippets are printed as displayed.

• Personal Data is printed as displayed. 

• Most unfortunately the Certificate is displayed and thus should be printed just as a link. This robs the reader of all relevant information about the value and origin of the certificate.  
• The certificate rendering should no longer been done with the FO-engine but be switched to PhantomJS via the HTML. An inline presentation of the certificate PDF would be lovely. 
  • Scheduled for ILIAS 5.4 : Persisting Certificates

• Competences are printed as displayed. 

• Consultation Hours should not printed as displayed. It is problematic which month should be printed. 
• Consultation Hours should printed as a Upcoming events accoring to the individual settings. 

• My Courses is printed as displayed if the are normal courses. 
• If the courses are learning objective driven courses the respective course should be opened so the learning objectives are printed along with all Rsuluts displayed. In particular the button Results should be printed. 
• The links to the course should work. 

• The questions and answer options are to be printed without given answers, feedback or hints.
• Questions are not supposed to suffer from page breaks. 

• The question Overview should be printedas they are at the moment of print. 

Comments

Obviously Comments should be printed only if there are any. "Add Comment"-dialogue is never printed. 
If the Print dialogue is amended accordingly to include comments, then comments should be printed as an appendix to the overall print of the page editor content is completed.  

2 Status

• Effective from release: Release 5.4
  
• Approved by Jour Fixe at: JourFixe-2018-06-04
• Implementation status: partly implemented
• Funding for streamlining existing features: Technische Hochschule OWL (interest in funding)
  
• Implementation of guideline: Killing, Alexander [alex]

3 Components that are not compliant with the Guideline

• …

4 Discussion

Killing, Alexander [alex], 2 May 2018: I support this request.

JourFixe, ILIAS [jourfixe], 04 JUN 2018 : Guideline is highly appreciated and effective from ILIAS 5.4.