last edited by powell on 32-0072.34

AL1 / ALMANET INTERNAL: AutoScript

view entry rationale

aqp

view navigator


ALMANET INTERNAL: AutoScript

Hello, team. As you know, we're rolling out the new AlmaNet system, and I've been tasked with explaining how we'll be formatting our entries. We're using AutoScript, which is basically a way to make our entries look nice without having to fiddle with Seq'l for every entry. I'll do my best to explain it, but if you have questions, just... I don't know, write them down and we'll have a meeting or something.

What is AutoScript?

AutoScript is this text encoding system that Theo and I came up with. It's supposed to make our lives easier when we're writing entries for AlmaNet. The whole point is that it's readable as plain text, but it also tells the SLCs how to display things nicely.

How to Use AutoScript

Okay, so here's the basics:

  1. Headers: Use '#' symbols at the start of a line. More '#' means it's a smaller header. Like this:

    Main Header

    Subheader

    Even smaller header

  2. Making text stand out: Use '*' for italic and '' for bold. Like this:
    This is italic
    This is bold**

  3. Lists: Use '-' or '*' for bullet points, and numbers for numbered lists. Like this:

    • First point
    • Second point
    1. Numbered point
    2. Another numbered point
  4. Links: Put the text you want to show in square brackets, then the link or tape address in parentheses. Like this:
    Click here to see the AlmaNet homepage

  5. Code blocks: If you need to show Sequential code or something, use three backticks before and after. Like this:

   PTIN EXAMPLE
   MOVE "Hello, AlmaNet!" ECHO
   PEND
  1. Quotes: Use '>' at the start of a line for quotes. Like this:

    "Knowledge is power." - Some smart person, probably

  2. Tables: Use pipes (|) and hyphens (-) to make tables. Like this:

    Column 1 Column 2
    Data 1 Data 2
    Data 3 Data 4
  3. Footnotes1

Look, I know this might seem like a lot, but trust me, it's easier than trying to code everything by hand. Just follow these guidelines, and the system will take care of the rest.

Final Notes

Remember, we're building the world's first true open access encyclopaedia here. It's important that we get this right. If you're having trouble with AutoScript, just... I don't know, ask one of the younger folks on the team. They seem to pick this stuff up quickly. Ping tw or me if you're having issues.

Oh, and make sure you're saving your work regularly. I know spinning up the tape drives takes time, but I'd rather you save more than you think you have to. We don't want to lose anything important.

That's all for now. Let's make AlmaNet the best it can be, or whatever motivational thing I'm supposed to say here.

  • Morton

  1. This is a footnote. 


Almanet

This file has been provided free of charge by AlmaNet,
the interconnected digital multimedia almanac.

AlmaNet is a GRID service provided by the Free Knowledge Movement.
All content on AlmaNet is freely available for quotation and reference.

Created by Morton Powell on Tallis