DeadLetter Libraries
Walk-throughWhat are they?
Libraries are collections of useful classes, datasets, objects, interpretations or filters for Conversational objects. They're designed to enable fast and reliable development on DeadLetter; often focused on interpreting one kind of information e.g. numbers, letter or places.The Basics
Naming & authorship
All libraries need a name;*lib - LIBRARY_NAME
Library names are case-sensitive, and will, if published or included (at libs.deadletter.io), form a-part of it's deadID.
Next you can add an author statement or last update comment, it's contents or inclusion has no bearing on the library.
*// COPYRIGHT 2018 YOUR NAME //*
*lib - COOKIE_ACTIONS *// COPYRIGHT 2018 YOUR NAME //*
Attributes
CL uses various text attributes to abbreviate KC's and text strings within Conversations. If you're writing your own library it's important to understand DeadLetter's standardised text attributes.They are;
@
Is a substitute for https://dld.domain.com/
"
Means post the text displayed within speech-marks (as defined in your Conversation) to your output address. You'll need to explicitly state this using;
{//POST " " output}
When defining more than one attribute for an object, you can force CL to considered a particular attribute as paramount. To do this just encase it in;
' For example Hanna, 'Hannah', Hana,
This tells CL to regard it as the most important, for this to work you'll need to include;
{ ! important }
As shown.
@; https://dld.domain.com/
"; {//POST " WORDS TO POST " output}
'; {!important}
Defining objects
You can define, a multitude of objects within a library, let's explore the most frequently used object include statements;WORD;
{DEFINITION OF WORD}
While DeadLetter is able to interpret words using the Oxford Dictionary, you're free to redefine them. Your definition must be contained within { }
You can also attach, both local and remote resources of an object;
OBJECT;
{DEFINITION OF OBJECT}
sample, @RESOURCE_deadID
actually, @RESOURCE_deadID
When doing so, you have two options, sample (i.e not the genuine artefact) and actual; you can include both for improved interpretation should you wish.
WORD; {DEFINITION OF WORD DEFINITION OF WORD}
door; {a doorway} actually, @RESOURCE_deadID sample, @RESOURCE_deadID
Closing a library
Once you're finished adding knowledge to your library you'll need to close it off - with a recall statement.
/recall -- Oxford University Press *END*