peek

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


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
    
  • ?view

    specifies a which hawk menu to open.

    valid values:

    • tree

    • edit

    • meta

    • code

    • data

    • card

    • dojo

    • make

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