updating md-help info

Author: Detlef Groth

doc/me.smd

@@ -1069,7 +1069,7 @@
   [info-on(3)](info-on(3)) Display Info on a given topic  
   [list-buffers(2)](list-buffers(2)) (C-x C-b) List all buffers and show their status  
   [osd-help(3)](osd-help(3)) GUI based on-line help  
-  [rdoc(3)](rdoc(3)) Display R function and package manual pages  
+  [r-doc(3)](r-doc(3)) Display R function and package manual pages  
 
 !! me-id: amicr021
 !   Operating Modes
@@ -2093,7 +2093,7 @@
   [quote-char(2)](quote-char(2)) (C-q) Insert literal character  
   [rcs-file(2)](rcs-file(2)) (C-x C-q) Handle Revision Control System (RCS) files  
   [rdiff(3)](rdiff(3)) Recursively compare files or directories  
-  [rdoc(3)](rdoc(3)) Display R function and package manual pages  
+  [r-doc(3)](r-doc(3)) Display R function and package manual pages  
   [read-file(2)](read-file(2)) (C-x C-r) Find and load file replacing current buffer  
   [read-registry(2)](read-registry(2)) Read in a registry definition file  
   [read-session(3)](read-session(3)) Read in session information  
@@ -2616,7 +2616,7 @@
   [query-replace-all-string(3)](query-replace-all-string(3)) Query replace string in a list of files  
   [query-replace-string-in-files(3)](query-replace-string-in-files(3)) Conditionally search and replace strings  across files  
   [rdiff(3)](rdiff(3)) Recursively compare files or directories  
-  [rdoc(3)](rdoc(3)) Display R function and package manual pages  
+  [r-doc(3)](r-doc(3)) Display R function and package manual pages  
   [read-session(3)](read-session(3)) Read in session information  
   [replace-all-pairs(3)](replace-all-pairs(3)) Replace string pairs in a list of files  
   [replace-all-string(3)](replace-all-string(3)) Replace string with new string in a list of files  
@@ -3766,7 +3766,7 @@
   [rc(9)](rc(9)) Microsoft Developer resource file  
   [rcs-file(2)](rcs-file(2)) (C-x C-q) Handle Revision Control System (RCS) files  
   [rdiff(3)](rdiff(3)) Recursively compare files or directories  
-  [rdoc(3)](rdoc(3)) Display R function and package manual pages  
+  [r-doc(3)](r-doc(3)) Display R function and package manual pages  
   [read-file(2)](read-file(2)) (C-x C-r) Find and load file replacing current buffer  
   [read-registry(2)](read-registry(2)) Read in a registry definition file  
   [read-session(3)](read-session(3)) Read in session information  
@@ -20253,11 +20253,19 @@ $a
         !ehelp
 
   Please note that the header  characters  `##` must be at the  beginning of the
-  line.
+  line. For code blocks you just indent everything with at least 8 spaces at the
+  beginning of the line. If you would like to show short fragments of MicroEmacs
+  macro code you should place this code in fenced code blocks like this:
+  
+       ```emf
+             macro code
+       ```
 
+  The backtick code fences must as well like the headers begin at the first character
+  on the documentation line.
+  
 ## SEE ALSO
 
-
   [ehf(8)](ehf(8)), [help-item(2)](help-item(2)), [define-macro(2)](define-macro(2)), [help-command(2)](help-command(2)), [help-variable(2)](help-variable(2)).
 !! me-id: m2cmd094
 ! 2 forward-paragraph
@@ -26272,8 +26280,8 @@ $a
      a start-up hook command. File names and extensions are bound to a set
      of macro hooks in a space separated list e.g.
 
-            [add-file-hook](add-file-hook(2)) "c cpp" "fhook-cmode"
-            [add-file-hook](add-file-hook(2)) "doc txt README" "fhook-doc"
+     >  [add-file-hook](add-file-hook(2)) "c cpp" "fhook-cmode"  
+        [add-file-hook](add-file-hook(2)) "doc txt README" "fhook-doc"
 
   >  The space separated list of names are interpreted as either file
      extensions or filenames. In this case any file with the extension __.c__,
@@ -26298,8 +26306,8 @@ $a
      hooks, except instead of defining a file extension the location and
      text content of the identifier is defined:
 
-            1 [add-file-hook](add-file-hook(2)) "#!/bin/sh" "fhook-shell"
-            1 [add-file-hook](add-file-hook(2)) "#!/usr/local/bin/wish" "fhook-tcl"
+     >  1 [add-file-hook](add-file-hook(2)) "#!/bin/sh" "fhook-shell"  
+        1 [add-file-hook](add-file-hook(2)) "#!/usr/local/bin/wish" "fhook-tcl"
 
   >  In this case, any file that commences with "__#!/bin/sh__" is interpreted
      as a shell script and invokes the shell hook __fhook-shell__. Where the
@@ -26308,7 +26316,7 @@ $a
      magic sting should be search for without [exact(2m)](exact(2m)) mode then the
      argument should be negated, e.g.
 
-            -4 add-file-hook "<html>" "fhook-html"
+        -4 add-file-hook "<html>" "fhook-html"
 
   >  invokes __fhook-html__ whenever "`<html>`", "`<HTML>`" etc. is found in the
      first 4 lines of a file header, e.g.:
@@ -43354,17 +43362,17 @@ $a
 
   [scheme-editor(3)](scheme-editor(3))
 !! me-id: m3mac099
-! 3 rdoc
+! 3 r-doc
 ## NAME
 
 
-|rdoc
-  rdoc - display documentation for R functions and packages
+|r-doc
+  r-doc - display documentation for R functions and packages
 $a
 
 ## SYNOPSIS
 
-  __rdoc__ ["package::function|function"]
+  __r-doc__ ["package::function|function"]
 
 ## DESCRIPTION
 
@@ -43374,16 +43382,16 @@ $a
 
 ## EXAMPLE
 
-       rdoc "plot"
-       rdoc "cluster::pam"
+       r-doc "plot"
+       r-doc "cluster::pam"
 
 ## NOTES
 
-  __rdoc__ macro is defined in file `hkrdoc.emf`.
+  __r-doc__ macro is defined in file `hkrdoc.emf`.
 
 ## SEE ALSO
 
-  [scheme-editor(3)](scheme-editor(3))
+  [r(9)](r(9))
 !! me-id: m3osd000
 ! 3 user-setup
 ## NAME

jasspa/macros/hkehf.emf

@@ -8,6 +8,7 @@
 ;
 set-char-mask "2" "-$&#!%:@."
 
+
 define-macro fhook-ehf
     set-variable $buffer-mask "luh12"
     @# buffer-init "ehf"
@@ -77,21 +78,20 @@ set-variable .fhook-ehf.command-desc  "|\HGoto Link|Move to \HPrevious Link|Move
     hilight .hilight.ehfL 0x80 "\\}\elm" .hilight.ehf $global-scheme
     hilight .hilight.ehfL 0x40 "." ""                 $global-scheme
     ; support for Markdown as define-help markup
-    hilight .hilight.ehf 0xc0 "^## NAME" "NAME" .hilight.ehfM .scheme.header  ; Markdown start
-    0 hilight  .hilight.ehfM 2 50                      $global-scheme
-    
-    hilight .hilight.ehfM 0x44 "^## "  "" "\n" "" ""      .scheme.header
-    hilight .hilight.ehfM 0x44 "^      "  "      " "\n" "" ""      .scheme.keyword
-    hilight .hilight.ehfM 0x44 " __" " " "__" "" ""       .scheme.bold  ; bold  
-    hilight .hilight.ehfM 0x44 " _" " " "_" "" ""       .scheme.italic  ; italic    
-    hilight .hilight.ehfM 0x44 " `" " " "`" "" ""       .scheme.keyword  ; code
-    hilight .hilight.ehfM 0x44 "```emf" "\ecB" "```" "\ecA" "" .scheme.keyword  ; code
-    hilight .hilight.ehfM 4  "\"" "\"" "\\"           .scheme.string
-    ;hilight .hilight.ehf 0x44 "`" "" "`" "" ""       .scheme.underline  ; code
+    0 hilight  .hilight.ehfM 2 50                              $global-scheme
+    hilight .hilight.ehf  0xc0  "^## NAME" "NAME"              .hilight.ehfM  .scheme.header  ; Markdown start
+    hilight .hilight.ehfM 0x44  "^## "  "" "\n" "" ""          .scheme.header
+    hilight .hilight.ehfM 0x44 "^        "  "        " "\n" "" ""  .scheme.keyword
+    hilight .hilight.ehfM 0x44 " __" " " "__" "" ""            .scheme.bold  ; bold  
+    hilight .hilight.ehfM 0x44 " _" " " "_" "" ""              .scheme.italic  ; italic    
+    hilight .hilight.ehfM 0x44 " `" " " "`" "" ""              .scheme.keyword  ; code
+    hilight .hilight.ehfM 4  "\"" "\"" "\\"                    .scheme.string
     hilight .hilight.ehfM 0x44 "\\[\\[" "" "\\]\\]" "" ""      .scheme.link  ; italic      
-    hilight .hilight.ehfM 0xc0 "" "" .hilight.ehf $global-scheme
-    hilight .hilight.ehfM 0xc0 "```emf" "" .hilight.ehfB  $global-scheme
-    hilight .hilight.ehfB 0xc0 "```" ""   .hilight.ehfM   $global-scheme
+    hilight .hilight.ehfM 0xc0 "" ""       .hilight.ehf $global-scheme
+    hilight .hilight.ehfM 0x44 "```emf" "\ecB" "```" "\ecA" "" .scheme.keyword  ; code
+    hilight .hilight.ehfM 0xc0 "```emf" "" .hilight.ehfB       .scheme.hidden
+    hilight .hilight.ehfB 0xc0 "```" ""    .hilight.ehfM       .scheme.hidden
+    hilight .hilight.ehfM 2    "```"                           .scheme.hidden ; seems not to work
 !endif
 
 ; Advance to the next link in the forward direction

jasspa/macros/hkrdoc.emf

@@ -22,19 +22,18 @@ set-variable .fhook-rdoc.setup-mask "acfhmw"
 !if &and &sin "h" .fhook-rdoc.setup &band .hilight.flags 0x02
   !iif &not &exi .hilight.rdoc  set-variable .hilight.rdoc &pinc .hilight.next 1
   !iif &not &exi .hilight.rdocL  set-variable .hilight.rdocL &pinc .hilight.next 1  
-  0 hilight .hilight.rdoc 0                 .scheme.text
-  0 hilight .hilight.rdocL 0                 .scheme.text  
-  hilight .hilight.rdoc 2 "^_"               .scheme.header
-  hilight .hilight.rdocL 4 "'" "'" "\\"    .scheme.link
-  hilight .hilight.rdoc 2 "^[A-Z]"            .scheme.header
-  ;hilight .hilight.rdoc 2 "^ +[a-z]+:"         .scheme.keyword  
+  0 hilight .hilight.rdoc 0                   .scheme.text
+  0 hilight .hilight.rdocL 0                  .scheme.text  
+  hilight .hilight.rdoc  2    "^_"            .scheme.header
+  hilight .hilight.rdoc  2    "^[A-Z]"        .scheme.header
   !iif &not &exi ".hilight.r"  !force execute-file "hkr"
-  hilight .hilight.rdoc 0x80 "^[A-Z].+"  .hilight.rdoc .scheme.header
-  hilight .hilight.rdoc 0x80 "^See Also:"  .hilight.rdocL .scheme.header  
-  hilight .hilight.rdoc 0x80 "^Usage:"  .hilight.r .scheme.header
-  hilight .hilight.rdoc 0x80 "^Examples:"  .hilight.r .scheme.header  
-  hilight .hilight.r 0x80 "^Arguments:"  .hilight.rdoc  .scheme.header
-  hilight .hilight.rdocL 0x80 "^Examples:"  .hilight.r  .scheme.header
+  hilight .hilight.rdoc  0x80 "^See Also:"    .hilight.rdocL .scheme.header  
+  hilight .hilight.rdoc  0x80 "^Usage:"       .hilight.r     .scheme.header
+  hilight .hilight.rdoc  0x80 "^Examples:"    .hilight.r     .scheme.header  
+  hilight .hilight.r     0x80 "^[A-Z].+"      .hilight.rdoc  .scheme.header
+  hilight .hilight.r     0x80 "^Arguments:"   .hilight.rdoc  .scheme.header
+  hilight .hilight.rdocL 4    "'" "'" "\\"    .scheme.link
+  hilight .hilight.rdocL 0x80 "^Examples:"    .hilight.r     .scheme.header
 !endif
 
 !if &sin "f" .fhook-rdoc.setup
@@ -44,7 +43,7 @@ set-variable .fhook-rdoc.setup-mask "acfhmw"
   set-variable .fhook-rdoc.collapse-mnext "-1"
 !endif
 
-define-macro rdoc
+define-macro r-doc
   !force set-variable #l0 @1
   !if &not $status
     set-variable #l0 @ml00 "R help on"
@@ -56,7 +55,7 @@ define-macro rdoc
       set-variable #l1 &spr "help('%s')" #l1
   !endif
   0 pipe-shell-command &spr "LANG=en_US Rscript -e \"%s\"" #l1 "*rdoc*"
-  set-variable :mouse-word-select rdoc-process-link
+  set-variable :mouse-word-select r-doc-process-link
   -1 buffer-mode "view"
   beginning-of-buffer
   3 kill-line
@@ -69,7 +68,7 @@ define-macro rdoc
   !endif
 !emacro    
 
-0 define-macro rdoc-process-link
+0 define-macro r-doc-process-link
   ;set-variable $debug 3
   set-variable #l0 $window-col
   set-variable #l1 $window-line
@@ -96,7 +95,7 @@ define-macro rdoc
             copy-region
             set-variable #l6 @y
             -1 yank
-            rdoc #l6
+            r-doc #l6
           !endif
         !endif
       !endif

jasspa/macros/me.ehf

@@ -1163,7 +1163,7 @@ Miscellaneous Information
     lsinfo-on(3)lminfo-on(3)le Display Info on a given topic  
     lslist-buffers(2)lmlist-buffers(2)le (C-x C-b) List all buffers and show their status  
     lsosd-help(3)lmosd-help(3)le GUI based on-line help  
-    lsrdoc(3)lmrdoc(3)le Display R function and package manual pages  
+    lsr-doc(3)lmr-doc(3)le Display R function and package manual pages  
 
 !   Operating Modes
 cEcEOPERATING MODES cEcA
@@ -2176,7 +2176,7 @@ Miscellaneous Information
     lsquote-char(2)lmquote-char(2)le (C-q) Insert literal character  
     lsrcs-file(2)lmrcs-file(2)le (C-x C-q) Handle Revision Control System (RCS) files  
     lsrdiff(3)lmrdiff(3)le Recursively compare files or directories  
-    lsrdoc(3)lmrdoc(3)le Display R function and package manual pages  
+    lsr-doc(3)lmr-doc(3)le Display R function and package manual pages  
     lsread-file(2)lmread-file(2)le (C-x C-r) Find and load file replacing current buffer  
     lsread-registry(2)lmread-registry(2)le Read in a registry definition file  
     lsread-session(3)lmread-session(3)le Read in session information  
@@ -2698,7 +2698,7 @@ Miscellaneous Information
     lsquery-replace-all-string(3)lmquery-replace-all-string(3)le Query replace string in a list of files  
     lsquery-replace-string-in-files(3)lmquery-replace-string-in-files(3)le Conditionally search and replace strings  across files  
     lsrdiff(3)lmrdiff(3)le Recursively compare files or directories  
-    lsrdoc(3)lmrdoc(3)le Display R function and package manual pages  
+    lsr-doc(3)lmr-doc(3)le Display R function and package manual pages  
     lsread-session(3)lmread-session(3)le Read in session information  
     lsreplace-all-pairs(3)lmreplace-all-pairs(3)le Replace string pairs in a list of files  
     lsreplace-all-string(3)lmreplace-all-string(3)le Replace string with new string in a list of files  
@@ -3845,7 +3845,7 @@ Miscellaneous Information
     lsrc(9)lmrc(9)le Microsoft Developer resource file  
     lsrcs-file(2)lmrcs-file(2)le (C-x C-q) Handle Revision Control System (RCS) files  
     lsrdiff(3)lmrdiff(3)le Recursively compare files or directories  
-    lsrdoc(3)lmrdoc(3)le Display R function and package manual pages  
+    lsr-doc(3)lmr-doc(3)le Display R function and package manual pages  
     lsread-file(2)lmread-file(2)le (C-x C-r) Find and load file replacing current buffer  
     lsread-registry(2)lmread-registry(2)le Read in a registry definition file  
     lsread-session(3)lmread-session(3)le Read in session information  
@@ -20066,11 +20066,19 @@ $a
           !ehelp
 
     Please note that the header  characters  cG##cA must be at the  beginning of the
-    line.
+    line. For code blocks you just indent everything with at least 8 spaces at the
+    beginning of the line. If you would like to show short fragments of MicroEmacs
+    macro code you should place this code in fenced code blocks like this:
+    
+         ```emf
+               macro code
+         ```
 
+    The backtick code fences must as well like the headers begin at the first character
+    on the documentation line.
+    
 cESEE ALSO cA
 
-
     lsehf(8)lmehf(8)le, lshelp-item(2)lmhelp-item(2)le, lsdefine-macro(2)lmdefine-macro(2)le, lshelp-command(2)lmhelp-command(2)le, lshelp-variable(2)lmhelp-variable(2)le.
 ! 2 forward-paragraph
 ! 2 backward-paragraph
@@ -25971,8 +25979,8 @@ $a
        a start-up hook command. File names and extensions are bound to a set
        of macro hooks in a space separated list e.g.
 
-              [add-file-hook](add-file-hook(2)) "c cpp" "fhook-cmode"
-              [add-file-hook](add-file-hook(2)) "doc txt README" "fhook-doc"
+       >  [add-file-hook](add-file-hook(2)) "c cpp" "fhook-cmode"  
+          [add-file-hook](add-file-hook(2)) "doc txt README" "fhook-doc"
 
        The space separated list of names are interpreted as either file
        extensions or filenames. In this case any file with the extension cD.ccA,
@@ -25997,8 +26005,8 @@ $a
        hooks, except instead of defining a file extension the location and
        text content of the identifier is defined:
 
-              1 [add-file-hook](add-file-hook(2)) "#!/bin/sh" "fhook-shell"
-              1 [add-file-hook](add-file-hook(2)) "#!/usr/local/bin/wish" "fhook-tcl"
+       >  1 [add-file-hook](add-file-hook(2)) "#!/bin/sh" "fhook-shell"  
+          1 [add-file-hook](add-file-hook(2)) "#!/usr/local/bin/wish" "fhook-tcl"
 
        In this case, any file that commences with "cD#!/bin/shcA" is interpreted
        as a shell script and invokes the shell hook cDfhook-shellcA. Where the
@@ -26007,7 +26015,7 @@ $a
        magic sting should be search for without lsexact(2m)lmexact(2m)le mode then the
        argument should be negated, e.g.
 
-              -4 add-file-hook "<html>" "fhook-html"
+          -4 add-file-hook "<html>" "fhook-html"
 
        invokes cDfhook-htmlcA whenever cGcG<html>cAcA, cGcG<HTML>cAcA etc. is found in the
        first 4 lines of a file header, e.g.:
@@ -42776,17 +42784,17 @@ $a
 cESEE ALSO cA
 
     lsscheme-editor(3)lmscheme-editor(3)le
-! 3 rdoc
+! 3 r-doc
 cEcENAME cEcA
 
 
-|rdoc
-    rdoc - display documentation for R functions and packages
+|r-doc
+    r-doc - display documentation for R functions and packages
 $a
 
 cESYNOPSIS cA
 
-    cDrdoccA ["package::function|function"]
+    cDr-doccA ["package::function|function"]
 
 cEDESCRIPTION cA
 
@@ -42796,16 +42804,16 @@ $a
 
 cEEXAMPLE cA
 
-         rdoc "plot"
-         rdoc "cluster::pam"
+         r-doc "plot"
+         r-doc "cluster::pam"
 
 cENOTES cA
 
-    cDrdoccA macro is defined in file cGhkrdoc.emfcA.
+    cDr-doccA macro is defined in file cGhkrdoc.emfcA.
 
 cESEE ALSO cA
 
-    lsscheme-editor(3)lmscheme-editor(3)le
+    lsr(9)lmr(9)le
 ! 3 user-setup
 cEcENAME cEcA
 

jasspa/macros/me.emf

@@ -71,7 +71,7 @@ define-macro-file mail mail mail-check stop-mail-check
 define-macro-file fileopen osd-file-open osd-get-file
 define-macro-file spellaut auto-spell auto-spell-menu
 define-macro-file hkinfo info info-on info-goto-link
-define-macro-file hkrdoc rdoc
+define-macro-file hkrdoc r-doc
 define-macro-file zfile find-zfile zfile-setup
 define-macro-file gentags generate-tags-file
 define-macro-file dmf display-matching-fence
@@ -311,6 +311,7 @@ add-file-hook ".md .rmd .Rmd .tmd .Tmd"                       fhook-md
  1 add-file-hook "^#![ \t]*/.*\\(wish\\|tclsh\\)"              fhook-tcl    ; tcl, tk & tix files
  1 add-file-hook "^#![ \t]*/.*awk"               fhook-awk    ; awk scripts
  1 add-file-hook "^#![ \t]*/.*python"            fhook-python ; Python file
+ 1 add-file-hook "^#![ \t]*/.*Rscript"           fhook-r      ; Rscript file
  1 add-file-hook "^#![ \t]*/.*ruby"              fhook-ruby   ; Ruby shell script
  1 add-file-hook "^#![ \t]*/.*make"              fhook-make   ; Make script
  4 add-file-hook "^[ \t]*exec[ \t]*\\(wish\\|tclsh\\)" fhook-tcl ; TCL shell script