development/lyx3/LyX3-Tasks

   1 -*- text -*-
   2
   3 This is a tasklist/todo list for the 0.13.x development series. We
   4 should perhaps name these seies LyX3 as a common name. As I see it
   5 there are three major tasks to be done:
   6
   7         o Buffer structure rewrite
   8                 So that it will be easier to expand for
   9                 new and unknow future features.
  10                 The main problems with the current structure is that
  11                 is intended to be viewed by only one window at the
  12                 time. It also uses characters as the smallest unit, it
  13                 would probably be better to use something a bit
  14                 bigger.
  15                 The LyXText class does not necessarily need to change
  16                 a lot, it could be per-view. However all the special
  17                 code in it needs to be (re)moved. Also a lot of the
  18                 functionality needs to be relocated.
  19         o Switch to LaTeX as fileformat
  20                 Will ease move from latex to LyX a lot.
  21                 Also will let people work both in (ex) emacs
  22                 and LyX on the same files.
  23         o GUI independence.
  24                 Should be a compile time switch what gui (toolkit)
  25                 you wish to use. We are going to support Xforms first,
  26                 and I am sure that GTK and Qt will follow soon. I also
  27                 plan to do support for Fl (even a text only toolkit
  28                 should be possible. ncurses perhaps. Even the
  29                 lyxserver could be a special case of this: a view with
  30                 no view being able to coexist with other views or alone)
  31                 We will do this by providing an interface all the
  32                 toolkits will need to follow. Functions that the LyX
  33                 core will expect to be there.
  34
  35 When these three is finished, we will probably declare a code freeze
  36 and try to release a new version. Hopefully other features has also
  37 been added, and none removed.
  38
  39
  40 ====================
  41
  42 In addition to these there are a lot of small tasks that should be
  43 performed, that has no direct bearing on features, but are more geared
  44 towards code quality:
  45
  46         o always try to use POSIX commands.
  47         o switch to use POSIX signals
  48         o make as much as possible of the code reentreanant(?)
  49                 should make it easier to move to threads later.
  50         o signal slot mechanism (borrowed from GTK-- project)
  51                 better interface, leaner code, typesafe. I have
  52                 been using this for another project and it works
  53                 like a charm.
  54         o other code rewrites to make multiple buffers/windows
  55           possible, without too much hassle.
  56                 - get rid of most of the global variables.
  57                 - non shared variables in shared structures
  58                   (i.e. the cursor in the text class)
  59         o make source documentation better. Remember that the better
  60           we document LyX internals the easier is it for new
  61           developers to begin working on LyX.
  62
  63
  64 Some other things related to structure and services in the code:
  65         o class FileInfo does way too much, move the unneeded parts to
  66           a super class or friends.
  67         o a process manager class to handle execution of external
  68           commands.
  69                 - ensure that not too many commands are executed at
  70                   the same time.
  71                 - ensure that non-compatible commands are running at
  72                   the same time.
  73                 - to setup file descriptors where communicating with
  74                   the processes can take place.
  75         o pass an inforeceiver around in the object structure.
  76           (this instead of passing minibuffers, and lyxerrors.)
  77
  78 ================
  79
  80 Also a lot of new features are thought of, only some of these are likely
  81 to make it into 0.14:
  82
  83         o rewrite of table code. Should probably be written as some
  84           kind of an inset. At least get the code out of the kernel.
  85                 - colortbl  -multirow
  86                 - hhline    -multicolumn
  87                 - dcolumn
  88         o index support (and multiple indeces support)
  89                 - multind ?
  90         o tocs for each section
  91                 - minitoc
  92         o multiple table of contentes
  93                 - multitoc
  94         o trivlist?
  95         o better version control (both document and file wise)
  96                 - version.sty
  97                 - cvs
  98                 - sccs
  99         o I am sure mathed improvements. (Alejandro's department)
 100                 - better macro support
 101                 - better amsmath support
 102         o character styles (similar to emph and noun)
 103                 Will make a lot of small things conceptual instead of
 104                 specific. Will be alot easier to change the
 105                 presentation of a filename f.ex. This is actually very
 106                 important, because this is where the user can't be
 107                 conceptual in the current version.
 108         o macro support. Similar to the math-macro support, but
 109           usable in regular text too.
 110         o support for abbrevations (static macros)
 111         o add a incremental search function.
 112         o change the "Find and Replace" to Query Replace.
 113         o better/more search functions:
 114                 - replace & find next
 115                 - replace & find previous
 116                 We should perhaps try to make the interface a bit
 117                 emacs like, that should at least give us the
 118                 features we want.
 119         o improved template support.
 120         o collapse "New" and "New from Template" into one item.
 121         o make lyx recognize some file types (i.e. gzipped) and do
 122           the right thing when encountering them.
 123         o We should look at all the LyX specific paragraph styles and
 124           check carefully that we really need them. We should also try
 125           to collapse some of them into singel items (i.e. chapter and
 126           chapter*)
 127         o the "LyX-Code" environment should be removed. Add a verbatim
 128           environment instead.
 129         o tabbing support
 130         o picture support
 131         o better graphics support
 132         o rotating and scaling of text
 133         o PSTricks (we should be able to support some of this package)
 134         o better reference support
 135                 - varioref
 136         o better citation support
 137                 Especially the support for some of the main
 138                 bibtex supplied styles are needed. (harvard natbib...)
 139                 A complete support for natbib should perhaps be enough.
 140         o improved spellchecker
 141                 - an ispell class should be made, this should
 142                   take care of communicating with the ispell
 143                   process.
 144         o online configuration
 145                 So that users should not need to edit lyxrc
 146                 manualy
 147         o better fontsupport
 148                 T1-lib font renderer.
 149         o better latex code quality
 150                 This means reading LaTeX books to get an better idea
 151                 on how things are done in the latex world.
 152         o perhaps find better names for the paragraph styles
 153           "paragraph" and "subparagraph"
 154         o support for filecontents
 155                 This can make a latex document selfcontained, all the
 156                 needed graphics can be in the document.
 157         o support for optional args to latex commands
 158                 - For sectioning commands I have an idea on how we can
 159                   do this: have a popup on RMB to set properties.
 160         o pdf support
 161                 pdftex
 162         o hyperlink support
 163                 - url.sty (or better packages)
 164                 - hyperref.sty
 165         o references to external documents
 166                 - xr.sty
 167         o better babel support
 168                 - make it possible to tune the language strings
 169                 - the possibility for several languages in the same
 170                   document.
 171         o title page support
 172         o draft copy
 173                 - draftcopy.sty
 174         o better float support (allow user to make its own floats)
 175         o support newtheorem (allow user to make its own thorem like envirs)
 176         o a bit more wysiwyg where it is appropiate.
 177                 - show bullets the way they will be on paper
 178                 - show a few more characters as they will be on paper
 179                   (--, ---)
 180         o online generation of new paragraph styles (or editing or old
 181           ones)
 182         o support for inlined sectioning commands (i.e. \paragraph{} )
 183         o we should parse the command line ourselves.
 184         o remove support for XResources, with multiple toolkits it
 185           will be impossible to manage. And they are not very needed
 186           either.
 187         o the possebility to collapse parts of the document.
 188           (i.e. collapse the contents of a section. Would make moving
 189            parts of the document around very easy)
 190         o better LyXServer support
 191                 - perhaps use UNIX sockets instead of pipes
 192                 - make a decent protocol with return codes.
 193                 - make it indepentent of the GUI
 194                 - prob: concurrency (locks)
 195         o other packages to support:
 196                 - keyval (we should not use it directly, but know how
 197                         to parse options for it.)
 198                 - here.sty
 199                 - ulem.sty
 200                 - indentfirst.sty
 201                 - lscape.sty
 202
 203 I am sure others has a list as long as mine...
 204
 205
 206 ======================
 207
 208 We should also do some work to enhance the support we already have for
 209 some packages, I think these are the packages supported by 0.12:
 210         - longtable     - color (papercolor boxes?)
 211         - setspace (should support setting spacing on individual paragraphs)
 212         - psnffs packages
 213         - geometry      - makeidx
 214         - verbatim      - algorithm
 215         - inputenc      - fancyhdr (we only have _very_ basic support)
 216         - fontenc       - a4
 217         - graphics      - a4wide
 218
 219 (I am sure I have forgot some, please fill me in.)
 220
 221
 222 ======================
 223
 224 If you have other wishes for features, or comments, please let us know.
 225
 226         Lgb
 227
 228 Interesting links:
 229
 230 http://freshmeat.net/appindex/1999/11/30/943979651.html
 231 http://freshmeat.net/appindex/1999/12/09/944757708.html