Skip to content

How to Use

Boris Buliga edited this page Jul 16, 2024 · 4 revisions

Notes are the pillars of Vino. The notes are regular Org Mode files with defined structure, which can be extended (see 'Extensions' section).

At the moment, there are no special views bundles with Vino, except for Inventory which comes with its own UI.

This document describes usage flows and interactive functions of interest.

TL;DR

Bind and use the following interactive functions:

  • vino-entry-create: Create a new wine entry using vino-entry-template. This function allows you to create other notes on the go—producer, region/appellation, and grapes.
  • vino-entry-find-file: Visit a wine entry using completion.
  • vino-entry-rate: Rate a given wine entry (either the one that is being visited or pick one using completion). See Ratings for configuration options.
  • vino-entry-update: Update/synchronise data in the wine entry according to linked notes and also update title and descriptions of the linked notes.
  • vino-entry-set-region: Change origin of the wine entry. Avoid making any manual modifications.
  • vino-entry-set-grapes: Change grapes of the wine entry.

If you are using the vino-inv feature, you have additional interactive functions:

  • vino-inv-consume: Consume and optionally rate a specific bottle from your inventory. This should be used instead of vino-entry-rate as vino-inv-consume registers more meta-information to the rating note.
  • vino-inv-ui: Open your inventory. Refer to Inventory to learn more about this feature.

This is the bare minimum. Read further to learn more about these functions and discover some unmentioned ones.

Creating and Visiting Notes

While Vino works with regular Org Mode files, it's best to use dedicated functions to create notes for Vino as they ensure all required information is provided.

You can also use vulpea-find to select and visit Vino notes, but Vino provides dedicated functions for that.

Wine Entry

vino-entry-create is an interactive function to create a new wine entry using vino-entry-template. You should bind and use it whenever you want to create a new entry as it queries all the information required by vino and also allows you to create other notes on the go (producer, region/appellation, and grapes).

This function can be extended using vulpea-insert-handle-functions. Refer to the 'Extensions' section for more information.

vino-entry-find-file is an interactive function to visit a wine entry by picking one using a completion interface (based on the title of the wine entry).

Other Notes

Each other note type has a dedicated interactive create function. While normally you should not use them directly, you are free to use them if needed.

  • vino-producer-create / vino-producer-find-file
  • vino-country-create / vino-country-find-file
  • vino-region-create / vino-region-find-file
  • vino-apellation-create / vino-appellation-find-file
  • vino-grape-create / vino-grape-find-file

Note that all of the mentioned vino-*-find-file functions allow you to create a new note.

See 'Selecting origin' for more information about country, region and appellation selection.

Wine Entry Title and Other Properties

A wine entry title is composed of the producer's title, wine name, and vintage (or NV if missing). You can change it by updating any of these properties. To apply the changes (both to the wine entry and the linked rating notes), you should use vino-entry-update.

Rating Wines

vino-entry-rate allows you to rate a wine entry based on Rating Configurations. It handles the linking between notes and other related tasks.

If you are using the Inventory feature, you should use vino-inv-consume instead as it also manages your inventory state and optionally allows you to rate the wine while populating it with additional information (like bottle ID and volume).

This function can be extended using vino-rating-create-handle-functions. Refer to the ‘Extensions’ section for more information.