Add Math Support/Abstract: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
m (typos)
mNo edit summary
 
(11 intermediate revisions by 3 users not shown)
Line 2: Line 2:
Rationale
Rationale
---------
---------
I often wanted to have a tool that allows complicated layouts but still
I have often wanted a tool that allows complicated layouts but is still
is easy to use. This is exactly what scribus does. However for scientific
easy to use. This is exactly what Scribus does. However, for scientific
papers it lacks one main capability: Formulas. So I want to add these
papers it lacks one main capability: Formulas. So I want to add this feature
as my summer of code project. Interest in this improvement is expressed
as my Summer of Code project. Interest in this enhancement is expressed
by many people in the bug tracker [1][2], by Debian users [3] and it's  
by many people in the bug tracker[1][2] and by Debian users[3] and it's  
also in the projects roadmap [4].
also listed as a desirable feature in the Scribus roadmap[4].




Overview
Overview
--------
--------
The goal of this project is to add a easy to use math support to scribus.
The goal of this project is to add easy-to-use math support to Scribus.
As the task of writing a complete math typesetter is too large for SOC a  
As the task of writing a complete math typesetter is too large for SOC, a  
different approach is used. It is inspired by the Quark XPress(tm) plugin  
different approach is used. It is inspired by the Quark XPress(tm) plugin  
MATHSETTER [5]:
MATHSETTER[5]:


o Let the user enter LaTeX source either directly or more user friendly
o Let the user enter LaTeX source either directly or in a more user-friendly
   via an graphical editor
   way via a graphical editor.
o Apply a LaTeX template on this so the user only has to type the formula
o Apply a LaTeX template to this, so the user only has to type the formula
   and not a whole TeX document.
   and not a whole TeX document.
o Run LaTeX on this source.
o Run LaTeX on this source.
o Display LaTeX's output in a frame while still keeping the  
o Display LaTeX's output in a frame while still keeping the  
   (LaTeX-)formula as a property so the whole things stays editable.
   (LaTeX-)formula as a property, so the whole thing stays editable.


Use cases  
Use cases  
---------
---------
o Scientific posters  
o Scientific posters  
   It is very hard (if not even impossible) to create good-looking posters
   It is very hard (if not impossible) to create good-looking posters
   with LaTeX but it's easy to add formulas to LaTeX documents. On the other
   with LaTeX but it's easy to add formulas to LaTeX documents. On the other
   hand it's very easy to create good posters with scribus but a complicated
   hand it's very easy to create good posters with Scribus, but a complicated
   process is necessary to add just a single formula. The ability to use LaTeX  
   process is necessary to add just a single formula. The ability to use LaTeX  
   for typesetting the formula and the post-processing it in scribus (easily
   for typesetting the formula and then post-processing it in Scribus (easily
   possible, after all it's just a vector graphic from scribus' point of view)
   possible, after all it's just a vector graphic from Scribus' point of view)
   would greatly simplify this.  
   would greatly simplify this.  


o Math/Physics teachers  
o Math/Physics teachers  
   At school I've seen a lot of teachers that created their tests with Microsoft
   At school, I've seen a lot of teachers who created their tests with Microsoft
   Word and relying on its formula editor or even on basic text formatting
   Word and relied on its formula editor or even on basic text formatting
   (sub-/superscript) and adding any "complicated" math symbols (vectors,
   (sub-/superscript). They added any "complicated" math symbols (vectors,
   integrals, etc.) by hand in the printout. Obviously the full power of
   integrals, etc.) by hand to the printout. Obviously, the full power of
   latex is something they are unwilling to learn (and it is probably not  
   LaTeX is something they are unwilling to learn (and it is probably not  
   required for them). So I believe they would be happy to have a WYSIWYG
   required for them). So I believe they would be happy to have a WYSIWYG
   tool that supports embedded formulas.
   tool that supports embedded formulas.
Line 49: Line 48:
------------
------------
o Math support
o Math support
o integrating an external GUI editor
o Patches to Scribus to integrate an external UI editor
o Python bindings
o Python bindings
[1] http://bugs.scribus.net/view.php?id=128
[2] http://bugs.scribus.net/view.php?id=1030
[3] http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=270618
[4] http://wiki.scribus.net/index.php/1.3.x_Roadmap
[5] http://www.bluesky.com/mathsetter/
</pre>
</pre>

Latest revision as of 16:40, 21 March 2007

Rationale
---------
I have often wanted a tool that allows complicated layouts but is still
easy to use. This is exactly what Scribus does. However, for scientific
papers it lacks one main capability: Formulas. So I want to add this feature
as my Summer of Code project. Interest in this enhancement is expressed
by many people in the bug tracker[1][2] and by Debian users[3] and it's 
also listed as a desirable feature in the Scribus roadmap[4].


Overview
--------
The goal of this project is to add easy-to-use math support to Scribus.
As the task of writing a complete math typesetter is too large for SOC, a 
different approach is used. It is inspired by the Quark XPress(tm) plugin 
MATHSETTER[5]:

o Let the user enter LaTeX source either directly or in a more user-friendly
  way via a graphical editor.
o Apply a LaTeX template to this, so the user only has to type the formula
  and not a whole TeX document.
o Run LaTeX on this source.
o Display LaTeX's output in a frame while still keeping the 
  (LaTeX-)formula as a property, so the whole thing stays editable.

Use cases 
---------
o Scientific posters 
  It is very hard (if not impossible) to create good-looking posters
  with LaTeX but it's easy to add formulas to LaTeX documents. On the other
  hand it's very easy to create good posters with Scribus, but a complicated
  process is necessary to add just a single formula. The ability to use LaTeX 
  for typesetting the formula and then post-processing it in Scribus (easily
  possible, after all it's just a vector graphic from Scribus' point of view)
  would greatly simplify this. 

o Math/Physics teachers 
  At school, I've seen a lot of teachers who created their tests with Microsoft
  Word and relied on its formula editor or even on basic text formatting
  (sub-/superscript). They added any "complicated" math symbols (vectors,
  integrals, etc.) by hand to the printout. Obviously, the full power of
  LaTeX is something they are unwilling to learn (and it is probably not 
  required for them). So I believe they would be happy to have a WYSIWYG
  tool that supports embedded formulas.

Deliverables
------------
o Math support
o Patches to Scribus to integrate an external UI editor
o Python bindings

[1] http://bugs.scribus.net/view.php?id=128
[2] http://bugs.scribus.net/view.php?id=1030
[3] http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=270618
[4] http://wiki.scribus.net/index.php/1.3.x_Roadmap
[5] http://www.bluesky.com/mathsetter/