Authoring Paclet Documentation

Brian Van Vertloo, Wolfram Research

(RowDefault[, (Spacer1), , (Spacer1), ])  #WolframTechConf

What is a paclet? What is paclet documentation?

Fundamentally, a paclet is one or more files that can be made available to a Wolfram Language session.

Not all paclets contain code. Some paclets contain only code. The only requirement is that a PacletInfo file is present.

What is a paclet? What is paclet documentation?

Fundamentally, a paclet is one or more files that can be made available to a Wolfram Language session.

Not all paclets contain code. Some paclets contain only code. The only requirement is that a PacletInfo file is present.

Documentation

Paclets are documented using the same format and system that the built-in Wolfram Language documentation uses.

The tools for authoring and building/deploying documentation are included in the product layout.

A paclet may contain only documentation; some paclets have no documentation.

Types of Documentation

Reference Pages

Guide Pages

Tech Notes

Types of Documentation

Reference Pages

({{, ({{▪ Symbol documentation}, {▪ Sometimes called function pages}, {▪ Strongly structured document}})}})

Types of Documentation

Guide Pages

({{, ({{▪ Collection of symbols}, {▪ Paclet may have multiple}, {▪ Strongly structured document}})}})

Types of Documentation

Tech Notes

({{, ({{▪ Sometimes called a "tutorial"}, {▪ Narrative description of feature(s)}, {▪ Loosely structured document}})}})

Types of Documentation

Overviews

({{, ({{▪ Collection of tech notes}, {▪ Table of contents}})}})

Writing Documentation

DocumentationTools

({{, , }})

DocumentationTools

Authoring Demo...

New, from-scratch pages

Function pages

Tables, options, keyboard shortcuts

Guide pages

Tech Note

Programmatic construction of pages

Other important shortcuts

Paclets Inspector

Custom Guide Pages

Demo...

Paclet Development Workshop Meet-up

Today (Friday Oct 15, 2021) at 2 PM

https://wtc2021.pathable.co/meetings/virtual/AgMAKMhKPFecXAFzC

I’ll be there too, so come ask your paclet questions!

This file and webinar information available at:

https://wtc2021.pathable.co/meetings/virtual/TWZZfzDevDCGgLamg