Skip to content

Commit

Permalink
add new commands
Browse files Browse the repository at this point in the history
  • Loading branch information
masaki39 committed Apr 28, 2024
1 parent 0a44e84 commit 4b3087f
Show file tree
Hide file tree
Showing 3 changed files with 273 additions and 165 deletions.
54 changes: 31 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,61 +4,69 @@
- Obsidian Outline Converter Plugin
- Features
- This plugin converts bullet list outlines into continuous text.
- You can use two commands: `Auto-header converter` & `Custom converter`
- It includes commands to fold text at indentation levels 1-3.
- Preset conversion commands convert `[[@citekey]]` into Pandoc citation style, assuming use with Citations plugins.
- Installation
- You can download from `Community plugins` in Obsidian settings.
- Custom converter
- Commands
- You can choose to convert selected text, or if none is selected, all content in the active note will be accessed.
- Customize how text is handled at each indentation level from 1 to 5.
- Options include inserting text before or after content, ignoring content, and using line breaks.
- Auto-header converter
- It automatically determines whether the text is a header or a sentence.
- Custom converter
- Customize how text is handled at each indentation level from 1 to 5.
- Options include inserting text before or after content, ignoring content and using line breaks.
- Replacement
- You can search & replace terms as you like before outputting the connected sentences.
- Select export method
- Choose from the following options for exporting your text:
- Copy to clipboard.
- Append to the cursor's current position.
- Append to the bottom of the active note.
- Replace a section; if none exists, create it at the bottom of the note.
- Preset commands
- This feature is tailored for academic writing.
- It converts outlines to Pandoc citation style, compatible with manuscript submission requirements by subsequent usage of Pandoc plugins
- "Section" means h2 header.
- "Paragraph" introduces a double line break.
- "Skip" ignores an indentation level.
- "Content" converts into continuous text.
- "Reference" extracts and converts `[[@citekey]]` into Pandoc citation style.
- Swap lines commands
- In bullet lists, it uses line swapping commands of the Outliner plugin.
- Outside of that, it simply swaps lines.
- You cannot use unless the Outliner plugin is installed.
- You cannot use these commands unless the Outliner plugin is installed.
- Note
- This outline has been converted into the text below.
- The command of `Auto-header converter` can convert this outline into the text below.


# Output

## Obsidian Outline Converter Plugin

### Features

This plugin converts bullet list outlines into continuous text. It includes commands to fold text at indentation levels 1-3. Preset conversion commands convert `[[@citekey]]` into Pandoc citation style, assuming use with Citations plugins.
This plugin converts bullet list outlines into continuous text. You can use two commands: `Auto-header converter` & `Custom converter` It includes commands to fold text at indentation levels 1-3.

### Installation

You can download from `Community plugins` in Obsidian settings.

### Custom converter
### Commands

You can choose to convert selected text, or if none is selected, all content in the active note will be accessed. Customize how text is handled at each indentation level from 1 to 5. Options include inserting text before or after content, ignoring content, and using line breaks.
You can choose to convert selected text, or if none is selected, all content in the active note will be accessed.

### Select export method
#### Auto-header converter

Choose from the following options for exporting your text: Copy to clipboard. Append to the cursor's current position. Append to the bottom of the active note. Replace a section; if none exists, create it at the bottom of the note.
It automatically determines whether the text is a header or a sentence.

#### Custom converter

### Preset commands
Customize how text is handled at each indentation level from 1 to 5. Options include inserting text before or after content, ignoring content and using line breaks.

This feature is tailored for academic writing. It converts outlines to Pandoc citation style, compatible with manuscript submission requirements by subsequent usage of Pandoc plugins "Section" means h2 header. "Paragraph" introduces a double line break. "Skip" ignores an indentation level. "Content" converts into continuous text. "Reference" extracts and converts `[[@citekey]]` into Pandoc citation style.
### Replacement

You can search & replace terms as you like before outputting the connected sentences.

### Select export method

Choose from the following options for exporting your text: Copy to clipboard. Append to the cursor's current position. Append to the bottom of the active note. Replace a section; if none exists, create it at the bottom of the note.

### Swap lines commands

In bullet lists, it uses line swapping commands of the Outliner plugin. Outside of that, it simply swaps lines. You cannot use unless the Outliner plugin is installed.
In bullet lists, it uses line swapping commands of the Outliner plugin. Outside of that, it simply swaps lines. You cannot use these commands unless the Outliner plugin is installed.

### Note

This outline has been converted into the text below.
The command of `Auto-header converter` can convert this outline into the text below.
Loading

0 comments on commit 4b3087f

Please sign in to comment.