Writers guide

amv.tools is built with Grav. Grav is made with PHP, it runs on my server (an old PC), behind an nginx reverse proxy. In addition to all this, amv.tools uses goatcounter to track page views. See privacy for more detailed info.

How Grav works

Grav converts markdown files into HTML. Markdown is a simplified form of HTML, it allows you to write content with less "code-y" stuff in the midst of it. For example, in HTML a page heading might look like this <h1>Hello, World!</h1>. While in markdown it simply looks like this # Hello, World!. You might also be familiar with Discords (and others) text styling which also uses markdown. *italicized*, **bold**, ~~strikethrough~~ etc.

Here's a markdown guide https://www.markdownguide.org/basic-syntax/. You only really need to know what it looks like, the admin panel editor has buttons for common stuff like headings and links and images.

Site rules

  1. Do not edit other authors profile or blog pages.
  2. Images and videos should be compressed to a reasonable degree before uploading to the site.
  3. No fucking swearing or NSFW content on non-personal pages! This includes your author signature, it is displayed on all pages you author!
  4. I see everything you do on amv.tools.
    • Use a password that you do not use on other sites, I might be able to see that too (grav does encrypt it but it might be possible to find the key it uses for encrypting). I recommend you use a password manager to generate a truly random password for your account (good to do in any case).
    • All page edits trigger an automatic GitHub backup. You cannot fuck anything up.

Creating new pages

To create a page, go to "pages" in the admin panel and click "Add" in the top right.

After creating a page, the editor opens. Save the page once to create it on disk. Grav treats it as a draft before saving the first time.

All pages require a summary. A summary is defined with the summary delimiter ===. The page summary should ideally summarize the pages topic. It's also used for embedding the page on other platforms etc.

This pages summary for reference:

    amv.tools is built with [Grav](https://getgrav.org/). It's made with [PHP](https://www.php.net/) and it runs on my server, behind an [nginx](https://www.nginx.com/) reverse proxy.

    ===

The page editor has a media upload field under the main content. You can use it to upload and insert media to pages. You cannot upload media before saving the first time.

Writing guidelines

  • Vegas Pro has been owned by MAGIX since Vegas Pro 14. Do not call it "Sony Vegas".
  • Refrain from using meta text eg. "in this guide" or personal language eg. "now I will do x" in guides. If you see these on pages I've written, complain to me.
  • You don't have to worry too much about the language / style you use when making guides. I will go over and edit them whether you want to or not. Except blog posts, unless requested.

Writing tips

  • First level headings # are automatically centered by the site theme. So use second ## and third ### level headings in pages.
  • You can save the content without reloading the editor with ctrl + shift + S
  • The page editor includes the Options and Advanced tabs.
    • In Options you can edit the Published status of a page, making it inaccessible.
    • In Advanced you can edit the Visibility of a page, making it not show up in the menu (but still accessible by url if it's published).
    • You can also re-order pages in the Advanced tab.

Editing your author profile

The author profile card found at the bottom of pages you've marked yourself as an author in can be edited by changing the information on your personal page. Your personal page is located under Home (/) and is named as your user name. The author information card uses the name of the page to find it and displays the title as the name on the card.

author pages
author pages

The author profile card automatically uses the first image found in your author page. So if you want to change it, upload a new image and remove the old one.

To edit your author signature (the information card shown in the footer), edit the the [section="signature"] block. All content in it is automatically inserted in the information card.

To mark yourself as an author for a page, add your username in the "authors" taxonomy field (found in the Options tab in the non-expert editor).

You can also use the Expert mode editor to edit the frontmatter of the page directly. Here's an example:

taxonomy:
    authors:
        - reisir

Aligning content

To align content like images next to text (or multiple images side by side), use the row and divider shortcodes. A row can have any number of dividers. Rows can contain any elements.

Example:

First column

Second column

Third column

[row]
    First column
[divider]
    Second column
[divider]
    Third column
[/row]

Icons

There's also a custom shortcode for application icons. Usage: [i=untwirl] results in untwirl icon

A table of all icons is available at the bottom of this page.

Technicalities

  • Some pages have [assets] blocks. These contain page specific styles and / or scripts and you should ignore all of them.
  • If you see { .panel } when editing pages, it's a custom style to apply a blue, After Effects -style border to an image.
  • Some other { .classes } can also be found on pages but should mostly be ignored.
  • The Advanced tab of the page editor lets you change the template used for pages. Do not change it from Default. In the best case it will break the page until the Default template is reapplied and in the worst case you will have to shamefully DM me and tell me how you broke the rules and I'll have to manually rename the file on my server because it broke. So do not change the template.

Available [i]cons

Name Icon
3d 3d icon
alias alias icon
frame frame icon
index index icon
moblur moblur icon
shy shy icon
speaker speaker icon
stopwatch stopwatch icon
untwirl untwirl icon
adjustment adjustment icon
eye eye icon
fx fx icon
lock lock icon
name name icon
solo solo icon
star star icon
tag tag icon
text text icon
vtext (vertical text) vtext icon
pen pen icon
shape shape icon
vpgear (vegas pro gear) vpgear icon
vppen (vegas pro anchor creation tool) vppen icon
vpkeyframe vpkeyframe icon
syncCursor syncCursor icon
vpdelete vpdelete icon
vpedit vpedit icon