Documentation

Wagn helps you organize information into cards.

cards

Cards are Wagn's building blocks. They're like atoms of data that can be combined and connected to create all kinds of new data structures. (stub){"mode":"closed","cast":{"id":15855},"options":{"nest_name":"_l+howto ...

Navigation

These features make navigating data with Wagn very powerful:

navbox

The navbox (the search bar at the top of every page) is where you go to find cards in your Wagn. You can also (stub){"mode":"closed","cast":{"id":549},"options":{"title":"add new cards","view":"link","nest_name":"adding ...

menus

Card menus are the primary interface for editing and configuring cards. They are designed to be minimally intrusive when casually reading but convenient and powerful ...

history

Wagn stores a complete history of all changes to a card's name, types, and content. Changes can easily be reviewed and reverted.

sidebar

You can have any card show up anywhere on any page. By default, wagn is configured to use a Classic Layout that includes the ...

recent changes

A list of the most recently changed cards showing who made the change and when. Many healthy community websites, most notably wiki, make heavy use of ...

Names

Every card has a unique name. Some name-related features:

name variants

No two cards can have the same name, but variants of the same name can refer to the same card, greatly simplifying handling of plurals, spacing, ...

compound names

Compound names are simply cards names with a "+" in them. The plus sign divides card names into left and right parts. Creating a ...

contextual names

Contextual (or "relative") names are cards names that can be interpreted differently based on context. Contextual names are translated into "absolute" names in links, ...

renaming

Every card has a unique name, and that name can be changed at any time to suit your evolving needs . Better still, it can ...

Suppose I have a card named "Nutella", and in that card there is content that says it contains Filberts (linking to the Filbert card). Then ...

autonaming

With some types, you may be not want to have to think about naming each one. The *autoname setting allows for the autogeneration of patterned ...

Look and Feel

Wagn's look and feel is highly customizable.

layouts

Layout rules allow you to choose a layout for any Set of cards. And with a little knowledge of HTML and inclusion, you can easily ...

views

Wagn's flexibility in displaying data comes from organizing views of cards. Views are most often applied via and are especially useful in . Views can ...

CSS

Customize styles for Skin. Scroll down for more about CSS and Wagn.

This wagn contains the following CSS cards:

Cerulean skin+bootswatch theme

Cosmo skin+bootswatch theme

...and the following SCSS cards (SCSS adds helpful syntax ...

favicon

Favicons are the little icons that appear in browser tabs. Wagn will try to make one from your logo, but this may not work with ...

Types

Every card has also a type.

types

types are a powerful tool for organizing information on Wagn. Every cards has a type, and that type can shape how a card looks and ...

Some special types:

Basic

Rich text, and it's the default cardtype. Uses a simple wysiwyg editor. All Basic Cards

HTML

HTML cards open up a world of web power for Wagn. For a few examples including embedding a Twitter feed, chat, and video, see ...

Cardtype

types are a powerful tool for organizing information on Wagn. Every cards has a type, and that type can shape how a card looks and ...

Pointer

Pointer let you create and maintain lists of cards. They are a key tool in , for relating cards to other cards. For ...
*account+*right+*create

*account+*right+*read

Search

Search cards let you query for cards using the Wagn Query Language (WQL) .

WQL, pronounced "wuckle", stands for Wagn Query Language — a query language inspired by cards and their relationships. WQL provides syntax for finding lists of ...

Tips
When you a Search, ...

JavaScript

JavaScript is a programming language supported by most browsers. Wagn uses JavaScript for dynamic page behaviors, from opening and closing cards to submitting forms. ...

CoffeeScript

CoffeeScript is a way to write readable code that compiles into JavaScript. Wagn automatically handles that compilation for you, and when CoffeeScript ... add a CoffeeScript card
Cards

Image

Wagn images are stored in Image cards: cards whose types is "Image". Images behave much like other

but they have ...

File

Uploaded files are stored with Files cards: cards whose types is "File". Creating or editing a File card will prompt you with a standard ...

Sign up

Sign up cards represent not-yet-approved accounts. When approved, they become User cards. more

User

By default, accounts are associated with a User card. When signed into a Wagn using a typical layout, you will see a link to your ...

Role

Role are groups of User used in organizing . Three roles exist in every Wagn:

automatically have ...

Set

A Set is a card that defines a group of cards. Any given card belongs to multiple sets. For example, the card named ...

Setting

Setting are options about how a card looks and behaves. It is easy to confuse the terms rules and in Wagn; they are closely ... Note: the is badly out of date and thus removed from this page. We hope to update it soon. ...

Accounts

A card can be associated with a sign-in account.

accounts

To sign into Wagn, you must have an accounts. Like everything else on Wagn, accounts are represented in cards. People with accounts can ...

permissions

Wagn's powerful permissions system lets you set CRUD (create, read, update, and delete) permissions on any Set of cards. These permissions are checked ...

captcha

CAPTCHA is an anti-spam device - usually a little picture of a word that a user has to type in before submitting ...

Editing

Cards are very simple to create, edit, and delete. Some useful editing-related features:

links

Wagn makes it very easy for you to link to other cards in Wagn, or to other websites. These links are tracked as references and ...

inclusion

cards can include other cards inside them. inclusion helps you:

edit chunks of content in place - faster and easier than editing whole pages.

keep
...

wysiwyg

WYSYWIG = What You See Is What You Get Wagn uses the customizable TinyMCE editor for user-friendly editing of rich text, so that users don't have ...

auto save

Suppose you're editing a card and click "Cancel", or your browser crashes, or you leave or close the page without saving. Wagn will have saved ...

auto save+example

comments

Wagn lets you enable commenting on a card with a friendly comment box. User comments simply get added to the end of the ...

universal edit button

The Universal Edit Button is an icon which shows up at the right end of the address bar of your web browser whenever you're ...

deleting

Anyone with permissions can delete a card via its menus. Deleting does not actually completely remove content from the system — it moves it ...

Rules

Wagn's uses "Rules" to configure groups of cards.

rules

A rules is any configuration applied to a Set of cards.

Permission to update a given cards is based on its *update . A new Wagn comes with several update rules, including these two:
...

Each of these features involves using Setting to create rules:

permissions

Wagn's powerful permissions system lets you set CRUD (create, read, update, and delete) permissions on any Set of cards. These permissions are checked ...

formatting

Forms are content patterns. Every day we encounter lots of formatted information: weather forecasts, sports cards, restaurant menus, user profile pages, tax documents and nutrition ...

virtual cards

Virtual cards organize patterned content using patterned compound names. They're not actually stored in the database but act just like "real" cards whenever you link to ...

help text

Wagn lets you create your own help text, which will show up when people are adding or editing cards. Help text is specified with two ...

If you edit "Apple" (or any Fruit card),
You can count how many seeds are in an apple, but you can't count how many apples are in a seed.
you'll see the following help text:
Basic :
Remember, tomatoes are not vegetables.

custom layouts

Layout rules allow you to choose a layout for any Set of cards. And with a little knowledge of HTML and inclusion, you can easily ...

table of contents

Wagn can use a card's headings to auto-generate a table of contents on any card, or any Set of cards using the *table of contents ...

thank you messages

Normally, when you add a card Wagn takes you to viewing that card. This feature lets you take people to another card, or any URL ...

Here at wagn.org, someone registers a new Wagn by creating a new Registration card, which is only visible to GC Staff. So, ...

captcha

CAPTCHA is an anti-spam device - usually a little picture of a word that a user has to type in before submitting ...

autonaming

With some types, you may be not want to have to think about naming each one. The *autoname setting allows for the autogeneration of patterned ...

Sharing

These features help integrate wagn with other applications.

RESTful Web API

Mapping REST to Wagn is quite simple, because Wagn only has one type of resource: the cards. The API maps standard REST actions to standard ...

following

Wagn lets you "follow" individual cards or all cards of a given type. You will be sent an email when other people change a card ...

feeds

Wagn provides a feed (RSS) of recently changed cards which you can subscribe to in web browsers and feed readers. There's also a feed of ...

file formats

You can add a file ending to the name of a card to get the card content back in other formats. Currently supported formats include ...

http://www.wagn.org/wagn/*css.css http://www.wagn.org/wagn/Documentation.txt http://www.wagn.org/wagn/Documentation.html http://www.wagn.org/wagn/Wagn_blog_entries.rss

Google Analytics

Google Analytics offers statistics on usage of your website. Wagn makes it easy to take advantage of this. To get a Google Analytics key ...

Google Analytics+example