• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
Writing documentation can be fun
 

Writing documentation can be fun

on

  • 483 views

Presentation by Kristina D.C. Hoeppner at Linux.conf.au in Perth, Australia, on 8 January 2014.

Presentation by Kristina D.C. Hoeppner at Linux.conf.au in Perth, Australia, on 8 January 2014.

Audio available at https://archive.org/details/DocumentationFun20140108

Statistics

Views

Total Views
483
Views on SlideShare
480
Embed Views
3

Actions

Likes
1
Downloads
3
Comments
0

1 Embed 3

https://twitter.com 3

Accessibility

Upload Details

Uploaded via as Adobe PDF

Usage Rights

CC Attribution-ShareAlike LicenseCC Attribution-ShareAlike License

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Writing documentation can be fun Writing documentation can be fun Presentation Transcript

    • Writing  documentation   can  be  fun   Kristina  D.C.  Höppner,  Catalyst  IT http://www.flickr.com/photos/77909728@N00/2819392649/ kristina@catalyst.net.nz  ‧  Presentation:  Creative  Commons  BY-­‐SA  3.0   LCA  2014  ‧  Perth  ‧  8  January  2014
    • ELLO H E IS Y NAM M a tin is Kr
    • Once  upon  a  time
    • Kristina  D.C.  Hoeppner
    • Sphinx http://www.flickr.com/photos/ephysimon/3136420463/
    • manual.mahara.org
    • 1 reStructured  Text
    • 1 reStructured  Text commonly  used  images
    • 1 reStructured  Text
    • 1 reStructured  Text index  generation
    • 1 reStructured  Text anchor  for  cross-­‐reference
    • 2 Geany
    • 2 Geany document   structure
    • 2 Geany jump
    • 3 Gimp+
    • 3 Gimp+ auto-­‐incrementing   callouts
    • 3 Gimp+ arrows
    • 3 Ubuntu  alternative:  Shutter arrows auto-­‐incrementing  callouts
    • 4 Sphinx make preview Mahara=1.8 kristina@grannysmith:~/code/manual18$ ! sphinx-build -a -D language=en -b html -d build/doctrees source build/html/en/! Running Sphinx v1.1.3! loading translations [en]... locale not available! loading pickled environment... done! building [html]: all source files! updating environment: 0 added, 0 changed, 0 removed! looking for now-outdated files... none found! preparing documents... done! writing output... [100%] todo ! writing additional files... genindex search! copying images... [ 3%] images/page_editor/blocks/journals_tagged_new_entry.pncopying images... [ 10%] images/administration/institution_authentication_plugicopying images... [ 18%] images/administration/ site_statistics_historical_data.copying images... [ 32%] images/page_editor/blocks/ taggedjournalentries_configucopying images... [ 50%] images/page_editor/blocks/ imagegalleryexternal_configucopying images... [ 54%] images/administration/ institution_authentication_ordercopying images... [ 60%] images/page_editor/blocks/ journals_recent_new_entry.pncopying images... [ 67%] images/page_editor/blocks/ creativecommons_configure.pncopying images... [ 67%] images/page_editor/blocks/ recentjournalpost_chooser.pncopying images... [ 70%] images/page_editor/blocks/ recentforumposts_configure.pcopying images... [ 77%] images/page_editor/blocks/ recentjournalpost_configure.copying images... [ 97%] images/page_editor/blocks/ taggedjournalentries_choosercopying images... [100%] images/administration/ pending_registration_approval.png! copying static files... done! dumping search index... done! dumping object inventory... done! build succeeded.! magic  happens ! Build finished. The HTML pages are in build/html/en/.
    • pdf        html        epub
    • 5 Git
    • 6 Launchpad
    • 7 Sphinx+
    • 8 Piwik
    • ≈  92,000  words * *  http://www.webwordcount.com/count.php
    • 438  images
    • Links ‣ Mahara  user  manual  online:  http://manual.mahara.org   ‣ Mahara  user  manual  git  repro:  https://gitorious.org/mahara/manual     ‣ Mahara  user  manual  scripts:  https://gitorious.org/mahara/manual-­‐ packaging     ‣ Geany:  http://www.geany.org/       ‣ Gimp:  http://www.gimp.org   ‣ Gimp  callout  script:     ‣ original:  http://registry.gimp.org/node/25086     ‣ Mahara-­‐specific:  https://mahara.org/view/view.php?id=60234     ‣ Gimp  arrow  script:  http://registry.gimp.org/node/20269     ‣ Shutter:  http://shutter-­‐project.org/     ‣ Sphinx:  http://www.sphinx-­‐doc.org/   ‣ Piwik:  http://piwik.org/  
    • Get  involved www.mahara.org kristina@catalyst.net.nz   Stay  in  touch @anitsirk   ! www.catalyst.net.nz