Import the latest scripts from vim-jp/vimdoc-ja-working

Author: k-takata

Makefile

@@ -8,10 +8,8 @@ html:
 	if [ ! -d vim/runtime/doc ]; then git clone --depth=1 https://github.com/vim/vim.git; fi
 	if [ ! -d vim_faq/doc ]; then git clone --depth=1 https://github.com/chrisbra/vim_faq.git; fi
 	cd vim; git apply ../tools/add-vimfaq-link.diff; cd ..
-	cp vim/runtime/doc/*.txt target/html/doc
-	cp vim_faq/doc/*.txt target/html/doc
-	cp tools/buildhtml.vim tools/makehtml.vim target/html
-	-cd target/html/doc ; vim --cmd "set rtp^=../../../tools" -eu ../buildhtml.vim -c "qall!"
+	cp vim/runtime/doc/*.txt vim_faq/doc/*.txt target/html/doc
+	-cd target/html/doc ; vim -eu ../../../tools/buildhtml.vim -c "qall!"
 
 clean:
 	rm -rf target

tools/buildhtml.vim

@@ -8,11 +8,18 @@ let g:html_no_progress = 1
 
 enew!
 
+source <sfile>:h/tag_aliases.vim
+source <sfile>:h/untranslated.vim
 source <sfile>:h/makehtml.vim
 
+let s:tools_dir = expand('<sfile>:p:h')
+let s:proj_dir = expand('<sfile>:p:h:h')
+
 function! s:main()
+  " for the lastest help syntax
+  let &runtimepath = s:tools_dir . ',' . &runtimepath
   " for ja custom syntax
-  let &runtimepath .= ',' . expand('<sfile>:p:h')
+  let &runtimepath .= ',' . s:proj_dir
   call s:BuildHtml()
 endfunction
 

tools/makehtml.vim

@@ -12,18 +12,23 @@
 " Usage:
 "   :cd doc
 "   :helptags .
-"   :source mkhtml.vim
+"   :source makehtml.vim
 "   :call MakeHtmlAll()
 
-function! MakeHtmlAll()
+if !exists('g:makehtml_external_taglinks')
+  let g:makehtml_external_taglinks = {}
+end
+
+function! MakeHtmlAll(...)
+  let conceal = get(a:000, 0, 1)  " Enable concealing by default.
   let s:log = []
   call MakeTagsFile()
   echo ""
   let files = split(glob('*.??[tx]'), '\n')
   for i in range(len(files))
     let file = files[i]
     echon printf("%d/%d %s -> %s", i+1, len(files), files[i], s:HtmlName(files[i]))
-    call MakeHtml(file)
+    call MakeHtml(file, conceal)
     echon " *DONE*"
     echo ""
   endfor
@@ -58,13 +63,13 @@ function! MakeTagsFile()
   endfor
 endfunction
 
-function! MakeHtml(fname)
-  let r = MakeHtml2(a:fname, s:HtmlName(a:fname))
+function! MakeHtml(fname, conceal)
+  let r = MakeHtml2(a:fname, s:HtmlName(a:fname), a:conceal)
   silent quit!
   return r
 endfunction
 
-function! MakeHtml2(src, dst)
+function! MakeHtml2(src, dst, conceal)
   silent new `=a:src`
 
   " 2html options
@@ -83,7 +88,7 @@ function! MakeHtml2(src, dst)
   silent! call tohtml#Convert2HTML(1, line('$'))
 
   let lang = s:GetLang(a:src)
-  silent %s@<span class="\(helpHyperTextEntry\|helpHyperTextJump\|helpOption\|helpCommand\)">\([^<]*\)</span>@\=s:MakeLink(lang, submatch(1), submatch(2))@ge
+  silent %s@<span class="\(helpHyperTextEntry\|helpHyperTextJump\|helpOption\|helpCommand\)">\([^<]*\)</span>@\=s:MakeLink(lang, submatch(1), submatch(2), a:conceal)@ge
   silent %s@^<span class="Ignore">&lt;</span>\ze&nbsp;@\&nbsp;@ge
   silent %s@<span class="\(helpStar\|helpBar\|Ignore\)">[^<]*</span>@@ge
   call s:TranslateHelpExampleBlock()
@@ -146,21 +151,28 @@ function! s:Footer()
   call append(search('^</body', 'wn') - 1, footer)
 endfunction
 
-function! s:MakeLink(lang, hlname, tagname)
+function! s:MakeLink(lang, hlname, tagname, conceal)
   let tagname = a:tagname
   let tagname = substitute(tagname, '&lt;', '<', 'g')
   let tagname = substitute(tagname, '&gt;', '>', 'g')
   let tagname = substitute(tagname, '&amp;', '\&', 'g')
-  if a:hlname == "helpHyperTextEntry"
-    let sep = "*"
-  elseif a:hlname == "helpHyperTextJump"
-    let sep = "|"
-  elseif a:hlname == "helpCommand"
-    let sep = "`"
-  elseif a:hlname == "helpOption"
+  if a:conceal
     let sep = ""
+  else
+    if a:hlname == "helpHyperTextEntry"
+      let sep = "*"
+    elseif a:hlname == "helpHyperTextJump"
+      let sep = "|"
+    elseif a:hlname == "helpCommand"
+      let sep = "`"
+    elseif a:hlname == "helpOption"
+      let sep = ""
+    endif
   endif
   let tags = s:GetTags(a:lang)
+  if !has_key(tags, tagname) && has_key(g:makehtml_tag_aliases, tagname)
+    let tagname = g:makehtml_tag_aliases[tagname]
+  endif
   if has_key(tags, tagname)
     let href = tags[tagname]["html"]
     if tagname !~ '\.txt$' && tagname != "help-tags"
@@ -192,6 +204,9 @@ function! s:MakeLink(lang, hlname, tagname)
     elseif a:hlname == "helpCommand"
       " Don't use MissingTag class for a command.
       let res = printf('<span class="%s">%s%s%s</span>', s:attr_save[a:hlname], sep, a:tagname, sep)
+    elseif has_key(g:makehtml_external_taglinks, a:tagname)
+      let url = g:makehtml_external_taglinks[a:tagname]
+      let res = printf('<a class="ExternalTaglink" href="%s">%s%s%s</a>', url, sep, a:tagname, sep)
     else
       let res = printf('<span class="MissingTag">%s%s%s</span>', sep, a:tagname, sep)
     endif

tools/tag_aliases.vim

@@ -0,0 +1,3 @@
+let g:makehtml_tag_aliases = {
+  \ '=~': 'expr-=~',
+  \ }