Syntax Highlighting Themes for HTML #179

ramnathv · 2012-03-25T15:46:49Z

I made some modifications to the file themes.R so that syntax highlighting themes work for html output as well. I tested it and it works. There is a lot of scope to refactor the code here, but for now I focused on keeping the changes to a minimal.

Let me know when you have a chance to review the code and pull in the changes.

yihui · 2012-03-25T19:21:09Z

inst/themes/.knitr.css

+	background-color: #fdf6e3;
+    border-style:solid;
+    border-width:1px;
+    border-color: #B0B0B0;


these 3 lines can be merged as border: solid 1px #B0B0B0;

yihui · 2012-03-25T19:26:48Z

this looks pretty good; I'll be happy to merge it after you made the small change above

you can also try to refactor the code as you wish; thanks a lot!

ramnathv · 2012-03-25T20:03:27Z

I made the changes. I also reverted the background-color to the light gray that was used as the default before.

ramnathv · 2012-03-25T21:27:56Z

I did not realize that these changes would be added to the pull request as well. I just refactored the code. Let me know if you want to pull these as well, or you will be able to selectively pull the user-visible changes first and pull these after you have had a chance to review.

yihui · 2012-03-26T02:27:33Z

I can wait until you finish the work; at least I have not seen knitr.sty yet.

My original plan for #140 was to write the header into a separate file in the last step in insert_header() in header.R, so I do not actually need to move the text into a file beforehand.

yihui · 2012-03-26T02:29:01Z

R/header.R

-\\makeatother
+## COMMIT: move .header.framed to a style file of its own so that it can be  ##         included or copied directly to the tex file
+.knit.sty      <- system.file('misc', 'knitr.sty', package = 'knitr')  
+.header.framed <- paste(readLines(.knit.sty), collapse = "\n")


I'm not sure if this really works, because the code will be run before knitr is installed, i.e. there is no knitr.sty at that time.

Good point. The alternative would be to move these lines directly inside the functions that use them. That way, they would be invoked only after knitr is installed.

ramnathv · 2012-03-26T03:41:35Z

I like the idea of pulling the headers into a style file in case of latex or a css file in case of html. I think you should provide users two options. Option 1 would be status quo, where the headers are included directly in the document making it standalone. Option 2 would be to put the header in an external file and include it in the parent document.

On a different note, I think it would be useful if you can add an option highlight.theme that would take a theme name as input. This would simplify the code considerably,as you can set the default theme based on the output format (for example default for html and edit-eclipse for latex) and not have to deal with special cases.

Let me know if you think this might be a good idea. If you think it is, and you agree with the two options, I can put together a patch addressing this and send you a pull request. If you think other ways of doing it might be better, do let me know so that we agree on a specification before further work.

…installing.

yihui · 2012-03-27T03:37:41Z

R/hooks.R

+	}
+  if (!nzchar(h['highlight'])) {
+		# header for Latex Syntax Highlighting
+		.header.hi.tex = paste(theme_to_header_latex('edit-eclipse')$highlight, 


why is edit-eclipse the default theme for LaTeX output?

This is the default that you had used previously. I remember reading a note of yours sometime, where you indicated that you found the colors of the default highlight theme too flashy for pdfs.

Yes I think I mentioned it at some time, but I'm not actually using edit-eclipse. The default theme has a light gray background, and the background of edit-eclipse is white.

In that event, I will create a default.latex.css theme which has the gray background.

Actually I do not see much gain of moving the two objects .header.framed and .header.hi.tex to two files respectively; I mean they are simply string constants and it is probably not worth it to read and write through extra files. At the end of the day, they will be concatenated in insert_header(), and that will be the time to write the header into a separate file if opts_knit$get('self.contained') == TRUE.

First, to some extent it is a style issue, since I don't prefer latex and other markups contaminating my R code. Second, these are just defaults. So pulling them inside default files helps keep the code clean without cluttering them up with a lot of if.. else statements. For instance, if we implement highlight.style as an option, you can set it to default and the headers would automatically correspond to them. Just my two cents :-)

OK, .header.hi.tex can go to a file like default.css. For .header.framed, I'd rather leave it as is at the moment.

yihui · 2012-03-27T03:47:00Z

You can add include to opts_knit, but is there a better name? It might be confusing because it is also in opts_chunk.

For highlight.theme, I guess it is not of high priority, so let's put it aside at the moment.

ramnathv · 2012-03-27T13:02:34Z

It might be a bad idea to use include since it is already an option in opts_chunk. I am thinking of mimicking pandoc and using the option self_contained which is TRUE by default implying headers are directly contained in the document. It is the same reason why I think adding highlight_style as an option would be neat.

The use case for these options is that very often I generate multiple versions of my document, and I don't want to be tampering with the base document. I know, I can use knit_theme$set(), but it is an extra function to remember. Is there any reason you think adding highlight_style as a global option is a bad idea?

yihui · 2012-03-28T02:31:02Z

I think self.contained and highlight.style are good to be put in opts_knit.

ramnathv · 2012-04-09T23:56:59Z

I have made the changes to get (a) syntax highlighting in html and (b) allowing the header to be written to an external file using opts_knit$set(self.contained = TRUE).

You will notice a few commits involving addition/removal of hooks for reSt files. The reason is that I wanted to do a few more tests before adding them. I was thinking that for the purposes of easier maintenance, it might make sense to write a sister package knitrExtra which can contain user contributed hooks. If you think it is a good idea, I can set up a github repository for knitrExtra. Let me know.

ramnathv · 2012-04-09T23:59:43Z

On a different note, I think there might be an opportunity to refactor the overall code of knitr significantly. One idea is to use S3 methods. For instance, if you set the class of a document to its output format, it would be easier to extend knitr by adding generic functions pat, render, make_header, insert_header etc.

Let me know what you think.

yihui · 2012-04-11T19:33:57Z

Oops... I made some changes to header.R and hooks.R, and this pull request cannot be automatically merged now. Is it possible for you to pull my changes and resolve the conflicts? Sorry for the trouble.

Regarding S3 methods, you can experiment with it after this pull request or do it in another branch. Thanks!

Conflicts: R/hooks.R

ramnathv · 2012-04-11T20:15:47Z

Done! You should be able to pull this now. Let me know if you still find some conflicts.

yihui · 2012-04-11T22:10:53Z

It looks good now. I will take a look tonight. Thanks!

Syntax Highlighting Themes for HTML

vsbuffalo · 2012-05-19T00:29:34Z

Is there an option to turn on these HTML themes with knit2html()?

ramnathv · 2012-05-19T01:21:37Z

No. But you can do it by using knit_theme$set('acid') in your document, where acid is the theme name. You can also decide whether you want to keep the stylesheet as a part of the html file, or an external css file.

yihui · 2012-05-21T20:51:07Z

currently themes only work for LaTeX and HTML output; knit2html() is essentially for markdown, so these themes do not apply

if you want different themes for markdown-->html, you probably need to write your own css depending on which converter you use (sundown, pandoc, ...)

I have seen your own tweak on twitter which looks very nice!

ramnathv added 4 commits March 25, 2012 11:37

make highlighting themes work with html too

3fe593e

make render_html respect knit_theme highlight settings

e1281fd

add default.css to support default theme

55378ef

add .knitr.css to define knitr classes for highlighting in html

15cbc81

yihui reviewed Mar 25, 2012
View reviewed changes

minor changes to .knitr.css

df1fbd3

ramnathv added 5 commits March 25, 2012 16:44

add TODOs to refactor .header.hi.html and .header.hi.tex

8c8ce62

add background to default css

09505a1

use header_to_theme_xxx to generate default highlight headers

8ba2e9f

move latex header to knitr.sty and read .header.framed from there

131ed42

move .header.hi.xxx to themes.R

8757069

yihui reviewed Mar 26, 2012
View reviewed changes

ramnathv added 7 commits March 25, 2012 23:46

move definition of .header.hi.tex inside render_latex

dc49e76

move .header.hi.html inside render_html where it is used

4502202

move .header.framed inside render_latex so that it is not run before …

e6171eb

…installing.

move definitions in .header.framed to style file knitr.sty

9114783

Merge remote branch 'upstream/master'

68cf44b

add .Rproj.user to .*ignore files

c06ce2b

add misc folder and knitr.Rroj to gitignore

797ef9e

yihui reviewed Mar 27, 2012
View reviewed changes

yihui mentioned this pull request Mar 28, 2012

Possible Bug: Unable to get dev = c('png', 'pdf') working #181

Closed

add graphicx package

bcc05cf

ramnathv added 12 commits March 30, 2012 17:17

make code for get_theme() more explicit

21cf811

add experimental hooks for reStructuredText

96d14ef

add myhooks.R to collate

7742977

export render_rst and hook_plot_rst

d31f0bc

Merge remote branch 'upstream/master'

8958918

modify insert_header to allow writing header to external file

46481d3

remove graphicx from list of packages loaded

a57e1dd

remove <style..> </style> from header to allow writing to external file

0d8f95e

adjust spacing in css file

f3324e3

remove myhooks from DESCRIPTION

af4f62e

remove hooks for rst to do more extensive tests

efb1a11

remove rst hooks to do more extensive tests

6780ba6

yihui added a commit that referenced this pull request Apr 11, 2012

revert changes in header.R to see if auto merge of #179 is possible now

4158e02

ramnathv added 3 commits April 11, 2012 15:51

add self.contained = TRUE as default in opts_knit

a6e95c3

Merge remote branch 'upstream/master'

289619e

Conflicts: R/hooks.R

Merge remote branch 'upstream/master'

67ae3a0

allow ```{r} fixes #195

56ab698

yihui added a commit that referenced this pull request Apr 12, 2012

Merge pull request #179 from ramnathv/master

6aa2d1f

Syntax Highlighting Themes for HTML

yihui merged commit 6aa2d1f into yihui:master Apr 12, 2012

yihui added a commit that referenced this pull request Apr 12, 2012

news about highlighting themes for HTML output (#179)

d90b9f6

github-actions bot locked as resolved and limited conversation to collaborators Nov 10, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Syntax Highlighting Themes for HTML #179

Syntax Highlighting Themes for HTML #179

ramnathv commented Mar 25, 2012

yihui Mar 25, 2012

yihui commented Mar 25, 2012

ramnathv commented Mar 25, 2012

ramnathv commented Mar 25, 2012

yihui commented Mar 26, 2012

yihui Mar 26, 2012

ramnathv Mar 26, 2012

ramnathv commented Mar 26, 2012

yihui Mar 27, 2012

ramnathv Mar 27, 2012

yihui Mar 28, 2012

ramnathv Mar 28, 2012

yihui Mar 28, 2012

ramnathv Mar 28, 2012

yihui Mar 28, 2012

yihui commented Mar 27, 2012

ramnathv commented Mar 27, 2012

yihui commented Mar 28, 2012

ramnathv commented Apr 9, 2012

ramnathv commented Apr 9, 2012

yihui commented Apr 11, 2012

ramnathv commented Apr 11, 2012

yihui commented Apr 11, 2012

vsbuffalo commented May 19, 2012

ramnathv commented May 19, 2012

yihui commented May 21, 2012

Syntax Highlighting Themes for HTML #179

Syntax Highlighting Themes for HTML #179

Conversation

ramnathv commented Mar 25, 2012

Choose a reason for hiding this comment

yihui commented Mar 25, 2012

ramnathv commented Mar 25, 2012

ramnathv commented Mar 25, 2012

yihui commented Mar 26, 2012

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ramnathv commented Mar 26, 2012

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yihui commented Mar 27, 2012

ramnathv commented Mar 27, 2012

yihui commented Mar 28, 2012

ramnathv commented Apr 9, 2012

ramnathv commented Apr 9, 2012

yihui commented Apr 11, 2012

ramnathv commented Apr 11, 2012

yihui commented Apr 11, 2012

vsbuffalo commented May 19, 2012

ramnathv commented May 19, 2012

yihui commented May 21, 2012