Templates

Three shapes, all valid. Copy one, fill it in, and upload it on the publish page. A title and an abstract are the only required parts of any of them.

A full disclosure

Use this when the idea has real structure to it.

--- title: "Variable Geometry Conveyor Transfer Module" categories: - material-handling/conveying-systems/transfer-mechanisms keywords: - conveyor - transfer authors: - "Your Name" --- ## Abstract One paragraph saying what the arrangement is and what problem it addresses. ## Technical Field What area of engineering this belongs to. ## Background What the existing approaches do and where they fall short. ## Description How it works. Name each part and give it a number the first time it appears, for example "a drive roller (12)", then reuse that number. ![FIG. 1](figures/fig-001.png) Side elevation of the arrangement. As shown in FIG. 1, the roller pitch is reduced so that a short article is supported by at least three rollers throughout the transfer. ## Variations What can be substituted, and what range each parameter can sensibly take.

A short one

Most contributions are this size, and that is fine.

--- title: "A Short Disclosure" categories: - tools-tooling/clamping-tools --- ## Abstract One paragraph. This is the whole of a perfectly good publication: an idea that takes a paragraph to explain does not need nine headings around it. ## Description Two or three paragraphs if that is all it takes.

Mostly drawings

When the drawings are the disclosure and the words are captions.

--- title: "Gripper Jaw Profiles" categories: - robotics-automation/end-effectors --- ## Abstract Optional, but a sentence here helps somebody decide whether to look. ![FIG. 1](figures/fig-001.png) A short line about what this drawing shows. ![FIG. 2](figures/fig-002.png) And this one.

As a zip

Put the Markdown file at the top of the archive and the drawings in a figures/ folder beside it:

my-disclosure.zip publication.md figures/fig-001.png figures/fig-002.svg

Drawings may be SVG, PNG, JPEG or WebP. Reference them from the text exactly as they are named in the archive. Anything else in the zip is ignored.

The front matter

`title`	Required. Also accepted as a `# Heading` on the first line instead.
`categories`	One or more subject paths. The first is the primary one. Unknown paths are created if they fit the taxonomy.
`keywords`	Terms to be found by.
`authors`	Optional. Leave it out to publish anonymously; nothing else changes.