Log Book

Overview

This provides a control panel to input logbook information to a notebook in an efficient and consistent manner. The notebook content is by default formatted in markdown syntax, however this option can be toggled off to create a rich-text level notebook, e.g. for export to a cleaner looking PDF file.

Features

The start of every notebook is stamped with the date and experiment information.

Sections are provided to grab comments, graphics, history, and a folder directory. If you have pictures in the experiment, you can also choose to insert them in the notebook.

The input comments can contain dynamic codes to execute a function or operation call.

  • %date() - inserts the date at that point in the notes
  • %MyStringList(10) - inserts the string results from MyStringList(10) at that point in the notes
  • #print date() - prints the date to the history area
  • #MyFunction(10,3,5) - runs my function with the given parameters
  • #{MyOperation parameters} - runs my operation with the given parameters
  • %clipTEXT - put clipboard text

The notebook is saved using the Save Notebook button. An example below shows a saved markdown notebook viewed in Obsidian. The pictures are exported in a separate folder. The file naming sequence is autocorrected before export. Shift-click on the Save Notebook button to autocorrect the naming without exporting.

The captions tags are generated using the Windows Notes package.

Distribution Details

  • Experiments: none
  • Procedure Files: LogBook.ipf
  • XOPS: none
  • Demos: none
  • Requires Packages: NONE*
  • Help Files: LogBook.ihf
  • Other Documentation: the Web pages for this project

Images:

Example to create a notebook using this package. Notebook view in Obsidian LogBook Panel v4.30

Project Details

Current Project Release

Release File: LogBook v4.50.zip (250.66 KB)
Version: 4.50
Version Date:
Version Major: 4
Version Patch Level: 50
OS Compatibility: Windows Mac-Intel
Release Notes:

Skipped a version (4.40) but, oh well.

Squashed Bugs

● fixed error in creating package globals at startup
● fixed error showing clipboard in listbox selection when no graphic is on clipboard
● fixed error showing panel at correct size when checked with fullscale at letter paper
● fixed inconsistent approach to show panel in various cases

Improved Code

● removed all DEBUG options
● removed use of ba.ctrlName code method to auto-clear notes
● standardized many function names and added static prefix where applicable
● streamlined formatting text to notebook using or not using markdown
● streamlined string listing functions for popmenu, frontmost, and listbox outputs
● added more comments to document portions of code
● did ipt lint cleanup of code

Improved/Changed UI

● notebook titles no longer have suffix numbers (unless needed)
● new notebook starts with hidden rulers
● widened panel and made input field region taller
● added separator lines to distinguish specific sections on panel
● renamed ### to 3+ to denote (sub) headers not just markdown (sub) headers
● iconizing panel shifts panel to left not right corner of notebook
● added help icon button to open a visit to the Webpage, open the help file, and email a bug report or a feature request
● added an action cog button to perform actions previously “hidden” but accessible through complex keystroke clicks

New Features

● added page break after opening information list
● creation / modification now adhere to ISO 8601 using T not | between data and time (but no UTC offset is included)
● can now put Gallery pictures into notebook

Documentation

● updated help file

View All Releases

Forum

Support

Gallery

Igor Pro 10

Learn More

Igor XOP Toolkit

Learn More

Igor NIDAQ Tools MX

Learn More