peek

the term peek refers to the action of “reading” or “viewing” a page.

the result of a peek may be anything that is possible in a web browser.

peeking over HTTP

a GET request will peek a page.

before returning the data.page, a pre-procesing step removes certain elements based on the permissions of the requester.

special classes

.need-admin

element is removed if peeker is not admin.

.unless-admin

element is removed if peeker is admin.

.need-poke

element is removed if peeker does not have poke privelege.

.unless-poke

element is removed if peeker is has poke access.

query parameters

at the end of a url for a GET request, you can add some “query parameters” to modify the response.

• ?code

  returns code.page as raw http response

  (useful for hosting static content: scripts, images, audio, etc)

  <domain.com>/~~/some/page?code
  

• ?data

  returns only data.page, without the ususal hawk ui wrapping around it.

  the document head will be the same as usual.

  <domain.com>/~~/some/page?data
  

• ?mime

  returns just the data.page, with a given 'content-type' header.
  

  this is useful primarily for two cases

  • serving dynamic svgs

  • serving rss feeds

  both of which are xml based.

  :: interpret a page as an rss feed:
  <domain.com>/~~/some/page?mime=application/rss+xml
  

  :: interpret a page as an svg:
  <domain.com>/~~/some/page?mime=image/svg+xml
  

• ?view

  specifies a which hawk menu to open.

  valid values:

  • tree

  • edit

  • meta

  • code

  • data

  • auth

  • dojo

  • make

  <domain.com>/~~/some/page?view=tree
  

  can be passed from a POST from using the /sys/view card attribute.

  :: after submit, the `tree` menu will be
  :: opened
  ;form(method "post")
    ;input.hidden(name "/sys/view", "tree");
    ;button: submit
  ==
  

• ?scroll

  specifies the id of an element to scroll to.

  valid values: any id on the main page.

  <domain.com>/~~/some/page?scroll=comments
  

  can be passed from a POST from using the /sys/scroll card attribute.

  :: after submit, this `comments` element
  :: will be scrolled into view
  ;div#comments
    ;form(method "post")
      ;input.hidden(name "/sys/scroll", "comment");
      ;textarea
        =placeholder  "leave a comment"
        ;
      ==
      ;button: submit
    ==
    ;*  :: load comments
  ==