|
|
|
# How to create a presentation in the community portal
|
|
|
|
|
|
|
|
### Add a Community presentation that already exists
|
|
|
|
|
|
|
|
The community portal hosts a number of [training resources in various formats](https://community.torproject.org/training/resources/). You can propose new resources, provided they abide by the rules mentioned on that page.
|
|
|
|
|
|
|
|
If you want to add a new training resource you can upload it to the repo on the folder [assets/static/files`](https://gitlab.torproject.org/tpo/web/community/-/tree/master/assets/static/files), and link to it in https://gitlab.torproject.org/tpo/web/community/-/blob/master/databags/training-resources.json.
|
|
|
|
|
|
|
|
You can also add to the list by sending an email to training at torproject.org with:
|
|
|
|
|
|
|
|
- Title and description
|
|
|
|
- Author and author contact information
|
|
|
|
- Link to download or access the resource
|
|
|
|
- Resource license (Creative Commons or similar license)
|
|
|
|
|
|
|
|
|
|
|
|
### Create a new presentation
|
|
|
|
|
|
|
|
The community portal also hosts a template to create presentations in html with [RevealJS](https://revealjs.com/).
|
|
|
|
See for example: https://community.torproject.org/training/resources/tor-relay-workshop/
|
|
|
|
|
|
|
|
To create a new presentation on our website, create a new folder under `content/training/resources` where your presentation is going to be hosted. Please create a folder with a slug of the title of the presentation, and use the same slug on the presentation file.
|
|
|
|
|
|
|
|
Inside your folder, add a `contents.lr` file. See for example: https://gitlab.torproject.org/tpo/web/community/-/blob/master/content/training/resources/tor-relay-workshop/contents.lr for the presentation already mentioned.
|
|
|
|
|
|
|
|
The `contents.lr` file should use the `slideshow` model and the `slideshow.html` template. It should also define a title for the presentation.
|
|
|
|
Here you have a template you can copy on your`contents.lr` file.:
|
|
|
|
|
|
|
|
```
|
|
|
|
_model: slideshow
|
|
|
|
---
|
|
|
|
title: The Tor Network
|
|
|
|
---
|
|
|
|
_template: slideshow.html
|
|
|
|
---
|
|
|
|
background: white
|
|
|
|
---
|
|
|
|
image: /static/images/onion.png
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
The image field is used as a small watermark on the bottom right side of the slides. You can upload images to the repository by adding them on a dedicated folder inside [/assets/static/images](https://gitlab.torproject.org/tpo/web/community/-/tree/master/assets/static/images).
|
|
|
|
|
|
|
|
In the same file you will need to define all the different slides under the `slides` field:
|
|
|
|
|
|
|
|
```
|
|
|
|
slides:
|
|
|
|
|
|
|
|
#### slide ####
|
|
|
|
title: Topics
|
|
|
|
----
|
|
|
|
description:
|
|
|
|
|
|
|
|
- What' s Tor?
|
|
|
|
```
|
|
|
|
|
|
|
|
Every slide should start with a `#### slide ####` line and can contain a title, a description and/or an image. Images and media can also be added in the description via markdown or via the local lektor edit interface via a button that can attach the image.
|
|
|
|
|
|
|
|
If you want to add a title slide you can do so with the following piece of code:
|
|
|
|
```
|
|
|
|
#### slide ####
|
|
|
|
title: Types of Relays
|
|
|
|
----
|
|
|
|
slide_layout: title-slide
|
|
|
|
----
|
|
|
|
background_image: /static/images/onion-white.png
|
|
|
|
----
|
|
|
|
description:
|
|
|
|
-
|
|
|
|
----
|
|
|
|
```
|
|
|
|
The `slide_layout` field is used to define the title-slide. With time we can add more slide layouts!
|
|
|
|
The `background_image` is used to add a small watermark on the bottom right side.
|
|
|
|
|
|
|
|
Unfortunately the current version of lektor on the build machines do need an empty `description` field like in the snippet provided above.
|
|
|
|
|
|
|
|
A title slide can also define an `author` field and a `subtitle`, ex:
|
|
|
|
```
|
|
|
|
#### slide ####
|
|
|
|
title: Thank you!
|
|
|
|
----
|
|
|
|
author:
|
|
|
|
name - email@example.com
|
|
|
|
----
|
|
|
|
subtitle:
|
|
|
|
PGP FINGERPRINT
|
|
|
|
----
|
|
|
|
slide_layout: title-slide
|
|
|
|
----
|
|
|
|
background_image: /static/images/onion-white.png
|
|
|
|
----
|
|
|
|
description:
|
|
|
|
-
|
|
|
|
```
|
|
|
|
|
|
|
|
The slideshow can scroll only from top to bottom. This way we are able to provide compatibility with both left-to-right and right-to-left languages.
|
|
|
|
|
|
|
|
If the slides are being localized, the order class is being applied based on the order defined in the `alternatives.ini` databag. |
|
|
|
\ No newline at end of file |