Am Freitag, 8. Februar 2013 um 20:44:50, schrieb Scott Kostyshak <skost...@lyx.org> > I would like to make a page on the wiki regarding making MWEs for LyX. > I am checking in here because I would like to make sure that none of > my personal opinions makes it into the page. I would also appreciate > any comments. > > My motivation for creating this page and for asking users to provide > MWEs is that I think a lot of time is lost because of the lack of > MWEs. Also, I think that some questions go unanswered because of the > user not sending an MWE. By encouraging users to post MWEs, I think > that time will be better spent, more questions will be answered, and > it's easier (for developers or users) to turn these types of emails > into useful bug reports. > > I do not want users to have to read a lot before understanding what an > MWE is so I try to give brief advice and then after that give a more > complete treatment of MWEs in a LyX context. > > <<begin proposed wiki text>> > > title: How to create a Minimum Working Example (MWE) for LyX > > #In a nutshell > > An MWE is a .lyx file that is as small as possible while still showing > the behavior that you are asking about. It should include as few > dependencies as possible -- remove any unnecessary pictures and > external files. It should be possible for someone to download your > .lyx file and without modification see the same behavior that you are > seeing. > > Below is more information on how and why to create MWEs. > > > > #Why create an MWE? > - MWEs make it easier for people to see the problem you are talking > about and thus easier for them to propose solutions. > > - If 5 people download your .lyx file trying to help and spend 5 > minutes removing the graphics you included and cleaning the LaTeX > preamble that is not necessary, then that's 25 minutes of wasted time > instead of the 5 minutes that you could spend doing that. By sending > an MWE, you can make it as easy as possible for someone to help you. > > - It takes time and effort. How is this a good thing? If you show that > you are willing to spend time to solve your own problem, this makes it > more likely that someone else will want to spend his/her time to help > you with your problem. > > > > #How to create an MWE? > - Remove as much as possible from your .lyx file while still making > sure it shows the behavior you are reporting. > -- The preamble should not have anything except what's needed to > reproduce the bug (further, it's helpful if you specify that without > something in the preamble the problem in question goes away). > -- Document settings should not have anything special unless it's > needed to reproduce the bug. For example, if you can reproduce the > behavior by using the document class "Article (Standard Class)" > instead of a less common document class, please do so. > > - If the example requires external files, make sure they're included > in your email or trac ticket. > > - Use relative paths if you need to include external files. Further, > relative paths should work when all files are put/uncompressed to the > same folder. That is, "../../Dropbox/MyLyXstuff/picture.jpg" is > relative but bad; "./picture.jpg" is good. > > - Test your MWE. Just before you send it, copy the MWE files to a > different folder. See if things compile fine. Make sure that the > output still shows the problem you're seeing. > > > > #In addition to the MWE > It is useful if you attach more files in addition to the MWE, such as > your pdf output (or your log from your attempt to produce a PDF > output). Sometimes it's not obvious if the output shows the problem or > not (e.g. if it requires a foreign language that the person trying to > help does not know how to read). > > > > #FAQ > I cannot create an MWE. Whenever I remove something, my problem goes > away. What should I do? > - Technically, this is still a MWE, just a large one! If you do not > want to post a personal .lyx file, state in your email if you would be > willing to send this file privately. > - Even if you cannot create an MWE or you cannot send it, the fact > that you cannot create an MWE is useful information. It not only gives > information about the possible bug that you are seeing but it also > shows that you made an effort. > > <<end proposed wiki text>> > > Any thoughts? > > Best, > > Scott
I like it.
Kornel
signature.asc
Description: This is a digitally signed message part.
