skip to main content
research-article

Scribble: closing the book on ad hoc documentation tools

Published:31 August 2009Publication History
Skip Abstract Section

Abstract

Scribble is a system for writing library documentation, user guides, and tutorials. It builds on PLT Scheme's technology for language extension, and at its heart is a new approach to connecting prose references with library bindings. Besides the base system, we have built Scribble libraries for JavaDoc-style API documentation, literate programming, and conference papers. We have used Scribble to produce thousands of pages of documentation for PLT Scheme; the new documentation is more complete, more accessible, and better organized, thanks in large part to Scribble's flexibility and the ease with which we cross-reference information across levels. This paper reports on the use of Scribble and on its design as both an extension and an extensible part of PLT Scheme.

Skip Supplemental Material Section

Supplemental Material

scribbleclosingthebookonadhocdocumentationtoolsonvimeo.mp4

References

  1. R. Kent Dybvig, Robert Hieb, and Carl Bruggeman. Syntactic Abstraction in Scheme. Lisp and Symbolic Computation 5(4), pp. 295--326, 1993. Google ScholarGoogle ScholarDigital LibraryDigital Library
  2. Matthew Flatt. Compilable and Composable Macros, You Want it When? In Proc. ACM Intl. Conf. Functional Programming, pp. 72--83, 2002. Google ScholarGoogle ScholarDigital LibraryDigital Library
  3. Matthew Flatt, Robert Bruce Findler, Shriram Krishnamurthi, and Matthias Felleisen. Programming Languages as Operating Systems (or Revenge of the Son of the Lisp Machine). In Proc. ACM Intl. Conf. Functional Programming, pp. 138--147, 1999. Google ScholarGoogle ScholarDigital LibraryDigital Library
  4. Matthew Flatt, and PLT Scheme. Reference: PLT Scheme. PLT Scheme Inc., PLT-TR2009-reference-v4.2, 2009.Google ScholarGoogle Scholar
  5. Erick Gallesio, and Manuel Serrano. Skribe: a Functional Authoring Language. J. Functional Programming 15(5), pp. 751--770, 2005. Google ScholarGoogle ScholarDigital LibraryDigital Library
  6. Alan C. Kay. The early history of Smalltalk. ACM SIGPLAN Notices 28(3), 1993. Google ScholarGoogle ScholarDigital LibraryDigital Library
  7. Donald E. Knuth. Literate Programming. Computer Journal 27(2), pp. 97--111, 1984. Google ScholarGoogle ScholarDigital LibraryDigital Library
  8. Xavier Leroy. The Objective Caml System, release 3.10. 2007.Google ScholarGoogle Scholar
  9. Simon Marlow. Haddock, a Haskell Documentation Tool. In Proc. ACM Wksp. Haskell, pp. 78--89, 2002. Google ScholarGoogle ScholarDigital LibraryDigital Library
  10. Jacob Matthews. Component Deployment with PLaneT: You Want it Where? In Proc. Wksp. Scheme and Functional Programming, 2006.Google ScholarGoogle Scholar
  11. Norman Ramsey. Literate Programming Simplified. IEEE Software 11(5), pp. 97--105, 1994. Google ScholarGoogle ScholarDigital LibraryDigital Library
  12. Volker Simonis, and Roland Weiss. ProgDOC -- A New Program Documentation System. In Proc. Perspectives of System Informatics, Lecture Notes in Computer Science volume 2890, pp. 438--449, 2003.Google ScholarGoogle Scholar
  13. Dorai Sitaram. TeX2page. 2007. http://www.ccs.neu.edu/home/dorai/tex2page/tex2page-doc.htmlGoogle ScholarGoogle Scholar
  14. Dorai Sitaram. How to Use SLaTeX. 2007. http://www.ccs.neu.edu/home/dorai/slatex/.Google ScholarGoogle Scholar
  15. Michael Sperber (Ed.). The Revised 6 Report on the Algorithmic Language Scheme. 2007.Google ScholarGoogle Scholar
  16. Norman Walsh, and Leonard Muellner. DocBook: The Definitive Guide. O'Reilly&Associates, Inc., 2008. Google ScholarGoogle ScholarDigital LibraryDigital Library
  17. Dimitri van Heesch. Doxygen Source Code Documentation Generator Tool. 2007. http://www.stack.nl/~dimitri/doxygen/Google ScholarGoogle Scholar

Index Terms

  1. Scribble: closing the book on ad hoc documentation tools

        Recommendations

        Comments

        Login options

        Check if you have access through your login credentials or your institution to get full access on this article.

        Sign in

        Full Access

        • Published in

          cover image ACM SIGPLAN Notices
          ACM SIGPLAN Notices  Volume 44, Issue 9
          ICFP '09
          September 2009
          343 pages
          ISSN:0362-1340
          EISSN:1558-1160
          DOI:10.1145/1631687
          Issue’s Table of Contents
          • cover image ACM Conferences
            ICFP '09: Proceedings of the 14th ACM SIGPLAN international conference on Functional programming
            August 2009
            364 pages
            ISBN:9781605583327
            DOI:10.1145/1596550

          Copyright © 2009 ACM

          Publisher

          Association for Computing Machinery

          New York, NY, United States

          Publication History

          • Published: 31 August 2009

          Check for updates

          Qualifiers

          • research-article

        PDF Format

        View or Download as a PDF file.

        PDF

        eReader

        View online with eReader.

        eReader
        About Cookies On This Site

        We use cookies to ensure that we give you the best experience on our website.

        Learn more

        Got it!