On Thu, 20 Jan 2005, Jean-Marc Lasgouttes wrote: > >>>>> "chr" == chr <[EMAIL PROTECTED]> writes: > > chr> Hi I'd like to ask for some ideas/thoughts on the wiki from a > chr> documentation perspective. Or rather, I'd like some general > chr> thougths on what kind of documentation we would like for LyX, > chr> considering that we can have the documentation in several places > chr> these days. > > chr> Here are some loose ideas of types of documentation: > > chr> * Documentation that comes with a LyX installation > chr> ** UserGuide.lyx etc, to be read from inside LyX > chr> ** UserGuide.lyx etc as a PDF-version (to easily allow printing) > > Do you think that a PDF version would really help in this respect?
I have no idea really... guess I just thought about it because I'm so used to being able to download PDF-versions of various documents. (Ideally I'd like a discussion on a general documentation strategy, i.e. what information should be kept where (possibly duplicated), and in what form.) > I can see that it helps people who would like to print the docs without > installing latex... Another benefit might possibly be that it gives you a "pair" (lyx- and pdf-file) that match, that allows you to check that your system properly generates the pdf-version of the userguide. Maybe this could be useful for people who wonder if their system is working properly? > chr> * Documentation that can be read online > chr> ** Is there a point to having an online version of the UserGuide, > chr> or perhaps to have tutorials online? > chr> ** Wiki pages? Web pages > > What would be nice in general would be to generate the docs from (a > part of) the wiki, but the formatting possibilities of the wiki are > too poor to allow that. However, it would be nice to have > automatically pdf and maybe html versions of the docs on the web site. We will eventually have the possibility to generate a PDF [1] from a set of wiki pages, but I (as you) seriously doubt we even should try to use that as our way of creating the main documentation. But perhaps the wiki could be useful for certain documentation (eg where formatting is secondary). For that matter, I'd think it be more useful to ship a copy of some of the wiki pages as local documentation (if they are useful), instead of putting them all together as a big PDF-file. > chr> * Collaborative documentation (eg. the wiki) > > chr> * The FAQ - how does it fit in (it's currently on the wiki) > > I think the FAQ should be removed from the docs, or maybe (since it is > less complicated in terms of formatting than, say, the UserGuide) we > could generate it from a part of the wiki. Is it possible to export a > wiki tree to latex? [1] A guy (John Rankin) is working on being able to generate a PDF-document from a set of wiki pages. He actually has this working, but I haven't installed it yet. That'll wait until after I eventually update the wiki to PmWiki 2 (we're using PmWiki 1 now). I think John plans to eventually use latex in the process of generating a PDF file. /Christian -- Christian Ridderstr�m, +46-8-768 39 44 http://www.md.kth.se/~chr
