How to Post

Published by strangeworks (03/15/2021)

The purpose of this post is to show you how to post (meta af). We will talk about what a post is, what a post is not, and then overwhelm you with all the possible information you can add to a post.

What a post is

A post is a short communication with the world about your work on the Strangeworks platform. This is a place to communicate about your quantum computing ideas, share links to code and papers, and generally advertise your ideas. Posts work like most simple editors with a variety of formats available for text. You can have different headers, code blocks, lists, tables, links -- essentially everything you expect from a simple online editor. A post can have a variety of media including images and video. You can use the LaTeX\LaTeX​ editor to add equations. In this post we will give examples of all these capabilities and get you ready to contribute to the Strangeworks community.

What a post is not

A post is not a paper. A post is not a journal article, a conference proceeding, or a research preprint. The LaTeX\LaTeX engine is simplified, the formatting is automatic, the customizability is limited. There is a trade-off between easy-to-use and completely customizable and posts lean heavily towards easy-to-use. Posts should be quick to create and rarely modified. The best way to use your paper in a post is to write a quick summary (copy and paste the abstract) and then create a link to the paper. After reading this post you should be ready to do exactly that!

They see me posting . . .

Basics of formatting

To start starting start with formats. We are going to look at pictures of toolbars and drop-downs and you will probably be bored and rightfully skip to the section detailing what you want to do. (Pro tip: if you think you will want text in a spot, add placeholder text as doing extensive modifications to posts can get hairy).

That is a toolbar with all your options. We can start with the formats that are available.

This is the menu of formats. If you click on the format you want, the next text you type will be in that format. Congratulations, you can format the text in your post! Most formatting will show up right away so you can see what you will get, but some formatting, particularly code formatting, might not look right immediately. To see how your published post will look click the orange "Save" button then "preview post" in the top right of the dashboard.

Just for completeness let's take a look at the rest of the formats available. We can be bold, emphasize important ideas with italics, and emphasize wrong ideas with strikethroughs.

We can be centered.

We can be right.

If you like your post to have that newsie feel you can justify your text so that there is never any space left at the end of the lines. This will mean that the spacing will change marginally. That was a magnificent pun and no one can tell me otherwise. I get the feeling that the justified setting doesn't look good in the wisiwig editor so it may require that you preview (or it might be broken).

Horizontal line time. Seriously some of this shit is self explanatory and you quantum geniuses can figure it out.


Here is a list of what you know about posts by now:

  1. You know how to format your text.
    1. Headers
    2. Paragraphs
    3. Code
    4. Bold, italic, strikethrough
  2. Text alignment
  3. Save and preview your post.
  4. Tables are left as an exercise for the reader.

Oh and you can make lists. See example above.

Linking to other work

Here we are going to do some linking. You know links, you love links. Let's go through how to link to outside work. In general you should link to your well formatted beautiful stuff, don't try and get the post editor to replicate work you have already done.
To create a link you can highlight the text you want to link and click the link icon in the toolbar.
For example, by pasting the link into the URL box in the link dialog we can create a link to an important paper in quantum computing.

Add images

Clicking the image icon in the toolbar will let you add images.
You can add images from your computer . . .

or embed images from their URL . . .

Images can be resized and their alignment can be changed. You can wrap text around an image. Pretty swell.

Video

Sometimes you need to communicate your ideas with moving pictures. You can embed videos from your post by clicking on the video icon in the toolbar.
Once the video pops up you can embed links from YouTube or elsewhere, or you can upload videos from your computer.
Pretty friggin great.

Embedded videos can be played directly on the post page and can be played full size, or resized and aligned left or right with text wrapping around them. Consider that embedded videos from external sources are dependent on the video staying up on the site you link to. For example if the Tim and Eric video above gets taken down by DMCA copyright trolls it will no longer show up on the post. (If there is no video above, you know what happened)

LaTeX\LaTeX fetish

Finally if we are really serious we probably have some ideas that are just too precise to be communicated in words, images, or even videos. In this case we will need to write some mathematical symbols. Our post editor uses a nerfed version of LaTeX\LaTeX called KaTeX\KaTeX. For more information on what functions are available checkout the KaTeX\KaTeX documentation.

Once we click the sigma icon in the toolbar we are able to start editing our symbols. We can create inline equations ex=f(un)\int e^x = f(u_n) by starting our equation in the middle of our text. Unlike latex there is no real difference between inline and display equations in the post editor. We can create display equations by starting on a new line and adjusting the font size to get the look we want. The following equation is center aligned and has font size set to 2.5 (this is size a multiplier, not "points").

ψ=Uψ\lvert \psi \rang = U \lvert \psi '\rang

The editor can create more complicated, multi-line equations and matrices as well.

[1,11,01,10,0]=[1000021/221/200001021/221/20][++++] \begin{bmatrix}
\lvert 1,1 \rang \\
\lvert 1,0 \rang \\
\lvert 1,-1 \rang \\
\lvert 0,0 \rang
\end{bmatrix}
=
\begin{bmatrix}
1& 0& 0& 0\\
0& 2^{-1/2}& 2^{-1/2}& 0\\
0& 0& 0& 1\\
0& 2^{-1/2}& -2^{-1/2}& 0
\end{bmatrix}
\begin{bmatrix}
\lvert ++ \rang \\
\lvert +- \rang \\
\lvert -+ \rang \\
\lvert -- \rang
\end{bmatrix}

The preview box in the editor will give you a good idea of what can be done as it will render your latex code live.

Linking Code

Link to your project code. Seriously, that is what this is all for.

Push the big pink button and find your project. Once the post is public anyone will be able to find your code from the post.

Get Posting

With the capabilities of the post editor it is possible to communicate quite a bit. You may run into some snags and annoyances with the post editor as it has some idiosyncrasies resulting from the tradeoff between ease of use a feature completeness. We urge you to use the post editor for quick communications introducing your ideas, with more in-depth analysis in papers and articles you can link to from your post. As with anything on the platform, let us know what you think!