API:EPrints/Latex - Revision history

Pod2wiki at 00:51, 12 January 2022

2022-01-12T00:51:44Z

← Older revision		Revision as of 00:51, 12 January 2022
Line 1:		Line 1:
	[[Category: ~~Rubbish~~]]		<!-- Pod2Wiki=_preamble_
			This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
			-->{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/Latex.pm\|package_name=EPrints::Latex}}[[Category:API\|LATEX]]<div><!-- Edit below this comment -->


			<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
			==NAME==
			'''EPrints::Latex''' - Module for handling rendering latex equations in metadata as images.

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=head_description -->
			==DESCRIPTION==
			Some repositories may want to spot latex style equations in titles and abstracts and render these as images instead. This module provides that functionality.

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=head_methods -->
			==METHODS==
			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=item_render_string -->
			===render_string===

			$xhtml = EPrints::Latex::render_string( $session, $field, $value )
			This function is intended to be passed by reference to the render_single_value property of a metadata field. It returns just an XHTML DOM string unless it spots anything which looks like a latex style equation, if so the equation is replaced with and img element, the URL of which is a CGI script which will render the equation as an image.

			For example the equation

			$x = \frac{-b_+_^-^\root{b^2^-4ac}}{2a}$

			is the quadratic equation. If you're not a physics academic then that probably dosn't mean much to you, but that's how the physics community like to write their equations!

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=item_texstring_to_png -->
			===texstring_to_png===

			$imgfile = EPrints::Latex::texstring_to_png( $session, $texstring )
			Returns the location of a PNG image file containing the latex fragment <tt>$texstring</tt>.

			This uses a directory to generate and cache the images. So the system only has to go to the effort of rendering any equation once. The directory is <tt>latexcache</tt> in the htdocs directory of the repository.

			The filename of the cached png is the md5 of the latex equation as a string of hex characters.

			The images always have a white background.

			This uses the rather obvious system of creating a LaTeX file with <tt>$texstring</tt> in, running <tt>latex</tt> on it, running <tt>dvips</tt> on the resulting DVI file to get a postscript file of a page with the equation in the corner. Then uses GNU <tt>convert</tt> to crop the PostScript file and turn it into a PNG.

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=head_copyright -->
			==COPYRIGHT==
			{{API:Copyright}}
			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Kgoetz: adding Category:Rubbish, page was emptied 9 years ago and has been untouched since

2018-10-03T00:29:51Z

adding Category:Rubbish, page was emptied 9 years ago and has been untouched since

← Older revision	Revision as of 00:29, 3 October 2018
Line 1:	Line 1:
		[[Category: Rubbish]]

Tdb01r: Removing all content from page

2009-08-12T15:40:47Z

Removing all content from page

← Older revision		Revision as of 15:40, 12 August 2009
Line 1:		Line 1:
	~~<!-- Pod2Wiki=_preamble_~~
	~~This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.~~
	~~-->{{Pod2Wiki}}{{API:Source\|file=EPrints/Latex.pm\|package_name=EPrints::Latex}}[[Category:API\|Latex]]<!-- End of Pod2Wiki -->~~
	~~<!-- Pod2Wiki=head_name -->=NAME=~~
	~~'''EPrints::Latex''' - Module for handling rendering latex equations in metadata as images.~~

	~~<!-- End of Pod2Wiki -->~~
	~~<!-- Pod2Wiki=head_description -->=DESCRIPTION=~~
	~~Some repositories may want to spot latex style equations in titles and abstracts and render these as images instead. This module provides that functionality.~~

	~~<!-- End of Pod2Wiki -->~~
	~~<!-- Pod2Wiki=item_render_string -->==render_string==~~

	~~$xhtml = EPrints::Latex::render_string( $session, $field, $value )~~

	This function is intended to be passed by reference to the render_single_value property of a metadata field. It returns just an XHTML DOM string unless it spots anything which looks like a latex style equation, if so the equation is replaced with and img element, the URL of which is a CGI script which will render the equation as an image.

	~~For example the equation~~

	~~$x = \frac{-b_+_^-^\root{b^2^-4ac}}{2a}$~~

	~~is the quadratic equation. If you're not a physics academic then that probably dosn't mean much to you, but that's how the physics community like to write their equations!~~

	~~<!-- End of Pod2Wiki -->~~
	~~<!-- Pod2Wiki=item_texstring_to_png -->==texstring_to_png==~~

	~~$imgfile = EPrints::Latex::texstring_to_png( $session, $texstring )~~

	~~Return the location of a PNG image file containing the latex fragment $texstring.~~

	This uses a directory to generate and cache the images. So the system only has to go to the effort of rendering any equation once. The directory is "latexcache" in the htdocs directory of the repository.

	~~The filename of the cached png is the md5 of the latex equation as a string of hex characters.~~

	~~The images always have a white background.~~

	This uses the rather obvious system of creating a latex file with $texstring in, running latex on it, running dvips on the resulting dvi file to get a postscript file of a page with the equation in the corner. Then uses GNU convert crop the postscript and turn it into a PNG.

	~~<!-- End of Pod2Wiki -->~~
	~~<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->~~

API:EPrints/Latex - Revision history

Pod2wiki at 00:51, 12 January 2022

Kgoetz: adding Category:Rubbish, page was emptied 9 years ago and has been untouched since

Tdb01r: Removing all content from page

Tdb01r: New page: