Rozszerzenie trybu organizacji o więcej znaczników

26

Chcę dodać znacznik i formatowanie takiego znacznika, tj. <kbd>...</kbd>Z ramką otaczającą taki znacznik. Chcę również, aby znak był zgodny z (setq org-hide-emphasis-markers t). Oznacza to, że gdy zmienna jest ustawiona na t, znaczniki <kbd>i </kbd>powinny zniknąć, pozostawiając tekst między nimi z określonym formatowaniem powyżej.

Odpowiedź zamieszczona w tym pytaniu: Jak trwale podświetlić tekst w trybie organizacji , nie rozwiązuje tego problemu, ponieważ ma on zastosowanie tylko do istniejących znaczników, nie rozszerzając Organizacji o nowe znaczniki.

Do zrobienia
źródło
1
@kaushalmodi Zapytałem, jak dodać znacznik, że kiedy Org go zobaczy, dodaje odpowiednio właściwości tekstu w taki sposób, że znaczniki można ukryć org-hide-emphasis-markers, a nie jak szybko wstawić kbdznacznik.
Tu Do
1
Zgadzam się. Umieściłem to jako komentarz, ponieważ był związany ze znacznikami KBD.
Kaushal Modi
2
możliwy duplikat Jak trwale podświetlić tekst w trybie org
erikstokes
1
@erikstokes to rozwiązanie dotyczy tylko istniejących znaczników, a nie nowych.
Tu Do

Odpowiedzi:

25

Zrobiłem coś podobnego . Jest w języku francuskim, ale kod powinien mówić sam za siebie. Używam jako znacznika (używam układu bepo ), a kiedy to robię, zaznaczony tekst jako styl naciśniętego przycisku.

Nie jestem biegły w seplenieniu, więc może być miejsce na poprawę.

To, co zrobiłem, polega na tym, że podczas używania znacznika zaznaczony tekst ma styl wciśniętego przycisku, a po wyeksportowaniu jest tłumaczony na<kbd>

Najpierw musiałem zdefiniować nową twarz:

(defface my-face-org-keystroke
  '((t (:inherit shadow 
        :box (:line-width -2 ;neg. in order to keep the same size of lines
              :color "grey75"
              :style pressed-button)))) "Face for keystrokes"
        :group 'org-faces)

Następnie dostosuj org-emphasis-alist:

(("*" bold)
 ("/" italic)
 ("_" underline)
 ("=" org-code verbatim)
 ("~" org-verbatim verbatim)
 ("+"
  (:strike-through t))
 ("‰" my-face-org-keystroke verbatim));This line is what you want to add

Na eksport, może być konieczne, aby załadować ox.elz (require 'ox).

Wtedy za każdym razem, boldczy codepojawia się w funkcji (w ox-org.el), I stworzyli podobną funkcję (lub zmian istniejących):

;creation
(defun org-html-keystroke (keystroke contents info)
  "Transcode KEYSTROKE from Org to HTML.
CONTENTS is nil.  INFO is a plist holding contextual
information."
  (format (or (cdr (assq 'my-object-keystroke org-html-text-markup-alist)) "%s")
          (org-html-encode-plain-text (org-element-property :value keystroke))))


;creation
(defun org-element-my-object-keystroke-parser ()
  "Parse code object at point.

Return a list whose CAR is `my-object-keystroke' and CDR is a plist with
`:value', `:begin', `:end' and `:post-blank' keywords.

Assume point is at the first tilde marker."
  (interactive)
  (save-excursion
    (unless (bolp) (backward-char 1))
    (looking-at org-emph-re)
    (let ((begin (match-beginning 2))
          (value (org-match-string-no-properties 4))
          (post-blank (progn (goto-char (match-end 2))
                             (skip-chars-forward " \t")))
          (end (point)))
      (list 'my-object-keystroke
            (list :value value
                  :begin begin
                  :end end
                  :post-blank post-blank)))))

;creation
(defun org-element-my-object-keystroke-interpreter (keystroke contents)
  "Interpret KEYSTROKE object as Org syntax.
CONTENTS is nil."
  (format "‰%s‰" (org-element-property :value keystroke)))


;modification
(defconst org-element-object-successor-alist
  '((subscript . sub/superscript) (superscript . sub/superscript)
    (bold . text-markup) (code . text-markup) (italic . text-markup)
    (strike-through . text-markup) (underline . text-markup)
    (verbatim . text-markup) (entity . latex-or-entity)
    (latex-fragment . latex-or-entity) (my-object-keystroke . text-markup))
  "Alist of translations between object type and successor name.
Sharing the same successor comes handy when, for example, the
regexp matching one object can also match the other object.")

;modification
(defconst org-element-all-objects
  '(bold code entity export-snippet footnote-reference inline-babel-call
         inline-src-block italic line-break latex-fragment link macro
         radio-target statistics-cookie strike-through subscript superscript
         table-cell target timestamp underline verbatim my-object-keystroke)
  "Complete list of object types.")


;modification
(defun org-element-text-markup-successor ()
  "Search for the next text-markup object.

Return value is a cons cell whose CAR is a symbol among `bold',
`italic', `underline', `strike-through', `code' and `verbatim'
and CDR is beginning position."
  (save-excursion
    (unless (bolp) (backward-char))
    (when (re-search-forward org-emph-re nil t)
      (let ((marker (match-string 3)))
        (cons (cond
               ((equal marker "*") 'bold)
               ((equal marker "/") 'italic)
               ((equal marker "_") 'underline)
               ((equal marker "+") 'strike-through)
               ((equal marker "~") 'code)
               ((equal marker "=") 'verbatim)
               ((equal marker "‰") 'my-object-keystroke) 
               (t (error "Unknown marker at %d" (match-beginning 3))))
              (match-beginning 2))))))

Następnie zdefiniowałem my-htmlbackend dla eksportu:

(org-export-define-derived-backend 'my-html 'html
  :translate-alist '((my-object-keystroke . org-html-keystroke))
  :menu-entry ' (?h 1
                    ((?r "my-html"  org-html-export-to-my-html))))

(defun org-html-export-to-my-html
  (&optional async subtreep visible-only body-only ext-plist)
  "Export current buffer to a HTML file.

Return output file's name."
  (interactive)
  (let* ((extension (concat "." org-html-extension))
         (file (org-export-output-file-name extension subtreep))
         (org-export-coding-system org-html-coding-system))
    (org-export-to-file 'my-html file
      async subtreep visible-only body-only ext-plist)))


(defun org-html-publish-to-my-html (plist filename pub-dir)
  "Publish an org file to my-html.
Return output file name."
  (org-publish-org-to 'my-html filename
                      (concat "." (or (plist-get plist :html-extension)
                                      org-html-extension "html"))
                      plist pub-dir))

(defun org-html-convert-region-to-my-html ()
  "Assume the current region has org-mode syntax, and convert it to HTML.
This can be used in any buffer.  For example, you can write an
itemized list in org-mode syntax in an HTML buffer and use this
command to convert it."
  (interactive)
  (org-export-replace-region-by 'my-html))

Więc kiedy korzystam C-c C-e h r, jest poprawnie eksportowany:

wprowadź opis zdjęcia tutaj

wprowadź opis zdjęcia tutaj

wprowadź opis zdjęcia tutaj

Jak sugeruje OP w komentarzach, może być konieczne użycie org-mode-restart(lub org-reload) lub zabicie / przeładowanie bufora.


Edycja: Działa w trybie org z wersjami wcześniejszymi niż 8.3 (czyli do 8.2.10)

W przypadku wersji ≥8.3.1 muszę zmodyfikować

  • org-element-all-objects
  • ewentualnie ograniczenia elementu org
  • element-org - set-regexps
  • org-element - obiekt-leks

i oczywiście nadal dodaj funkcje

  • org-element-my-object-keystroke-parser
  • org-element-mój-obiekt-interpretator klawiszy

ale

  • org-element-object-sukcesor-alist
  • org-element-text-znacznik-następca

są teraz usuwane.

Dzięki Charles C. Berry za pomoc.

fredtantini
źródło
Czy %marker jest wbudowany? Nie mogę zmusić go do współpracy z najnowszą organizacją. Jeśli chodzi o inne znaczniki, działa dobrze, jeśli zmienię ich twarze. Ale czy istnieje sposób, aby naprawdę dodać własne markery? Niemniej twoja odpowiedź jest przydatna.
Tu Do
%nie jest obecnie używany jako marker. Możesz go używać tak samo, jak ja . Nie rozumiem jednak twojego drugiego pytania, to nowy marker.
fredtantini,
Ok, udało mi się uruchomić %marker, ale musiałem biec org-reload. Powinieneś zaktualizować odpowiedź za pomocą tego polecenia.
Tu Do
Właściwie nie potrzebujemy, org-reloadale org-mode-restart. Chodzi o to, że musimy zabić poprzedni bufor organizacji i utworzyć nowy, aby zmiana zaczęła obowiązywać.
Tu Do
Dzięki za wskazówki. Zaktualizowałem swoją odpowiedź. Cieszę się, że mogłem pomóc
fredtantini,
0

Nie sądzę, że można dodawać znaczniki dla nowych opcji znaczników w trybie organizacji.

Zgodnie z tym postem z 2012 r . Wygląda na to, że „znaczniki nacisku org-mode będą zakodowane na stałe”. Robi szybkie wyszukiwanie org-emph-rew org.elnie ujawnia żadnego kodu, które faktycznie generuje org-emph-reod org-emphasis-alist. Na podstawie tego wygląda na to, że org-emph-renie będzie szukał niczego, co dodasz org-emphasis-alist.

Jest to zgodne z moim doświadczeniem (mogę przedefiniować istniejące znaczniki emphasis, ale nie mógł get org-mode do uznania |lub &czy H).

Nie jestem tutaj ekspertem i chciałbym dowiedzieć się, że się mylę :)

MikeTheTall
źródło
1
Po prostu edycja org-emphasis-alistnie doda nowego znacznika. Musisz też dodatkowo pracować org-font-lock-extra-keywords. Ta odpowiedź daje działające rozwiązanie.
Dean Seo
Hej, to działa! Przynajmniej osiąga ten sam efekt! :) Kiedy się używa, org-font-lock-extra-keywordswtedy wcale nie trzeba zmieniać org-emphasis-alist, oczywiście (dodałem org-font-lock...kod, ale nie zmieniłem mojego org-emphasis-alisti teraz wszystko jest formatowane)
MikeTheTall