Skip to content
Snippets Groups Projects
Commit 349b2fb0 authored by Bram Moolenaar's avatar Bram Moolenaar
Browse files

Improved version of 2html.vim. 

Includes progress bar.
Fix dynamic folding in diff view.
(Benjamin Fritz)
parent 0ba04296
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
runtime/autoload/tohtml.vim
+ 148
− 17
View file @ 349b2fb0
" Vim autoload file for the tohtml plugin. " Vim autoload file for the tohtml plugin.
" Maintainer: Bram Moolenaar <Bram@vim.org> " Maintainer: Ben Fritz <fritzophrenic@gmail.com>
" Last Change: 2010 Jul 11 " Last Change: 2010 Jul 15
" "
" Diff2HTML() added by Christian Brabandt <cb@256bit.org> " Additional contributors:
"
" Original by Bram Moolenaar <Bram@vim.org>
" Diff2HTML() added by Christian Brabandt <cb@256bit.org>
"
" See Mercurial change logs for more!
" this file uses line continuations
let s:cpo_sav = &cpo
set cpo-=C
func! tohtml#Convert2HTML(line1, line2) func! tohtml#Convert2HTML(line1, line2)
if !&diff || exists("g:diff_one_file") let old_vals = tohtml#OverrideUserSettings()
if !&diff || exists("g:html_diff_one_file")
if a:line2 >= a:line1 if a:line2 >= a:line1
let g:html_start_line = a:line1 let g:html_start_line = a:line1
let g:html_end_line = a:line2 let g:html_end_line = a:line2
...@@ -17,27 +28,34 @@ func! tohtml#Convert2HTML(line1, line2) ...@@ -17,27 +28,34 @@ func! tohtml#Convert2HTML(line1, line2)
else else
let win_list = [] let win_list = []
let buf_list = [] let buf_list = []
windo | if (&diff) | call add(win_list, winbufnr(0)) | endif windo | if &diff | call add(win_list, winbufnr(0)) | endif
let save_hwf = exists("g:html_whole_filler") let save_hwf = exists("g:html_whole_filler")
let g:html_whole_filler = 1 let g:html_whole_filler = 1
let g:html_diff_win_num = 0
for window in win_list for window in win_list
exe ":" . bufwinnr(window) . "wincmd w" exe ":" . bufwinnr(window) . "wincmd w"
let g:html_start_line = 1 let g:html_start_line = 1
let g:html_end_line = line('$') let g:html_end_line = line('$')
let g:html_diff_win_num += 1
runtime syntax/2html.vim runtime syntax/2html.vim
call add(buf_list, bufnr('%')) call add(buf_list, bufnr('%'))
"exec '%s#<span id=''\zsfold\d\+\ze''#win'.win_num.'\0#ge'
endfor endfor
unlet g:html_diff_win_num
if !save_hwf if !save_hwf
unlet g:html_whole_filler unlet g:html_whole_filler
endif endif
call tohtml#Diff2HTML(win_list, buf_list) call tohtml#Diff2HTML(win_list, buf_list)
endif endif
call tohtml#RestoreUserSettings(old_vals)
unlet g:html_start_line unlet g:html_start_line
unlet g:html_end_line unlet g:html_end_line
endfunc endfunc
func! tohtml#Diff2HTML(win_list, buf_list) func! tohtml#Diff2HTML(win_list, buf_list)
" TODO: add logic for xhtml
let style = [] let style = []
let html = [] let html = []
call add(html, '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"') call add(html, '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"')
...@@ -45,12 +63,14 @@ func! tohtml#Diff2HTML(win_list, buf_list) ...@@ -45,12 +63,14 @@ func! tohtml#Diff2HTML(win_list, buf_list)
call add(html, '<html>') call add(html, '<html>')
call add(html, '<head>') call add(html, '<head>')
call add(html, '<title>diff</title>') call add(html, '<title>diff</title>')
call add(html, '<meta name="Generator" content="Vim/7.3">') call add(html, '<meta name="Generator" content="Vim/'.v:version/100.'.'.v:version%100.'">')
"call add(html, '<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">') " TODO: copy or move encoding logic from 2html.vim so generated markup can
" validate without warnings about encoding
call add(html, '</head>') call add(html, '</head>')
call add(html, '<body>') call add(html, '<body>')
call add(html, '<table border="1" width="100%">') call add(html, '<table border="1" width="100%">')
"call add(html, '<font face="monospace">')
call add(html, '<tr>') call add(html, '<tr>')
for buf in a:win_list for buf in a:win_list
call add(html, '<th>'.bufname(buf).'</th>') call add(html, '<th>'.bufname(buf).'</th>')
...@@ -61,6 +81,10 @@ func! tohtml#Diff2HTML(win_list, buf_list) ...@@ -61,6 +81,10 @@ func! tohtml#Diff2HTML(win_list, buf_list)
let temp = [] let temp = []
exe bufwinnr(buf) . 'wincmd w' exe bufwinnr(buf) . 'wincmd w'
" If text is folded because of user foldmethod settings, etc. we don't want
" to act on everything in a fold by mistake.
setlocal nofoldenable
" Grab the style information. Some of this will be duplicated... " Grab the style information. Some of this will be duplicated...
1 1
let style_start = search('^<style type="text/css">') let style_start = search('^<style type="text/css">')
...@@ -78,12 +102,15 @@ func! tohtml#Diff2HTML(win_list, buf_list) ...@@ -78,12 +102,15 @@ func! tohtml#Diff2HTML(win_list, buf_list)
let temp = getline(1,'$') let temp = getline(1,'$')
" undo deletion of start and end part " undo deletion of start and end part
" so we can later save the file as valid html " so we can later save the file as valid html
" TODO: restore using grabbed lines if undolevel is 1?
normal 2u normal 2u
call add(html, '<td nowrap valign="top">') call add(html, '<td nowrap valign="top"><div>')
let html += temp let html += temp
call add(html, '</td>') call add(html, '</div></td>')
" Close this buffer " Close this buffer
" TODO: the comment above says we're going to allow saving the file
" later...but here we discard it?
quit! quit!
endfor endfor
...@@ -94,18 +121,122 @@ func! tohtml#Diff2HTML(win_list, buf_list) ...@@ -94,18 +121,122 @@ func! tohtml#Diff2HTML(win_list, buf_list)
let i = 1 let i = 1
let name = "Diff" . ".html" let name = "Diff" . ".html"
" Find an unused file name if current file name is already in use
while filereadable(name) while filereadable(name)
let name = substitute(name, '\d*\.html$', '', '') . i . ".html" let name = substitute(name, '\d*\.html$', '', '') . i . ".html"
let i += 1 let i += 1
endw endwhile
exe "new " . name exe "topleft new " . name
set modifiable setlocal modifiable
" just in case some user autocmd creates content in the new buffer, make sure
" it is empty before proceeding
%d
call append(0, html) call append(0, html)
if len(style) > 0 if len(style) > 0
1 1
let style_start = search('^</head>') let style_start = search('^</head>')-1
call append(style_start, '</style>')
call append(style_start, style) " Insert javascript to toggle matching folds open and closed in all windows,
call append(style_start, '<style type="text/css">') " if dynamic folding is active.
if exists("g:html_dynamic_folds")
call append(style_start, [
\ "<script type='text/javascript'>",
\ " <!--",
\ " function toggleFold(objID)",
\ " {",
\ " for (win_num = 1; win_num <= 2; win_num++)",
\ " {",
\ " var fold;",
\ ' fold = document.getElementById("win"+win_num+objID);',
\ " if(fold.className == 'closed-fold')",
\ " {",
\ " fold.className = 'open-fold';",
\ " }",
\ " else if (fold.className == 'open-fold')",
\ " {",
\ " fold.className = 'closed-fold';",
\ " }",
\ " }",
\ " }",
\ " -->",
\ "</script>"
\ ])
endif
" Insert styles from all the generated html documents and additional styles
" for the table-based layout of the side-by-side diff. The diff should take
" up the full browser window (but not more), and be static in size,
" horizontally scrollable when the lines are too long. Otherwise, the diff
" is pretty useless for really long lines.
if exists("g:html_use_css")
call append(style_start, [
\ '<style type="text/css">']+
\ style+[
\ '<!--',
\ 'table { table-layout: fixed; }',
\ 'html, body, table, tbody { width: 100%; margin: 0; padding: 0; }',
\ 'th, td { width: '.printf("%.1f",100.0/len(a:win_list)).'%; }',
\ 'td div { overflow: auto; }',
\ '-->',
\ '</style>'
\ ])
endif
endif
endfunc
func! tohtml#OverrideUserSettings()
let old_settings = {}
" make copies of the user-defined settings that we may overrule
let old_settings.html_dynamic_folds = exists("g:html_dynamic_folds")
let old_settings.html_hover_unfold = exists("g:html_hover_unfold")
let old_settings.html_use_css = exists("g:html_use_css")
" hover opening implies dynamic folding
if exists("g:html_hover_unfold")
let g:html_dynamic_folds = 1
endif endif
" dynamic folding with no foldcolumn implies hover opens
if exists("g:html_dynamic_folds") && exists("g:html_no_foldcolumn")
let g:html_hover_unfold = 1
endif
" ignore folding overrides dynamic folding
if exists("g:html_ignore_folding") && exists("g:html_dynamic_folds")
unlet g:html_dynamic_folds
endif
" dynamic folding implies css
if exists("g:html_dynamic_folds")
let g:html_use_css = 1
endif
return old_settings
endfunc endfunc
func! tohtml#RestoreUserSettings(old_settings)
" restore any overridden user options
if a:old_settings.html_dynamic_folds
let g:html_dynamic_folds = 1
else
unlet! g:html_dynamic_folds
endif
if a:old_settings.html_hover_unfold
let g:html_hover_unfold = 1
else
unlet! g:html_hover_unfold
endif
if a:old_settings.html_use_css
let g:html_use_css = 1
else
unlet! g:html_use_css
endif
endfunc
let &cpo = s:cpo_sav
unlet s:cpo_sav
" Make sure any patches will probably use consistent indent
" vim: sw=2 sts=2 et
runtime/doc/syntax.txt
+ 29
− 24
View file @ 349b2fb0
...@@ -380,51 +380,58 @@ Source the script to convert the current file: > ...@@ -380,51 +380,58 @@ Source the script to convert the current file: >
:runtime! syntax/2html.vim :runtime! syntax/2html.vim
< <
Warning: This is slow!
*:TOhtml* *:TOhtml*
Or use the ":TOhtml" user command. It is defined in a standard plugin. Or use the ":TOhtml" user command. It is defined in a standard plugin.
":TOhtml" also works with a range and in a Visual area: > ":TOhtml" also works with a range and in a Visual area: >
:10,40TOhtml :10,40TOhtml
Warning: This is slow! The script must process every character of every line.
Because it is so slow, by default a progress bar is displayed in the
statusline for each step that usually takes a long time. If you don't like
seeing this progress bar, you can disable it and get a very minor speed
improvement with: >
let g:html_no_progress = 1
":TOhtml" has another special feature: if the window is in diff mode, it will ":TOhtml" has another special feature: if the window is in diff mode, it will
generate HTML that shows all the related windows. This can be disabled by generate HTML that shows all the related windows. This can be disabled by
setting the g:diff_one_file variable: > setting the g:html_diff_one_file variable: >
let g:diff_one_file = 1 let g:html_diff_one_file = 1
After you save the resulting file, you can view it with any browser. The After you save the resulting file, you can view it with any browser. The
colors should be exactly the same as you see them in Vim. colors should be exactly the same as you see them in Vim.
To restrict the conversion to a range of lines set "html_start_line" and To restrict the conversion to a range of lines, use a range with the |:TOhtml|
"html_end_line" to the first and last line to be converted. Example, using command, or set "g:html_start_line" and "g:html_end_line" to the first and
the last set Visual area: > last line to be converted. Example, using the last set Visual area: >
:let html_start_line = line("'<") :let g:html_start_line = line("'<")
:let html_end_line = line("'>") :let g:html_end_line = line("'>")
The lines are numbered according to 'number' option and the Number The lines are numbered according to 'number' option and the Number
highlighting. You can force lines to be numbered in the HTML output by highlighting. You can force lines to be numbered in the HTML output by
setting "html_number_lines" to non-zero value: > setting "html_number_lines" to non-zero value: >
:let html_number_lines = 1 :let g:html_number_lines = 1
Force to omit the line numbers by using a zero value: > Force to omit the line numbers by using a zero value: >
:let html_number_lines = 0 :let g:html_number_lines = 0
Go back to the default to use 'number' by deleting the variable: > Go back to the default to use 'number' by deleting the variable: >
:unlet html_number_lines :unlet g:html_number_lines
By default, HTML optimized for old browsers is generated. If you prefer using By default, HTML optimized for old browsers is generated. If you prefer using
cascading style sheets (CSS1) for the attributes (resulting in considerably cascading style sheets (CSS1) for the attributes (resulting in considerably
shorter and valid HTML 4 file), use: > shorter and valid HTML 4 file), use: >
:let html_use_css = 1 :let g:html_use_css = 1
Closed folds are put in the HTML as they are displayed. If you don't want Closed folds are put in the HTML as they are displayed. If you don't want
this, use the |zR| command before invoking 2html, or use: > this, use the |zR| command before invoking 2html, or use: >
:let html_ignore_folding = 1 :let g:html_ignore_folding = 1
You may want to generate HTML that includes all the data within the folds, and You may want to generate HTML that includes all the data within the folds, and
allow the user to view the folded data similar to how they would in Vim. To allow the user to view the folded data similar to how they would in Vim. To
generate this dynamic fold information, use: > generate this dynamic fold information, use: >
:let html_dynamic_folds = 1 :let g:html_dynamic_folds = 1
Using html_dynamic_folds will imply html_use_css, because it would be far too Using html_dynamic_folds will imply html_use_css, because it would be far too
difficult to do it for old browsers. However, html_ignore_folding overrides difficult to do it for old browsers. However, html_ignore_folding overrides
...@@ -435,7 +442,7 @@ similar to Vim's foldcolumn, that will use javascript to open and close the ...@@ -435,7 +442,7 @@ similar to Vim's foldcolumn, that will use javascript to open and close the
folds in the HTML document. The width of this foldcolumn starts at the current folds in the HTML document. The width of this foldcolumn starts at the current
setting of |'foldcolumn'| but grows to fit the greatest foldlevel in your setting of |'foldcolumn'| but grows to fit the greatest foldlevel in your
document. If you do not want to show a foldcolumn at all, use: > document. If you do not want to show a foldcolumn at all, use: >
:let html_no_foldcolumn = 1 :let g:html_no_foldcolumn = 1
Using this option, there will be no foldcolumn available to open the folds in Using this option, there will be no foldcolumn available to open the folds in
the HTML. For this reason, another option is provided: html_hover_unfold. the HTML. For this reason, another option is provided: html_hover_unfold.
...@@ -446,7 +453,7 @@ included to fall back to the normal CSS1 code so that the folds show up ...@@ -446,7 +453,7 @@ included to fall back to the normal CSS1 code so that the folds show up
correctly for this browser, but they will not be openable without a correctly for this browser, but they will not be openable without a
foldcolumn. Note that using html_hover_unfold will allow modern browsers with foldcolumn. Note that using html_hover_unfold will allow modern browsers with
disabled javascript to view closed folds. To use this option, use: > disabled javascript to view closed folds. To use this option, use: >
:let html_hover_unfold = 1 :let g:html_hover_unfold = 1
Setting html_no_foldcolumn with html_dynamic_folds will automatically set Setting html_no_foldcolumn with html_dynamic_folds will automatically set
html_hover_unfold, because otherwise the folds wouldn't be dynamic. html_hover_unfold, because otherwise the folds wouldn't be dynamic.
...@@ -454,7 +461,7 @@ html_hover_unfold, because otherwise the folds wouldn't be dynamic. ...@@ -454,7 +461,7 @@ html_hover_unfold, because otherwise the folds wouldn't be dynamic.
By default "<pre>" and "</pre>" is used around the text. This makes it show By default "<pre>" and "</pre>" is used around the text. This makes it show
up as you see it in Vim, but without wrapping. If you prefer wrapping, at the up as you see it in Vim, but without wrapping. If you prefer wrapping, at the
risk of making some things look a bit different, use: > risk of making some things look a bit different, use: >
:let html_no_pre = 1 :let g:html_no_pre = 1
This will use <br> at the end of each line and use "&nbsp;" for repeated This will use <br> at the end of each line and use "&nbsp;" for repeated
spaces. spaces.
...@@ -462,20 +469,20 @@ The current value of 'encoding' is used to specify the charset of the HTML ...@@ -462,20 +469,20 @@ The current value of 'encoding' is used to specify the charset of the HTML
file. This only works for those values of 'encoding' that have an equivalent file. This only works for those values of 'encoding' that have an equivalent
HTML charset name. To overrule this set g:html_use_encoding to the name of HTML charset name. To overrule this set g:html_use_encoding to the name of
the charset to be used: > the charset to be used: >
:let html_use_encoding = "foobar" :let g:html_use_encoding = "foobar"
To omit the line that specifies the charset, set g:html_use_encoding to an To omit the line that specifies the charset, set g:html_use_encoding to an
empty string: > empty string: >
:let html_use_encoding = "" :let g:html_use_encoding = ""
To go back to the automatic mechanism, delete the g:html_use_encoding To go back to the automatic mechanism, delete the g:html_use_encoding
variable: > variable: >
:unlet html_use_encoding :unlet g:html_use_encoding
< <
For diff mode a sequence of more than 3 filler lines is displayed as three For diff mode a sequence of more than 3 filler lines is displayed as three
lines with the middle line mentioning the total number of inserted lines. If lines with the middle line mentioning the total number of inserted lines. If
you prefer to see all the inserted lines use: > you prefer to see all the inserted lines use: >
:let html_whole_filler = 1 :let g:html_whole_filler = 1
And to go back to displaying up to three lines again: > And to go back to displaying up to three lines again: >
:unlet html_whole_filler :unlet g:html_whole_filler
< <
*convert-to-XML* *convert-to-XHTML* *convert-to-XML* *convert-to-XHTML*
An alternative is to have the script generate XHTML (XML compliant HTML). To An alternative is to have the script generate XHTML (XML compliant HTML). To
...@@ -483,8 +490,6 @@ do this set the "use_xhtml" variable: > ...@@ -483,8 +490,6 @@ do this set the "use_xhtml" variable: >
:let use_xhtml = 1 :let use_xhtml = 1
To disable it again delete the variable: > To disable it again delete the variable: >
:unlet use_xhtml :unlet use_xhtml
The generated XHTML file can be used in DocBook XML documents. See:
http://people.mech.kuleuven.ac.be/~pissaris/howto/src2db.html
Remarks: Remarks:
- This only works in a version with GUI support. If the GUI is not actually - This only works in a version with GUI support. If the GUI is not actually
......
runtime/ftplugin/help.vim
+ 2
− 2
View file @ 349b2fb0
...@@ -11,9 +11,9 @@ let b:did_ftplugin = 1 ...@@ -11,9 +11,9 @@ let b:did_ftplugin = 1
let s:cpo_save = &cpo let s:cpo_save = &cpo
set cpo&vim set cpo&vim
let b:undo_ftplugin = "setl fo< tw<" let b:undo_ftplugin = "setl fo< tw< conc<"
setlocal formatoptions+=tcroql textwidth=78 setlocal formatoptions+=tcroql textwidth=78 conc=2
let &cpo = s:cpo_save let &cpo = s:cpo_save
unlet s:cpo_save unlet s:cpo_save
runtime/plugin/tohtml.vim
+ 7
− 3
View file @ 349b2fb0
" Vim plugin for converting a syntax highlighted file to HTML. " Vim plugin for converting a syntax highlighted file to HTML.
" Maintainer: Bram Moolenaar <Bram@vim.org> " Maintainer: Ben Fritz <fritzophrenic@gmail.com>
" Last Change: 2010 Jul 11 " Last Change: 2010 Jul 15
" "
" The core of the code is in $VIMRUNTIME/autoload/tohtml.vim " The core of the code is in $VIMRUNTIME/autoload/tohtml.vim and
" $VIMRUNTIME/syntax/2html.vim
" Define the :TOhtml command when: " Define the :TOhtml command when:
" - 'compatible' is not set " - 'compatible' is not set
...@@ -11,3 +12,6 @@ ...@@ -11,3 +12,6 @@
if !&cp && !exists(":TOhtml") && has("user_commands") if !&cp && !exists(":TOhtml") && has("user_commands")
command -range=% TOhtml :call tohtml#Convert2HTML(<line1>, <line2>) command -range=% TOhtml :call tohtml#Convert2HTML(<line1>, <line2>)
endif endif
" Make sure any patches will probably use consistent indent
" vim: ts=2 sw=2 sts=2 et
runtime/syntax/2html.vim
+ 371
− 170
View file @ 349b2fb0
This diff is collapsed.
runtime/syntax/help.vim
+ 3
− 3
View file @ 349b2fb0
...@@ -21,8 +21,8 @@ else ...@@ -21,8 +21,8 @@ else
syn match helpHyperTextEntry "\*[#-)!+-~]\+\*\s"he=e-1 contains=helpStar syn match helpHyperTextEntry "\*[#-)!+-~]\+\*\s"he=e-1 contains=helpStar
syn match helpHyperTextEntry "\*[#-)!+-~]\+\*$" contains=helpStar syn match helpHyperTextEntry "\*[#-)!+-~]\+\*$" contains=helpStar
endif endif
syn match helpBar contained "|" syn match helpBar contained "|" conceal
syn match helpStar contained "\*" syn match helpStar contained "\*" conceal
syn match helpNormal "|.*====*|" syn match helpNormal "|.*====*|"
syn match helpNormal ":|vim:|" " for :help modeline syn match helpNormal ":|vim:|" " for :help modeline
syn match helpVim "Vim version [0-9.a-z]\+" syn match helpVim "Vim version [0-9.a-z]\+"
...@@ -30,7 +30,7 @@ syn match helpVim "VIM REFERENCE.*" ...@@ -30,7 +30,7 @@ syn match helpVim "VIM REFERENCE.*"
syn match helpOption "'[a-z]\{2,\}'" syn match helpOption "'[a-z]\{2,\}'"
syn match helpOption "'t_..'" syn match helpOption "'t_..'"
syn match helpHeader "\s*\zs.\{-}\ze\s\=\~$" nextgroup=helpIgnore syn match helpHeader "\s*\zs.\{-}\ze\s\=\~$" nextgroup=helpIgnore
syn match helpIgnore "." contained syn match helpIgnore "." contained conceal
syn keyword helpNote note Note NOTE note: Note: NOTE: Notes Notes: syn keyword helpNote note Note NOTE note: Note: NOTE: Notes Notes:
syn match helpSpecial "\<N\>" syn match helpSpecial "\<N\>"
syn match helpSpecial "\<N\.$"me=e-1 syn match helpSpecial "\<N\.$"me=e-1
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment