Discussion:
Is there a template for "User Guide", like the one used for Lyx
Bruno Vernay
2013-05-27 15:23:35 UTC
Permalink
Hello,

I would like to use Lyx to create User guides and Technical reference
documents about computer/software.

They usually includes menus like "File -> Save as .., sample code,
file names, program outputs ...
(Typically, what Docbook includes by default.)

After some research, I didn't find anything obvious. Found:
- http://wiki.lyx.org/Layouts/Layouts or
http://www.latextemplates.com/ all beautiful, but nothing about
computer science.
- http://www.ctan.org/pkg/refman or memoir but they are old and maybe
not directly usable in Lyx

I am not against learning some Latex commands, but I would like to
start rapidly and with a layout that would be close and perene for
computer science.

I found that the Lyx "User Guide" is quite close to what I would like
to do. But I didn't find a template matching its document class "book
(Koma script)".

My very simple question would be: can I just open the
doc/UserGuide.lyx, save it as myfile.lyx and start modifying the
document ?? or is it a bad idea?

Is there some place to gather around a common subjects like
mathematics, poetry/hollywood, chemistry, chess/music/recipes,
journal, books ...

Thanks
--
Bruno VERNAY
Uwe Stöhr
2013-05-27 23:21:09 UTC
Permalink
Post by Bruno Vernay
I found that the Lyx "User Guide" is quite close to what I would like
to do. But I didn't find a template matching its document class "book
(Koma script)".
What is your LyX version, and what is your OS?
If you are on Windows, just open an Internet connection and use the menu Tools->reconfigure. This
will automatically install all LaTeX packages and document classes you need.
Post by Bruno Vernay
My very simple question would be: can I just open the
doc/UserGuide.lyx, save it as myfile.lyx and start modifying the
document ?? or is it a bad idea?
A good idea, I would say because I also write technical documentations using this as template (OK, I
set up the UserGuide as it currently is ;-) )

But for larger things I recommend to start with the thesis template that you find in LyX's template
folder in the subfolder thesis.

regards Uwe
Bruno Vernay
2013-05-28 08:41:53 UTC
Permalink
Post by Uwe Stöhr
Post by Bruno Vernay
I found that the Lyx "User Guide" is quite close to what I would like
to do. But I didn't find a template matching its document class "book
(Koma script)".
What is your LyX version, and what is your OS?
If you are on Windows, just open an Internet connection and use the menu
Tools->reconfigure. This will automatically install all LaTeX packages and
document classes you need.
I use Lyx 2.0.6 on "MS-Windows XP SP3".
I reconfigured it and restarted, didn't see much differences so.
Post by Uwe Stöhr
Post by Bruno Vernay
My very simple question would be: can I just open the
doc/UserGuide.lyx, save it as myfile.lyx and start modifying the
document ?? or is it a bad idea?
A good idea, I would say because I also write technical documentations using
this as template (OK, I set up the UserGuide as it currently is ;-) )
Kool. I found that even the "docbook-article" is OK, but requires.
Anyway, I started with the "UserGuide" and will stick to it for now.
Post by Uwe Stöhr
But for larger things I recommend to start with the thesis template that you
find in LyX's template folder in the subfolder thesis.
I won't do larger things. My average document is about 20 pages (A4).
I guess 80 pages is about the maximum that can be managed in my
projects, above I split them, because nobody would consider reading
them.
Post by Uwe Stöhr
regards Uwe
One things that bugs me a lot is how cluttered the templates and
examples are. For example the "new from template" shows a lot of
cryptic files names that could have been categorized as scientific
journals, books, literacy, CV, asian, cyrillic, persian, bidi
languages ...
Why isn't there some kind of "distribution" with packages relevant to
only chemistry or games or serbian documents ? Like the Eclipse
packages for example

Regards
Bruno
Uwe Stöhr
2013-05-30 16:44:38 UTC
Permalink
Post by Bruno Vernay
Post by Uwe Stöhr
Post by Bruno Vernay
I found that the Lyx "User Guide" is quite close to what I would like
to do. But I didn't find a template matching its document class "book
(Koma script)".
Take the thesis template.
Post by Bruno Vernay
Post by Uwe Stöhr
What is your LyX version, and what is your OS?
If you are on Windows, just open an Internet connection and use the menu
Tools->reconfigure. This will automatically install all LaTeX packages and
document classes you need.
I use Lyx 2.0.6 on "MS-Windows XP SP3".
I reconfigured it and restarted, didn't see much differences so.
So you cannot compile the UserGuide?

regards Uwe

Loading...