On Mon, 2013-07-08 at 07:46 +0000, LyX Ticket Tracker wrote: > #8577: Additional features manual > ---------------------------+------------------------ > Reporter: john_hudson | Owner: uwestoehr > Type: task | Status: new > Priority: normal | Milestone: 2.1.0 > Component: documentation | Version: 2.1.0svn > Severity: normal | Resolution: > Keywords: | > ---------------------------+------------------------ > > Comment (by spitz): > > I think we should do something about this, else John's efforts will end as > vapor. Richard? > > John, I had a quick glance at this. The changes look good in general, but > it's really difficult to tell the differences in detail, since you did not > use change tracking. But I understand this cannot be repaired at this > stage. > > However, can you describe what has been done? I understand you did some > restructuring, some updating (menu description etc.) and some style > polishing. Most of it looks good. What I do not like, though, is that you > introduce a very deep sectioning hierarchy (up to paragraph level) and > shift some subsections to subsubsections. I think in general that > sectioning beyond subsections (if chapters are used) is problematic, and > is an indicator that the outline should be rethought. > > Also, do you have a more up-to-date version? In trunk, some content of the > Additional manual changed recently, most importantly, the multicol section > was completely rewritten (your version does not even compile anymore). > > You can follow the changes in the document here: > http://www.lyx.org/trac/log/lyxgit/lib/doc/Additional.lyx > This is what I wrote when I finished it: I attach an updated, expanded and restructured Additional Features manual. Unfortunately, before I was half way through the changes, TeX told me that I had reached its limits. So I had to turn Track changes off in order to continue.
A couple of points need attention: I have added a short Lilypond example as a note in section 4.10 because my LaTeX skills proved insufficient to write the appropriate if ... else ... fi constuction to allow this to be included. Perhaps someone else can. I wasn't able to view section 5.3 Multiple Columns because the Multiple Columns module didn't work in 2.0.5. So this just needs to be checked to ensure that I haven't introduced any undesired effects into it. In undertaking the restructuring, I started from the philosophy set out in Chapter 1 and restructured the manual around the order of topics in the User's Guide. I have also copied some parts of the User's Guide directly into the manual on the assumption that, if these changes are acceptable, those parts of the User's Guide can be deleted and replaced by a reference to the Additional Features manual. To summarise for the benefit of the Translators: Chapters 1 and 2 are substantially the same, with only minor changes. Chapter 3 is half new and half an update of Chapter 6 in the current manual. Chapter 4 is all new. Chapter 5 is an updated Section 3.4 from the current manual and Uwe's rewrite of Section 8.1 of the current manual. Chapter 6 is an updated Section 3.5 from the current manual and the parts of Chapter 3 of the User's Guide which relate to customizing lists. (So everything to do with customizing lists is in one place.) Chpater 7 is almost all new but incorporates a small part of Section 6.5 from the User's Guide. Chapter 8 is an updated Section 3.2 from the current manual. Chapter 9 is Chapter 7 from the current manual with minor changes. Chapter 10 is Section 3.3 from the current manual. Chapter 11 is Chapter 4 from the current manual. Chapter 12 is Chapter 5 from the current manual. One option would be to wait until 2.1 comes out; I could then go through what I have done and add in anything that has been added to the current version since I did this one. So far Uwe has gone through my suggestions for the Intro, Tutorial and User Guide and made them consistent with the style you like. So I would assume that could be done to this one. Basically, my idea was to create a framework which would take account of known changes in 2.1 and be easier to update in future. But I'm not precious about how this should be used. John --
