EditingApexDocWiki


Editing the Apex Documentation Wiki

You do not need to register to edit the documentation wiki. You simply need to log in with the following information:

*Your name

*Your email address

*The wiki password (if you do not have the password, you can request it from apexhelp@eos.arc.nasa.gov)

 

Apex Documentation Wiki Conventions

For the most part, the Apex Documentation Wiki uses standard PBwiki conventions, with the special cases noted below.

 

PBwiki style and tips

Wiki Style

Advanced Wiki Style

PBwiki Tips

PBwiki FAQ

Unofficial PBwiki FAQ

PBwiki Tutorial Videos

 

Other PBwiki pages

PBwiki Forums

PBwiki Central

Main page for PBwiki

 

Adding images

 

Here is an example of how to include a thumbnail linked to a larger image:

 

 

<a href="http://armstrong.arc.nasa.gov/projects/apex/images/sherpa-monitor-lg.png"><img src="http://armstrong.arc.nasa.gov/projects/apex/images/sherpa-monitor.png" /></a>

 

 

In this example, both the thumbnail image and the higher resolution image are hosted on the Apex website. This bypasses the storage limitation of 10 MB for the PBwiki site.

 

Code samples

 

For inline code samples, use the <raw> tag. For example, the following:

 

**Syntax:** <raw>(index <pattern>)</raw>

 

renders as

 

Syntax: (index <pattern>)

 

 

For larger code samples, use the verbatim tag. Also enclose the code in a white box by leaving a blank space before the verbatim tag. For example, the following:

 

<verbatim>(procedure
    (index (get-hires-image ?target))
    (profile camera-1)
    (step s1 (move-to-standoff ?target => ?loc))
    (step s2 (power-up camera-1))
    (step s3 (orient-camera camera-1 to ?target)
       (waitfor (:and (terminated ?s1) (terminated ?s2))))
    (step s4 (take-picture camera-1)
       (waitfor (terminated ?s3)))
    (restart-when (resumed +this-task+))
    (terminate (when (image-in-mem ?target))))

 

 

renders as

 

(procedure
    (index (get-hires-image ?target))
    (profile camera-1)
    (step s1 (move-to-standoff ?target => ?loc))
    (step s2 (power-up camera-1))
    (step s3 (orient-camera camera-1 to ?target)
       (waitfor (:and (terminated ?s1) (terminated ?s2))))
    (step s4 (take-picture camera-1)
       (waitfor (terminated ?s3)))
    (restart-when (resumed +this-task+))
    (terminate (when (image-in-mem ?target))))