Markup language cheat sheet
Team.FM is as simple as instant messaging - you may just exchange messages with your collegues. Powerful, yet simple and easy, markup language is secret souces that makes all the difference.
The basic elements of the markup language are these:
#hashtag- hashtags are here to indicate the action required or status of the message.
[Named Topics]- topics are the groups of messages. For example, a todo list, a wiki page, milestone - are types of topics. By default, topic is just a general group. You may add more views to topic and convert it into to-dos, notes, etc.
@mentionsare used to reference other people.
Each message may contain as many or as few markup elements as needed. You may user markup in your message's text directly (from any input form into the system, not just from Flow view), or may add markup meta to the messages later (yours or or messages from others). This is what we call "curated stream" - your entire team can convert any message to a todo, a note, etc.
The specific markup pieces are added by each of the apps in your space.
Topic as a list of messages may be presented in different views and provide different functions. Each app may add a view to the library. To use this view, you have to add it to topic explicitly or use application's hashtag in your flow messages together with the topic name. For example,
#todo [Todo list name] my message will add Todo view to this topic.
Here's the summary of markup macros by application.
#asap- will assign ASAP status to the message/task
#later- will put the message/task into the backlog
#waiting- just adds this tag and makes it easy to find such dependendices in Calendar
#thismonth- will set due date to end day of corresponding period
#dm @recipient- sends a direct message to the recipient(s) mentioned in the message. If recipient doesn’t have an account with Team.FM, the message will be delivered via e-mail.
#dm [Group of Contacts]- works in your personal space to send a broadcasting message to the entire group of your contacts.
#dm, except it sends messages via e-mail.
#discuss- you may use it in your message or add later on to indicate that that's the idea worth discussion
#note- to mark the message as note (or to note it)
#note [Topic Name]- to create a note and put it under Topic Name page
#N, where N is integer - Pivots module introduces automatic numbering for the tickets. You may use
#123(ID of a ticket) in your messages to make it link to the ticket. For example, you can link source code pushes to the tickets (and also change its status if you want!).
#started, #finished, #delivered, #cancelled- ticket statuses. Replying with these tags in a message to a ticket will put the task in the corresponding status.
#inprogressis the synonym for
#task, #bug, #feature, #enhancement- ticket types.
$Ncpwhere N is integer from 1 to 8 is in reference to the complexity points of the ticket. If you mention
$4cpin your message, the ticket will be created with the CP field set to 4.
Version Control Repos (Hosted Mercurial or GitHub)
If used in conjunction with Pivots app, you could commit like
#done #11and it will be linked to ticket #11 and will mark it as fisnished.
#todo- will convert the new message into a task you may later find in to-do lists.
#done- when you reply to a to-do with !done in your message, it’ll mark the task as completed.
#todo @owner [Topic Name]- will assign @owner as the responsible for the task and will put it in [Topic Name] to-do list. If this topic wasn’t a to-do list before, it’ll extend it to be one.