Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Surface "add_to_drawer" in public headline API

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,175 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
64/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
lua
Ambito
documentation

Direzione di ricerca

Inizia controllando la documentazione di OrgApi collegata dall'issue, inclusi OrgApiHeadline, OrgHeadline.add_to_drawer, add_note e il link orgmode_api.txt. Documenta il metodo esistente e chiarisci se antepone il contenuto, crea i drawer mancanti e supporta la scelta tra l'inizio e la fine; il lavoro è completato quando la pagina pubblica dell'API è accurata e facilmente individuabile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement
Does this feature exist in Emacs orgmode core?

No

Is code AI assisted/generated?

No

Orgmode link

No response

Feature value

Allows users to write into drawers without needing to create custom drawer parsing logic. Useful for custom logs, event hooks, time tracking, etc.

Additional context

I'm hooking into EventManager.event.TodoChanged and appending data to the LOGBOOK drawer:

local note = "..."
event.headline:add_to_drawer("LOGBOOK", note)

This works great but isn't documented as part of the api so it could break.

It actually prepends to the top of the drawer which works fine for me but ideally the api would allow adding content to the top or bottom of an existing drawer. It also creates a drawer that does not yet exist which works well for me.

Checked using :h OrgApi there's no mention of OrgHeadline.add_to_drawer or even add_note. Also the link to orgmode_api.txt on this page leads to a 404:

https://nvim-orgmode.github.io/#api-docs
https://nvim-orgmode.github.io/doc/orgmode_api.txt

I'm not clear where OrgApiHeadline is officially documented or what the difference is so perhaps this is also a note about improving the api discoverability. I'm just calling EventManager.listen... within my orgmode setup, I'm not writing a plugin.

Lingua principale
Lua
Stelle
3.9k
Fork
192
Merge medio
2g 6h
PR unite (30g)
18

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nvim-orgmode/orgmode

Tutte le issue di nvim-orgmode/orgmode

Issue simili

Altre issue su Lua

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.