Page 2 of 3

Re: New Manual?

Posted: Thu Dec 18, 2014 1:15 pm
by Gordon Cooper
A definite YES. If PDF is the decided form, then Scribus is a possibility for setting it out. I have been using this program for a while and
while there's a bit of a learning curve, the results are excellent. I'm very willing to help.

Re: New Manual?

Posted: Thu Dec 18, 2014 1:27 pm
by Jerry3904
It's all in html ATM

Re: New Manual?

Posted: Thu Dec 18, 2014 3:18 pm
by Gordon Cooper
Jerry3904 wrote:It's all in html ATM
It's easy enough to print the html directly for those who want a hard copy
on paper. As there have been suggestions of a PDF version, I was thinking
about using Scribus to produce such a pdf, set out in sections for easier
updating. Apart from the initial writing, formatting etc. we all know that
the biggest issue with any manual is keeping the darned thing up to date.

Re: New Manual?

Posted: Fri Dec 19, 2014 6:09 am
by Dieselrider
I don't know what help I can be on such a project but,I am willing to do what I can. I have been wishing for a manual since switching to mx.

Re: New Manual?

Posted: Fri Dec 19, 2014 9:51 am
by Jerry3904
Thanks for the feedback!

I have started assembling a base document, deleting stuff from the M11 Manual and moving the MX Docs into larger categories. Current structure and status look like this ATM (1=mostly new, 2=half done or so, 3=essentially done):

Introduction (1)
1: Installation (2)
2: Configuration (2)
3: Software management (3)
4: Command line 101 (3)
5: Advanced use (2)
6: Under the hood (3)
Glossary (with links in text on first appearance) (3)
Appendix (2)

I will have a base assembly finished by the end of the month/year, then we can start on the actual rewriting. Tentative timeline: useable beta by Feb 15 (when it would replace current MX Docs), Final by April 1 for inclusion in MX-15.

I may be missing something, but this looks doable to me without anybody going crazy. We'll see...

Re: New Manual?

Posted: Fri Dec 19, 2014 12:04 pm
by Paul..
Count me in, Jerry.

Re: New Manual?

Posted: Sat Jan 03, 2015 10:40 am
by Gaer Boy
Jerry - have you got any further on this? I'm thinking that I could have a go at the VirtualBox section and I have a few days spare in the next 2 weeks.

I'm planning on documenting a fresh install of MX-14.3 on my second machine, installing VBox and then creating a WinXP VM and a Linux VM. Although I've done this a number of times, I usually find I have to backtrack to edit something I've missed, so a detailed guide would be useful to me in future. If you haven't made any changes to the M11 section yet, I will start with that.

Phil

Re: New Manual?

Posted: Sat Jan 03, 2015 10:56 am
by Jerry3904
Thanks for asking! Yup, Gordon and I have been working hard on this, using Lyx. Attached are screen captures of the draft first page in pdf and html (don't anybody do any text suggestions yet...) deriving from the same Lyx file (so cool!).

A section on VirtualBox setup would be a great help--be sure to consult D-O's two videos on the topic so we are in sync.

Once we get all the formatting and layout stuff in place, I will be posting a list of areas where I could use some help.

Re: New Manual?

Posted: Sat Jan 03, 2015 2:33 pm
by Gordon Cooper
I'll anticipate the question, why Lyx?

Lyx is a front end for the typesetting system TeX/LateX. As Jerry wrote, Lyx ouputs in pdf and html(cool), it also can output in .odt, Postscript and a device independent format, DVI. A big advantage in a project like the MX Manual, where updates and changes are to be expected, is that Lyx looks after paragraphs, sections and numbering. If a new section or sub-section has to be added, we just put it in, Lyx does any renumbering automatically.

Yep, there's a bit of learning curve, Lyx nearly drove me bonkers over the first few attempts, but after that, all is sweetnees and light (well nearly).

Re: New Manual?

Posted: Sat Jan 03, 2015 3:38 pm
by KernSpy
I think a good uptodate manual is a great idea. A lot of folks like to ask questions in a forum, or google search for answers. New and even seasoned users still need a guide of some sort. I know there has been a few times when I should have been reading and not asking. Having a link to another basic linux guide for newbies would be good to. Like for those coming over from windows. (Linux Guide for Newbies) Perhaps a mx cheat-sheet tailored for mx would be good? Like the Linux cheat sheet. http://www.tuxarena.com/intro/cheatsheet.html

Another good thing might be a complete and very detailed "video guide" on installing, configuring, updating, upgrading, tweaking and making it (mx) your very own.

I don't know what I could do being a basic newbie, but I would be willing to help in any area I can.