Plugin Directory

Changeset 3406034


Ignore:
Timestamp:
11/30/2025 07:38:24 AM (6 weeks ago)
Author:
joop
Message:

Fix readme

Location:
inline-context
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • inline-context/tags/2.3.8/readme.txt

    r3406033 r3406034  
    1919Notes can be **reusable**, categorized, styled, centrally managed, and automatically updated everywhere they appear.
    2020
    21 ---
    22 
    23 ### Why this is valuable for content-heavy websites
     21= Why this is valuable for content-heavy websites =
    2422
    2523Websites with substantial text often need:
     
    3432Inline Context delivers all of this with a frictionless, accessible user experience. It helps readers stay focused, reduces navigation fatigue, and improves knowledge retention — especially in long articles or research-based content.
    3533
    36 ---
    37 
    38 ### How it works
     34= How it works =
    3935
    40361. Highlight text in the Block Editor.
     
    4642You can also create **reusable** notes from a dedicated Custom Post Type. Updating a reusable note updates all instances site-wide.
    4743
    48 ---
    49 
    5044== Key Features ==
    5145
    52 ### Display Modes
     46= Display modes =
    5347* Inline expansion (reveals a small content panel)
    5448* Tooltip popovers (floating contextual bubbles)
     
    5751* Auto-open on page load when accessed via link
    5852
    59 ### Editor productivity
     53= Editor productivity =
    6054* Reusable notes with global updates
    6155* Notes Library with usage tracking (shows where each note is used)
     
    6458* Clean, integrated Rich Text toolbar button
    6559
    66 ### Categories & icons
     60= Categories & icons =
    6761* Create unlimited categories (Definition, Reference, External Article, Tip, Warning, etc.)
    6862* Choose from curated Dashicons or any of 300+ icons
    6963* Separate icons for open and closed states
    7064
    71 ### Styling & customization
     65= Styling & customization =
    7266Full styling control from **Settings → Inline Context**:
    7367* Link colors, hover, and focus states
     
    7771* Live interactive preview of all style changes
    7872
    79 ### Accessibility & security
     73= Accessibility & security =
    8074* ARIA support, focus lock, Escape key behavior
    8175* Keyboard-navigable for both link and note
    8276* DOMPurify sanitization of note content
    83 
    84 ---
    8577
    8678== Internationalization ==
     
    8880Inline Context is fully translation-ready.
    8981
    90 ---
    91 
    9282== Examples & inspiration ==
    9383
    9484The idea for this plugin originated from a project with Renée Kool — a visual artist working in public art, film, and emerging media. She wanted to create a website where a single link could reveal additional content containing multiple related links. We looked at the Dutch journalism platform De Correspondent, which use subtle inline notes to provide context without interrupting the flow of reading. You can see examples of their inline notes in this article: [Hoe Nederland kampioen deeltijdwerken werd](https://decorrespondent.nl/15887/hoe-nederland-kampioen-deeltijdwerken-werd/9053b712-3591-0002-29b3-8c7b69eae0c3)
    95 
    96 ---
    9785
    9886== Source code ==
     
    10391[https://github.com/jooplaan/inline-context](https://github.com/jooplaan/inline-context)
    10492
    105 ---
    106 
    10793== Installation ==
    10894
     
    112984. In the Block Editor, select text and click **Inline Context**.
    113995. Add your note content and choose a category (optional).
    114 
    115 ---
    116100
    117101== Frequently Asked Questions ==
     
    129113Yes. You can type any Dashicon class name to use all 300+ icons.
    130114
    131 ---
    132 
    133115== Screenshots ==
    134116
  • inline-context/trunk/readme.txt

    r3406033 r3406034  
    1919Notes can be **reusable**, categorized, styled, centrally managed, and automatically updated everywhere they appear.
    2020
    21 ---
    22 
    23 ### Why this is valuable for content-heavy websites
     21= Why this is valuable for content-heavy websites =
    2422
    2523Websites with substantial text often need:
     
    3432Inline Context delivers all of this with a frictionless, accessible user experience. It helps readers stay focused, reduces navigation fatigue, and improves knowledge retention — especially in long articles or research-based content.
    3533
    36 ---
    37 
    38 ### How it works
     34= How it works =
    3935
    40361. Highlight text in the Block Editor.
     
    4642You can also create **reusable** notes from a dedicated Custom Post Type. Updating a reusable note updates all instances site-wide.
    4743
    48 ---
    49 
    5044== Key Features ==
    5145
    52 ### Display Modes
     46= Display modes =
    5347* Inline expansion (reveals a small content panel)
    5448* Tooltip popovers (floating contextual bubbles)
     
    5751* Auto-open on page load when accessed via link
    5852
    59 ### Editor productivity
     53= Editor productivity =
    6054* Reusable notes with global updates
    6155* Notes Library with usage tracking (shows where each note is used)
     
    6458* Clean, integrated Rich Text toolbar button
    6559
    66 ### Categories & icons
     60= Categories & icons =
    6761* Create unlimited categories (Definition, Reference, External Article, Tip, Warning, etc.)
    6862* Choose from curated Dashicons or any of 300+ icons
    6963* Separate icons for open and closed states
    7064
    71 ### Styling & customization
     65= Styling & customization =
    7266Full styling control from **Settings → Inline Context**:
    7367* Link colors, hover, and focus states
     
    7771* Live interactive preview of all style changes
    7872
    79 ### Accessibility & security
     73= Accessibility & security =
    8074* ARIA support, focus lock, Escape key behavior
    8175* Keyboard-navigable for both link and note
    8276* DOMPurify sanitization of note content
    83 
    84 ---
    8577
    8678== Internationalization ==
     
    8880Inline Context is fully translation-ready.
    8981
    90 ---
    91 
    9282== Examples & inspiration ==
    9383
    9484The idea for this plugin originated from a project with Renée Kool — a visual artist working in public art, film, and emerging media. She wanted to create a website where a single link could reveal additional content containing multiple related links. We looked at the Dutch journalism platform De Correspondent, which use subtle inline notes to provide context without interrupting the flow of reading. You can see examples of their inline notes in this article: [Hoe Nederland kampioen deeltijdwerken werd](https://decorrespondent.nl/15887/hoe-nederland-kampioen-deeltijdwerken-werd/9053b712-3591-0002-29b3-8c7b69eae0c3)
    95 
    96 ---
    9785
    9886== Source code ==
     
    10391[https://github.com/jooplaan/inline-context](https://github.com/jooplaan/inline-context)
    10492
    105 ---
    106 
    10793== Installation ==
    10894
     
    112984. In the Block Editor, select text and click **Inline Context**.
    113995. Add your note content and choose a category (optional).
    114 
    115 ---
    116100
    117101== Frequently Asked Questions ==
     
    129113Yes. You can type any Dashicon class name to use all 300+ icons.
    130114
    131 ---
    132 
    133115== Screenshots ==
    134116
Note: See TracChangeset for help on using the changeset viewer.