advanced-topics.scrbl 1.88 KB
Newer Older
1 2 3 4
#lang scribble/manual

@(require "defs.rkt")

5 6
@(under-construction)

7
@title[#:tag "advanced-topics" #:version apt-version]{Advanced Topics}
8

Robert Ricci's avatar
Robert Ricci committed
9
@section[#:tag "disk-images"]{Disk Images}
10

11 12
@(under-construction)

Robert Ricci's avatar
Robert Ricci committed
13
@section[#:tag "rspecs"]{RSpecs}
14

15 16 17 18 19 20 21 22
The resources (nodes, links, etc.) that define a profile are expressed in the
@hyperlink["http://groups.geni.net/geni/wiki/GENIExperimenter/RSpecs"]{RSpec}
format from the GENI project. In general, RSpec should be thought of as a
sort of ``assembly language''---something it's best not to edit yourself, but
as manipulate with other tools or create as a ``compiled'' target from a
higher-level language.

That said, the tools for manipulating RSpecs are still incomplete. (For a
23
preview of @(tb)'s plans in this regard, see our section on
24 25 26 27 28 29
@seclink["planned-easier-profiles"]{planned profile creation features}.) So,
there are still some cases in which it is unfortunately useful to look at or
manipulate RSpecs directly.

@(under-construction)

30
@italic{Still to come: documentation of @(tb)'s extensions to the RSpec format.}
31

Robert Ricci's avatar
Robert Ricci committed
32 33
@section[#:tag "public-ip-access"]{Public IP Access}

34 35
@(under-construction)

Robert Ricci's avatar
Robert Ricci committed
36 37
@section[#:tag "markdown"]{Markdown}

38
@(tb) supports
Robert Ricci's avatar
Robert Ricci committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
@hyperlink["http://daringfireball.net/projects/markdown/"]{Markdown}
in the major text fields in @seclink["rspecs"]{RSpecs}. Markdown is a simple
formatting syntax with a straighforward translation to basic HTML elements
such as headers, lists, and pre-formatted text. You may find this useful in 
the description and instructions attached to your profile.

While editing a profile, you can preview the Markdown rendering of the
Instructions or Description field by double-clicking within the text
box.

@screenshot["markdown-preview.png"]

You will probably find the
@hyperlink["http://daringfireball.net/projects/markdown/"]{Markdown manual} to
be useful.

Robert Ricci's avatar
Robert Ricci committed
55
@section[#:tag "tours"]{Tours}
56 57

@italic{This feature under development}