Skip to content

Latest commit

 

History

History
240 lines (146 loc) · 5.84 KB

README.md

File metadata and controls

240 lines (146 loc) · 5.84 KB

Abbreviations and Acronyms

Obsidian Plugin

Introduction

This is a plugin for Obsidian.

Implements automatic marking of abbreviations and acronyms (terminology).

This plugin supports rendering in both editing view (Live Preview), reading view and source mode (optional). Simultaneously support listing all abbreviations in the current file.

Usage

Properties

Gets the abbreviations by reading the specified field in the note properties(metadata), and automatically render the abbreviations in the note content.

Metadata format

You can use arrays of strings or key-value pairs.

Given that Obsidian's properties support the JSON format, you can also write in an equivalent JSON format for the following YAML. However, Obsidian itself saves JSON block as YAML, so it is recommended to write properties in the YAML format.

Strings

Use a colon (:) in the string to separate the abbreviation and the tooltip.

Example:

---
abbr:
  - "HTML: HyperText Markup Language"
  - "CSS: Cascading Style Sheets"
---

Tip

The advantage of this format is that abbreviations can be added or removed directly in display mode.

Key-value pairs

Use the abbreviation for key and the tooltip for value.

Example:

---
abbr:
  - HTML: HyperText Markup Language
  - CSS: Cascading Style Sheets
---

Markdown Extra syntax

Note

This feature is experimental. Currently, there is no unified syntax specification, and the implementation of this plugin is similar to PHP Markdown Extra.

You need to enable "Enable Markdown Extra syntax support (Experimental)" in the plugin settings to activate this feature.

Gets the abbreviations by reading the specified format in the note, and automatically render the abbreviations in the note content.

Definition format

Declare at the beginning of a line, for example:

*[W3C]: World Wide Web Consortium

Disable a specific abbreviation:

*[W3C]:

It is recommended to use blank lines to separate the definition area from the main content. For example:

You can use CSS to style your HTML. 

*[HTML]: HyperText Markup Language
*[CSS]: Cascading Style Sheets

Using style sheets, you can keep your CSS presentation layer and HTML content layer separate.

Same abbreviations

When there are multiple same abbreviations, the scope is as follows:

---
abbr:
  - RAM: Random Access Memory
---

RAM.

*[RAM]: Reliability, Availability, Maintainability

RAM.

*[RAM]: Remote Access Management

RAM.

*[RAM]: 

RAM.

Rendered as:

<abbr title="Random Access Memory">RAM</abbr>.

<abbr title="Reliability, Availability, Maintainability">RAM</abbr>.

<abbr title="Remote Access Management">RAM</abbr>.

RAM.

Command

Add abbreviation

Quickly add abbreviations to properties(metadata).

Copy and format content

Copy the note content and convert abbreviations to <abbr> tags, so that they can be displayed in other Markdown editors that do not support similar syntax.

For example, for the following note content:

---
tags:
  - test
abbr:
  - HTML: HyperText Markup Language
---
# Example

You can use CSS to style your HTML. 

*[CSS]: Cascading Style Sheets

Using style sheets, you can keep your `CSS` presentation layer and `HTML` content layer separate.

After using the command, you get:

# Example

You can use <abbr title="Cascading Style Sheets">CSS</abbr> to style your <abbr title="HyperText Markup Language">HTML</abbr>. 

Using style sheets, you can keep your `CSS` presentation layer and `HTML` content layer separate.

Insert extra definition

This command is only allowed after enabling the "Enable Markdown Extra syntax support (Experimental)" setting.

Insert definition of Markdown Extra syntax at current cursor position in activity editor.

When no text is selected, insert the following content:

*[<cursor_position>]:

When selected text exists, insert the following content:

*[<selected_text>]: <cursor_position>

List abbreviations

List all abbreviations in the current file, then select one and jump to its definition position.

Manage global abbreviations

Manage global abbreviations quickly.

Settings

Metadata keyword

This plugin allows you to customize the keyword that read abbreviations from properties, default value is abbr.

Mark abbreviations in Source mode

In Source mode, mark abbreviations just like in Live Preview and Reading view.

Global abbreviations

This plugin allows you to customize globally available abbreviations.

If you want to disable a specific abbreviation in your notes, you can declaring the abbreviation as an empty string value in the properties.

Example:

---
abbr:
  - "HTML:  " # string format
  - CSS: "" # key-value pair format
---

Suffixes

This plugin allows match supplementary suffixes for abbreviations. For example, it can make the OS match other OSes. More information can see: #3.

Suffix list is defined by the user, with values set as comma-separated string. For example: s, es, less.

Preview

Live Preview:

Source mode Live Preview
source-mode live-preview

Reading:

Source mode Reading
source-mode reading

License

MIT license