Skip to content
GitLab
  • Menu
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
    • Switch to GitLab Next
  • Sign in / Register
  • LabVIEW Toolkit Manual LabVIEW Toolkit Manual
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3
    • Issues 3
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • Deployments
    • Deployments
    • Releases
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • WovalabWovalab
  • open sourceopen source
  • Antidoc Document TypesAntidoc Document Types
  • LabVIEW Toolkit ManualLabVIEW Toolkit Manual
  • Issues
  • #1
Closed
Open
Issue created Dec 23, 2021 by Olivier Jourdan@OlivierJourdanOwner

Create documentation for simple library toolkit

Original idea from https://www.vipm.io/posts/01b17b9b-b230-4b89-8db4-7edaa057abdd/

A first version could work like that:

  • Inputs:
    • Toolkit name
    • Version number
    • main menu file (*.mnu)
    • adoc file describing the purpose of the toolkit (optional)
  • Document generated:
    • Title: Toolkit name (and version number)
    • Description Section -> adoc file content if provided
    • Functions Palette Section
      • one section for each palette/subpalette with the following content
        • Palette image
        • one subsection for each function with vi image + vi description
    • Controls Palette Section
      • one section for each palette/subpalette with the following content
        • Palette image
        • one subsection for each control with control icon + control description

NOTES:

  • No handling of examples and tools provided by the toolkit
  • The output needs to be rendered as HTML/PDF before being provided with the toolkit
Assignee
Assign to
Time tracking