NEWS
texor 1.5
Bug Fixes
- Fixed the path to search for DESCRIPTION file in a package directory.
- Moved clean up function to
on.exit()
instead of sequential execution.
texor 1.5.0 (2024-10-15)
Feature Updates
- Included CodeCov code coverage workflow closing issue #70.
- Included custom JavaScript for auto-numbering equations independent of
number_sections:
option, fixing issue #83 and issue #86.
- Optional automatic equation numbering with a custom pandoc Lua filter, fixing issue #68.
- New option to convert figures into R markdown code chunks instead of regular markdown syntax, somewhat fixing issue #80.
- New option to convert most table structures into a csv data file, which is included into the article using
kable()
in a code block.
- New option to suppress package start up messages in the generated document, fixing issue #81.
- New options for vignette output styles including
bookdown
,litedown
and biocstyle
, closing issue #76.
- Use of
pseudocodejs
for rendering Algorithm environment in the R markdown files, closing issue #69.
texor::rnw_to_rmd()
now also modifies the DESCRIPTION file (if available) with Dependency Suggests
and VignetteBuilder
if missing (#94)
Bug Fixes
- Fixed Issue #78 where references are not hyperlinked.
- Fixed Issue #67 where unlabeled tables were not numbered.
- Updated example Sweave file.
- Added support for some jss style LaTeX macros under issue #77.
- Partially fixed Issue #84 renaming bibliography file more appropriately.
- Fixed Issue #79 where
\vspace*{}
,\hspace*{}
are ignored.
- Removed
web_only
parameter from yaml front matter, adapting to changes in rjtools
package.
- Using updated
table_code_chunk
pandoc Lua filter, which preserves the table data more effectively, see supported types for more information.
texor::rnw_to_rmd()
: front_matter_type
parameter is now called output_format
with no defaults (#91).
- To support offline math in bookdown format,
math_method
option is now set to katex
(better for accessibility) by default, in case of equation numbering it is set to mathjax
(#92,#90).
- Fixed Relative Paths Issue in
texor::rnw_to_rmd()
(#93).
- VignetteEngine in bookdown format is now
knitr::rmarkdown
(#94).
- Removed excess
print()
statements from Lua Filters.
- If the figure/table referenced to a sweave code chunk is labelled with the prefix (
fig:
,tab:
,table:
) then the references will be transformed to bookdown style label.
texor 1.4.0
Feature Updates
- Initial Support for Sweave (.Rnw) article conversion.
- A new Hex-sticker for the package.
- Simplification of Readme file.
Bug Fixes
- Fixed Rd files with LaTeX like syntax to conform with recent R changes.
- Removed redundant comments regarding pandoc version checks from examples.
- Updates warning messages and notes in Rd section.
texor 1.3.0 (2023-09-27)
Feature Updates
- Equations are better handled and equation references are edited to match bookdown format.
- Knitting of Rmarkdown is now done outside the
temp
folder to avoid PDF compilation errors.
- Added workaround macros for
\nameref{}
and \autoref{}
.
- Added workaround macros for
\scalebox{}
, \fbox{}
, \adjustbox{}
, \framebox{}
.
- Option to set DPI when invoking
convert_to_png
function.
Bug Fixes
CodeBlocks
and WideTables
are now back to the original form.
Algorithm
get separate numbering in references.
- Removed unnecessary warnings.
- Better mechanism to remove leftover text after processing tikz.
- Package names using
\pkg{}
are now bold.
- Reduced DPI of raster images to reduce file sizes.
Algorithmic
not treated as figures.
- Fixes in lua filters for equation which now adds basic support for tabular and removes nested inline math.
- Fixing logic in table reference numbering.
Accessibility Feature Updates
- All images processed are set with a default alt-text : 'graphic without alt text'
texor 1.2.0
Feature Updates
CodeBlock
and WideTable
get their own numbering (but they share references with figures), Enhancement #51.
- added support for
\command{..}
macro.
- Included dummy
slug
and citation_url
, Issue #50.
- Included a constructor for sample article, Enhancement #52.
- Added support for
\file{}
,\var{}
,\env{}
,\option{}
,\dfn{}
, \cpkg{}
and \samp{}
macro.
- Asking user for Inputs in
interactive_mode
, Enhancement #53.
Bug Fixes
- Modified the workflow to avoid missing Images.
- Modified Lua filters to suppress numbering widetables in captions.
- Fixed Issue #49 where some text of algorithms were left behind.
- Updated pdf conversion functions with poppler version check and note in man pages.
- Fixed copying markdown files back in temp_mode.
- Set
unlink()
as on.exit()
function in temp_mode
- Removed table Numbering for images gridded in a table environment within a Figure environment.
texor 1.1.0
Feature Updates
- New mechanism to convert articles without wrapper files.
- Support for non-standard named RJwrapper files.
- Support for files with inclusive articles, however only articles included in the main article are included.
- Support for
smallexample
code environment
- Enhancement #47 : temporary mode for conversions to keep the original LaTeX article untouched.
- Bumped up pandoc version requirement from 2.17 to 3.1 (minimum), latest (recommended)
Bug Fixes
- Figure Environment wont be numbered if there is no Image in it.
- Now tikz images can be hot reloaded, no need to remove
\includegraphics{}
line manually.
- Fixed #46 where tikz style blocks would persist.
- Fixed #45 with Enhancement #47.
- Closed #41 momentarily.
- Default issue and year is now based on current date.
- Fixed #48 - in Lua filter added check for
DisplayMath
for equation numbering.
- Closed #40 as most of the issues have been fixed.
texor 1.0.5
Feature Updates
- A new Lua Filter to check for possible issues in LaTeX file during conversion
- New function to check multiple labels used in an environment
Bug Fixes
- Updated Image caption Lua filter which was broken by pandoc v3 (Figure update)
- Updated pkgdown website theme
- Fixed a Lua Filter to add extensions to some LaTeX Figure elements
texor 1.0.3 (2023-06-13)
Bug Fixes
- Fixed a test case where it was attempting to write in user-library.
texor 1.0.2 (2023-06-11)
Bug Fixes
- Added a pre-check before reading a file in
texor::check_markdown_file()
.
- Fixed a bug where empty lines could not be filtered out.
- Usage of
file.exists()
before actual readLines()
.
texor 1.0.1 (2023-06-08)
Feature Updates
- Algorithm figures are now numbered.
- Added
boxedverbatim
support for code environments.
- Included
web_only
parameter for embedding PDF or using Rmarkdown to produce HTML.
- Updated to MathJax Version3 and added
-tex_math_single_backslash
extension to pandoc for better math handling.
- Support for sample articles without the directory structure as required for RJ articles.
- Updated Instructions and examples (hence closing GitHub Issue #23).
- Updated contributor information.
- More examples and test cases.
- Pandoc Version checker for better compatibility and experience.
- Markdown checker for better compatibility and experience.
- CRAN release.
Bug Fixes
- Using
xfun::normalize_path()
instead of normalizePath()
for relative/absolute path handling
- Stream editor also works on algorithm environments.
- Fixed image sizing paramaters.
- New algorithm to find, convert and copy images appropriately.
- Fixed a bug where, if the
metadata$address
is missing then metadata$author
will be used as author name.
- Removes
RJournal.sty
file as it conflicts with inner workings of pandoc.
- Fixed file extension editing using
xfun::with_ext()
instead of gsub()
.
- More precise
title
and description
.
- Added rebib as a dependency given it is now available on cran(hence closing #38)
- Fixed bugs related to copying files and images (Github Issue #36 and #34)
texor 0.6.9
Feature Updates
- Added algorithm2e graphics support (beta) (GitHub Issue #32)
- Added tikz graphics support (GitHub Issue #7)
- Added automation workflow with a separate logger for logging success and failure of conversion.
Bug Fixes
- Fixing equation labeling issue with
, .
, _
in equations and also added
eq:
before equation starts if not present.
- Added support for relative paths
- Fixed bugs in figure parser with new regex.
- Fixed tikz lib extraction method
Deprecated Features
- Removing old bibliographic parser/converter from texor in favour of new
implementation in rebib which supports
many more features.
texor 0.6.7
Feature Updates
- Equation labeling and numbering
- Code/table/equation/figure pre-processors
- fixed many meta data related issues
- We now use Mathjax V3
- New testthat test cases
- pkgdown website
texor::latex_to_web()
for a single article
- new stat tools for some metrics and conversion coverage check
- environment/word count for pandoc convert
Bug Fixes
- Support for absolute paths
- Fixed a lot of logic errors
- Fixed incompatibilities
- removed unnecessary code and features
- R-CMD-check passing
- Github workflows should work now
- Improved stat filter which exports pre and post conversion stats yaml file
- namespaces in logger
- URL fix for non http:// web Links
- Figure max width : 100% extra option added to figures.
- fixed pre processing of tikz
- fixed problems in journal volume
- comment filter mechanism for latex
- improved lua filter for numbering and centering figures
- fixed slug issue
texor 0.5.9
Feature Updates
- Automated orchestration of conversion
- New stream editor in R
- Using stream editor instead of lua filter for code
- Using stream editor instead of GNU sed for table
- changes in lua filter for R code
- Using stream editor for figure environment patching
- Automatic fetching of volume and issue from folder
Bug Fixes
- Support for absolute paths fixed(in almost all functions)
- Fixed some logic errors
- Fixes in metafix.sty
texor 0.5.5
Update Highlights :
- Placeholder abstract text for articles missing abstract
\CRANpkg()
,\BIOpkg()
and CRAN_TASK_VIEWS
are supported
- Tables have numbering
- A new lua filter for numbering tables
- Patched Metafix.sty
- More vignettes
texor 0.5.2
This package matures at this point where almost all features are working, and soon will be ready for CRAN deployment.
The following are the features working:
- LaTeX macros such as
\pkg
,\CRANpkg
,\code
are supported.
- Reading Metadata from LaTeX file as well as DESCRIPTION.
- Reading bibliography from bibtex files and ignoring
\thebibliography
- A parser to read and convert inbuilt
\thebibliography
to bibtex
- Supports code environments like
Sinput
,Soutput
, example
,example*
,verbatim
with code highlight.
- Supports graphics included as PDF,PNG,JPG.
- Functions to convert PDF graphics to PNG.
- Almost all tables are converted with a few exceptions.
- Other things like citations,links,footnotes,math(limited) are also supported.