[permanent link to this page]
The Carfree Universe Project (CFU) has been archived.
Guest Login

Using Structured Text

How to use structured text to format documents.

Added by portal_administrator #16 on 2004-01-03. Last modified 2008-03-05 09:02. Originally created 2004-01-03. F0 License: Public Domain
Location: World
Topics: site documentation

Contents

Introduction

If you want to create formatted documents (with bold, underlining, links, headers and so on), you have the following options:

This document gives more detail on how to use structured text.

Links to offsite STX How-Tos

(also There is an STX tutorial below, scroll down):

Structured Text (STX) examples

Below are examples of how to use stx (the STX source for this HTML is at the bottom). Note that some html can be intermixed (not the center tag apparently).

A key point to be aware of is that the indentation of the lines is important!

Small Trials for Structured Text Formatting

This paragraph should be preceded by a level 1 header. It should not, itself, be made into a header, just a regular paragraph.

escaping math: 2 * 2 + 3 = 4

Here are a few presentation styles, in a list [1]:

  • A word: emphasized.
  • A word: underlined.
  • A word strong.
  • Some words inside a code tag

[1] (The referring text should be a paragraph, not a header, and should contain a reference to this footnote, footnote "[1]".)

Some hrefs, in a definition list:

_Regular (a link to another site)_:
http://www.zope.org/
W/trailing punctuation
http://www.zope.org/.
a link within the site
locallink Use this method to link to an image that you have added to your folder.

Here's an image in the same directory as this document:

a martian not from mars

For other effects, you can combine HTML with STX:

An off-site image as a link:

some image title

The same image centered:

North Mountain Park

An illustration of the use of the style tag:

All fields are required, except effective date and expiration date.

Here are some links to learn about using the style tag and HTML.

Tables now work!

Fruit

Nut

Mammal

Apple

Peanut

Squirrel

Orange

Macadamia

Woodchuck

Banana

Walnut

Dolphin

This spans 2 columns!

Cat

Pear

This spans 2 columns!

This spans 3 columns!

Source for STX examples

here's the source:

  Structured Text (STX) examples

    Below are examples of how to use stx. Note that some html can be intermixed (not the *center* tag apparently).

    A key point to be aware of is that the indentation of the lines is important!

    Small Trials for Structured Text Formatting

        This paragraph should be preceded by a level 1 header.  It should
        not, itself, be made into a header, just a regular paragraph.

        escaping math: '2 * 2 + 3 = 4'

        Here are a few presentation styles, in a list [1]:

        - A word: *emphasized*.

        - A word: _underlined_.

        - A word **strong**.

        - Some words 'inside a code tag'

    .. [1] _(The referring text should be a paragraph, not a header, and
    should contain a reference to this footnote, footnote "[1]".)_

        Some hrefs, in a definition list:

        _Regular (a link to another site)_: -- "http://www.zope.org/":http://www.zope.org

        _W/trailing punctuation_  -- "http://www.zope.org/":http://www.zope.org.

        _a link within the site_ -- "locallink":Members Use this method to link to an image that you have added to your folder.

    Here's an image in the same directory as this document:

        "a martian not from mars":img:cfuImage

    For other effects, you can combine HTML with STX: 

        An off-site image as a link:

        <a href="http://purl.oclc.org/net/j9k">"some image title":img:http://freezope.org/p_/ZopeButton</a>

        The same image *centered*:

        <div align="center"><img src="/p_/ZopeButton" alt="North Mountain Park"></div>

        An illustration of the use of the style tag:

        <p style="color:blue; text-align:center">All fields are required, except effective date and expiration date.</p>

        Here are some links to learn about using the "*style* tag":http://www.htmlhelp.com/reference/css/ and "HTML":http://www.w3.org/TR/html4/intro/intro.html.

        Tables now work!

         |------------------------------------|
         | Fruit     | Nut        | Mammal    |
         |====================================|
         | Apple     | Peanut     | Squirrel  |
         |------------------------------------|
         | Orange    | Macadamia  | Woodchuck |
         |------------------------------------|
         | Banana    | Walnut     | Dolphin   |
         |------------------------------------|
         | This spans 2 columns!  | Cat       |
         |------------------------------------|
         | Pear      | This spans 2 columns!  |
         |------------------------------------|
         | This spans 3 columns!              |
         |------------------------------------|

end source.

Creating a table of contents

Here is the source for this document's Table of Contents:

  Contents

   o "Introduction":#intro

   o "Links to offsite STX How-Tos":#links

   o "Structured Text examples":#ex

   o "Source for STX examples":#source

   o "Creating a table of contents":#tochowto

      - "A subhead example":#subhead

Here is how the TOC is linked to the section headings:

  Introduction<a name="intro"></a>

    {text under header cut}

  Links to offsite STX How-Tos<a name="links"></a>

   {text under header cut}

  Structured Text (STX) examples<a name="ex"></a>

   {text under header cut}

  Source for STX examples<a name="source"></a>

   {text under header cut}

  Creating a table of contents<a name="tochowto"></a>

   {text under header cut}

   A subhead example<a name="subhead"></a>

    The text under my subhead example.

A subhead example

The text under my subhead example.


Portal Administrator <>    

To comment on this document, login (you must have already joined).

v? c? 
about this site