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. Albeit
  50                 this is not a huge goal we have some parts of the code
  51                 that would benefit from threads. (forking is not that
  52                 nice...)
  53         o signal slot mechanism
  54                 We are going to use the signal/slot implementation
  55                 found in libsigc++. This will hopefully give us better
  56                 interface, leaner code, typesafe "callbacks". I have
  57                 been using signal/slots for other projects and it works
  58                 like a charm.
  59         o other code rewrites to make multiple buffers/windows
  60           possible, without too much hassle.
  61                 - get rid of most of the global variables. In
  62                   perticular current_view is a problem.
  63                 - non shared variables in shared structures
  64         o make source documentation better. Remember that the better
  65           we document LyX internals the easier is it for new
  66           developers to begin working on LyX.
  67
  68
  69 Some other things related to structure and services in the code:
  70         o class FileInfo does way too much, move the unneeded parts to
  71           a super class or friends.
  72         o a process manager class to handle execution of external
  73           commands.
  74                 - ensure that not too many commands are executed at
  75                   the same time.
  76                 - ensure that non-compatible commands are running at
  77                   the same time.
  78                 - to setup file descriptors where communicating with
  79                   the processes can take place.
  80         o pass an inforeceiver around in the object structure.
  81           (this instead of passing minibuffers, and lyxerrors.)
  82         o remove code that is never used, or close to never used.
  83                 Support for reverse video, fast selection and mono
  84                 video comes to mind.
  85
  86 ================
  87
  88 Also a lot of new features are thought of, only some of these are likely
  89 to make it into 0.14:
  90
  91         o rewrite of table code. Should probably be written as some
  92           kind of an inset. At least get the code out of the kernel.
  93                 - colortbl  -multirow
  94                 - hhline    -multicolumn
  95                 - dcolumn
  96         o index support (and multiple indeces support)
  97                 - multind ?
  98         o tocs for each section
  99                 - minitoc
 100         o multiple table of contentes
 101                 - multitoc
 102         o trivlist?
 103         o better version control (both document and file wise)
 104                 - version.sty
 105                 - cvs
 106                 - sccs
 107         o I am sure mathed improvements. (Alejandro's department)
 108                 - better macro support
 109                 - better amsmath support
 110         o character styles (similar to emph and noun)
 111                 Will make a lot of small things conceptual instead of
 112                 specific. Will be alot easier to change the
 113                 presentation of a filename f.ex. This is actually very
 114                 important, because this is where the user can't be
 115                 conceptual in the current version.
 116         o macro support. Similar to the math-macro support, but
 117           usable in regular text too.
 118         o support for abbrevations (static macros)
 119         o add a incremental search function.
 120         o change the "Find and Replace" to Query Replace.
 121         o better/more search functions:
 122                 - replace & find next
 123                 - replace & find previous
 124                 We should perhaps try to make the interface a bit
 125                 emacs like, that should at least give us the
 126                 features we want.
 127         o improved template support.
 128         o collapse "New" and "New from Template" into one item.
 129         o make lyx recognize some file types (i.e. gzipped) and do
 130           the right thing when encountering them.
 131         o We should look at all the LyX specific paragraph styles and
 132           check carefully that we really need them. We should also try
 133           to collapse some of them into singel items (i.e. chapter and
 134           chapter*)
 135         o the "LyX-Code" environment should be removed. Add a verbatim
 136           environment instead.
 137         o tabbing support
 138         o picture support
 139         o better graphics support
 140         o rotating and scaling of text
 141         o PSTricks (we should be able to support some of this package)
 142         o better reference support
 143                 - varioref
 144         o better citation support
 145                 Especially the support for some of the main
 146                 bibtex supplied styles are needed. (harvard natbib...)
 147                 A complete support for natbib should perhaps be enough.
 148         o improved spellchecker
 149                 - an ispell class should be made, this should
 150                   take care of communicating with the ispell
 151                   process.
 152         o online configuration
 153                 So that users should not need to edit lyxrc
 154                 manualy. This has now been "half" done; it is now
 155                 possible to save the current configuration with the
 156                 lyx command "preferences-save". We need to add code so
 157                 that the preferences can be set from inside LyX too.
 158         o better fontsupport
 159                 T1-lib font renderer.
 160         o better latex code quality
 161                 This means reading LaTeX books to get an better idea
 162                 on how things are done in the latex world.
 163         o perhaps find better names for the paragraph styles
 164           "paragraph" and "subparagraph"
 165         o support for filecontents
 166                 This can make a latex document selfcontained, all the
 167                 needed graphics can be in the document.
 168         o support for optional args to latex commands
 169                 - For sectioning commands I have an idea on how we can
 170                   do this: have a popup on RMB to set properties.
 171         o pdf support
 172                 pdftex
 173         o hyperlink support
 174                 - url.sty (or better packages)
 175                 - hyperref.sty
 176         o references to external documents
 177                 - xr.sty
 178         o better babel support
 179                 - make it possible to tune the language strings
 180                 - the possibility for several languages in the same
 181                   document.
 182         o title page support
 183         o draft copy
 184                 - draftcopy.sty
 185         o better float support (allow user to make its own floats)
 186         o support newtheorem (allow user to make its own thorem like envirs)
 187         o a bit more wysiwyg where it is appropiate.
 188                 - show bullets the way they will be on paper
 189                 - show a few more characters as they will be on paper
 190                   (--, ---)
 191         o online generation of new paragraph styles (or editing or old
 192           ones)
 193         o support for inlined sectioning commands (i.e. \paragraph{} )
 194         o we should parse the command line ourselves.
 195         o remove support for XResources, with multiple toolkits it
 196           will be impossible to manage. And they are not very needed
 197           either.
 198         o the possebility to collapse parts of the document.
 199           (i.e. collapse the contents of a section. Would make moving
 200            parts of the document around very easy)
 201         o better LyXServer support
 202                 - perhaps use UNIX sockets instead of pipes
 203                 - make a decent protocol with return codes.
 204                 - make it indepentent of the GUI
 205                 - prob: concurrency (locks)
 206         o other packages to support:
 207                 - keyval (we should not use it directly, but know how
 208                         to parse options for it.)
 209                 - here.sty
 210                 - ulem.sty
 211                 - indentfirst.sty
 212                 - lscape.sty
 213
 214 I am sure others has a list as long as mine...
 215
 216
 217 ======================
 218
 219 We should also do some work to enhance the support we already have for
 220 some packages, I think these are the packages supported by 0.12:
 221         - longtable     - color (papercolor boxes?)
 222         - setspace (should support setting spacing on individual paragraphs)
 223         - psnffs packages
 224         - geometry      - makeidx
 225         - verbatim      - algorithm
 226         - inputenc      - fancyhdr (we only have _very_ basic support)
 227         - fontenc       - a4
 228         - graphics      - a4wide
 229
 230 (I am sure I have forgot some, please fill me in.)
 231
 232
 233 ======================
 234
 235 If you have other wishes for features, or comments, please let us know.
 236
 237         Lgb
 238
 239 Interesting links:
 240
 241 http://freshmeat.net/appindex/1999/11/30/943979651.html
 242 http://freshmeat.net/appindex/1999/12/09/944757708.html