content of the document samples

[aoloe]

The directory

Each document sample is a directory that must contain:

• A manifest.yml file with:
  • a short description of the document,
  • the author's name
  • the license name
  • a list of tags
  • the (minimal) Scribus version
  • a flag if the sample contains assets that are less free than the document.
  • a flag if the sample contains assets that are not free.
• A LICENCE.md file.
• A README.md file
  • Describing the characteristics of the document.
  • Describing how to use the document and how to adapt to the specific needs of the user.

Each document sample directory should provide

• Screenshots (named preview.png, preview-01.png, ...)
• Non free assets should we watermarked (if possible).

Each document sample directory can provide

• Font files in the fonts/ directory.
• Images in the images/ directory containing:
  • the images used in the .sla files,
  • the images used in the readme file.
• One or more .sla filles collected for output

It's not clear yet if a directory must / should / could:

• Provide a PDF version of the document.

  The .sla file

The .sla file must:

• Avoid spaces and special characters in the file name.

The .sla file should:

• Only contain images that do not exceed the 150 dpi at their size in the document. (You can provide sources to original images in the README file.)
• Have a watermark on the images that have a resolution below 100 dpi ("Sample"; we want to avoid that the users send to the printer files that have low resolution).

The .sla file can:

• Have an "Instruction layer" with "on screen" instructions that are for using the document (for more complex documents, one could add "numbers" that are referenced in the README)