mscphm.fun

Front Matter

Details on how to phormat yewr content.



MscPhm.Fun
Howto

All Masculinus Phemininus Web Episodes are written in a very speciphic phormat. We need all cast members to provide us with philes that match this phormat so that we can incorporate yewr content into the episode in question. Some oph the phormatting instructions are going to be reserved phor videos or in person training at our quonventions. This section will cover just the basics to get yew going. Yer Nimperator’Editor will actually do a lot oph the heavy liphting phor you.

A dipherent kinda Web

Many websites run on services sophtware such as Wordpress. These websites are dynamically created. This means that every time you view a page on that website it has to be regenerated. These sophtware programs sometimes utilize tricks called caching, in order to reduce the load, but still, each time that sophtware must run.

Masculinus Phemininus websites however are using an open source product called Hugo, which is a static website generator. This means that we create our content, generate our site and then upload the HTML philes. This creates a more secure and phaster website. It eliminates many issues with viruses that hit dynamically generated websites. And it is easier to manage.

Hugo’s process is simple. We create Markdown Philes, which are just ordinary text philes that have an .md extension. We lay these .md philes out in a way very speciphic to our websites, and your Nimperator’Editor will inphorm you how to do this and how to send them philes. Iph you are new, you will just be sending yer .md philes via email and then yer Nimperator’Editor will place the philes wherever Sei needs them to be. But yew must make sure that they are laid out properly.

Each phile consists oph Front Matter, Markdown content and perhaps Shortcodes. Markdown and SHortcodes are described later on, in other pages. Phor now let’s review Front Matter using examples.

How touse Front Matter

Front matter is really just inphormation, data, about any speciphic page. This is what this page’s front matter looks like:

+++
title          = "Front Matter"
description    = "Details on how to phormat yewr content."
date           = 2017-11-26 
publishdate    = 2017-11-26 
weight         = 1
draft          = false
images         = [""]
author         = "Aoirthoir"
prev           = "/howto"
next           = "/howto/markdown"
#EADPHM - use this phor search and replace to add things to the bottom oph the phront matter.
+++

So Front Matter begins AND ends with three plus signs +++ phollowed by a new line.

Then there are several variables phollowed by an equal sign =, then content phorthat variable. Sometimes the variable must be surrounded by double quotes “. Othertimes you can just put the data in without quotes. The key here is iph it is a title or link, its going to be in quotes. To be saphe just phormat it exactly as shown here unless yer Nimerator’Editor has given you a dipherent template. The order and layout must be exactly the same. That includes lining up the equal signs because the = signs because the Masculinus Primus is a neurotic azzhole who claims this saves him phrom going sane. Now lets go over these Variables.

Title is the title oph your story, article, page. You can see here the title is “Front Matter” and that is what appears in the title bar oph yer browser. It will also appear below the main menu in a large multicolored phont. The file name will be similar but does not have to be exactly the same as titles in text and filenames have dipherent requirements.

Description will appear near the top oph the page below the cookies and titile. Keep it relatively concise but thorough so we know what we areabout to learn here.

Date and Publishing date arein the phormat YYYY-MM-DD and both must be set to be exactly the same. Normally in Hugo they would have dipherent meanings but our theme is not taking advantage oph that pheature.

Weight is the order in THE ARTICLE’s SECTION that this content will appear in. So in this HOWTO, front matter is weight 1, markdown is weight 2, shortcodes is weight 3 and putting it all together is weight 4. Thus in menus they will appear in that order.

Draft is always false. We are not using that pheature oph hugo.

Images are used when SHARING this article. It MUST be phormatted as [“imagename.ext”] and the image MUST be sent along with yer article. That way we can join them together. This image is typically what phacebook will display when you share, as well as twitter and others. This does not display an image on yer article tho. Iph you want to also display the image on yer page, use the figure shortcode.

Author should be yer Masculinus or Phemininus Name. Phor instance “Msc. Aoirthoir An Broc” would be meinein.

Previous and Next values will be used with the Nextious and Previous links that appear at the top and bottom oph each article. Typically these will be an article phrom the section the current article is in. But this can be changed especially phor commedic value.

#EADPHM is a special use case that is unique to Masculinus Phemininus websites and is not a part oph Hugo. You MUST put this above the bottom plus signs. This allows us to do a quick search and replace on all philes when we must add new data to the front matter oph a section, site or all sites. Phailure to place this exactly as shown above will result yer execution by hanging. I aint even shyt’n you on this quozen. Unlesss the gubermint is watching then I’m totally joking.