Diving Deeper Shaun McCance http://syllogist.net/ ∴ Syllogist Ins ide Mallard and the GNOME help s ys tem
Jul 13, 2015
Diving Deeper
S haun McCancehttp://syllogis t.net/
∴ S yllogis t
Ins ide Mallard and the GNOME help sys tem
Diving Deeper
S haun McCancehttp://syllogis t.net/
∴ S yllogis t
Ins ide Mallard and the GNOME help sys tem
Image © Bruno cc-by-nc-sa 2.0 http://www.flickr.com/photos /derpunk/542797204/
Mallard
∴ S yllogis t
Topic-orientedS impleDynamicExtens ible
Book-oriented
∴ S yllogis t
Topic-oriented
∴ S yllogis t
Topic-oriented
∴ S yllogis t
S haun's 3 rules for good topic-oriented help:Topics are as self-contained as pos s ible.Readers can find topics in a way that makessense to them.Topics are cros s -linked so readers can findmore information.
S imple
∴ S yllogis t
Mallard: ~ 50 elementsDocBook: ~ 420 elementsDITA: ~ 220 elements
S imples t Mallard Page
∴ S yllogis t
<page xmlns=”http://projectmallard.org/1.0/” id=”index”> <title>A Simple Page</title></page>
Markup You Expect
∴ S yllogis t
<page xmlns=”http://projectmallard.org/1.0/” id=”index”> <title>A Simple Page</title>
<p>A paragraph</p>
<steps> <item><p>First step</p></item> <item><p>Next step</p></item> </steps>
<code>some_code(); </code>
<p>Click <gui>Close</gui>. Press <key>Esc</key>. Run some <cmd>command</cmd>.</p>
</page>
Linking
∴ S yllogis t
Linking ( in Reality)
∴ S yllogis t
Linking (the Mallard Way)
∴ S yllogis t
Dynamic Links
∴ S yllogis t
S eamles s ly integrate content from:Dis tros – extra config toolsOEMs – specialized softwarePlugins – integrated with app help
Extens ible
∴ S yllogis t
Ways to extend Mallard:S tyle hintsExtens ion attributesExtens ion elements( info, block, inline)
Mix with Exis ting Formats
∴ S yllogis t
ITS – Localization informationhttp://blogs .gnome.org/shaunm/2010/10/27/xml-trans lations -with-its /
S VG – S calable vector graphicshttp://projectmallard.org/about/learn/s vg.html
TTML – S ubtitles for videoshttp://blogs .gnome.org/shaunm/2010/11/08/mallardttml-video-captions /
MathML – Math for people who like typing
Create New Awesomeness
∴ S yllogis t
Conditional proces s inghttp://projectmallard.org/if/1.0/
Faceted navigationhttp://blogs .gnome.org/shaunm/2010/12/16/more-faceted-navigation/
Dynamic glos sarieshttp://blogs .gnome.org/shaunm/2011/07/07/mallard-glos saries /
Automatic API synopses
[Your awesomeness here]
Diving Deeper
∴ S yllogis t
Diving Deeper
∴ S yllogis t
Diving Deeper
∴ S yllogis t
Diving Deeper
∴ S yllogis t
Diving Deeper
∴ S yllogis t