Søren Yes, although I am currently using the MikTex executables from outside of octave to generate the pdf from the texi files, so I need to do some research on how to make it platform independent - in MS Windows for example the mikTex binaries are probably not in the user's PATH variable it would require either:
a) asking the user to enter the location of mikTex as a parameter to a function. b) bundling the miktex binaries with the package. c) creating only the Tex files and let the user do the conversion to PDF outside of octave. Any thoughts? Liam -----Original Message----- From: Søren Hauberg [mailto:so...@hauberg.org] Sent: 15 June 2011 16:58 To: Veitch, Liam Cc: octave-dev@lists.sourceforge.net Subject: RE: [OctDev] Package PDF documentation Hi That looks something like what I imagined. You might not be the only one interested in generating such PDFs, so would you consider contributing a function to the "generate_html" package that creates the PDF? Thanks Søren ons, 15 06 2011 kl. 16:46 +0100, skrev Veitch, Liam: > Søren > > Thankyou, I managed to generate a PDF using MikTex in Windows by creating a > tex file containing a simple header and footer. I also looked at the list > variable and came up with a solution which groups gother functions into > manual sections by their category. See the attached files for details. > > Thanks again, > Liam > > doc.tex > -------------------------------------------- > \input texinfo @c -*-texinfo-*- > @c %**start of header > @setfilename doc.info > @settitle Sample Manual 1.0 > @c %**end of header > > @contents > @chapter Function Reference > @include functions.texi > > @end > -------------------------------------------- > > > function_doc.m > -------------------------------------------- > pack_name = "generate_html" > > % Load Packages > pkg load "generate_html" > pkg("load", pack_name); > > % Get list of functions > list = pkg ("describe", pack_name); > > %list > > % Open output file > fid = fopen("functions.texi", "w"); > > for k = 1:numel (list {1}.provides) > > group = list {1}.provides{k}; > functions = group.functions; > > fprintf(fid, '@section %s\n', group.category); > > for k=1:numel(functions) > [TEXT, FORMAT] = get_help_text(functions(k)); > fprintf(fid,TEXT); > end > > end > > fclose(fid); > -------------------------------------------- > > -----Original Message----- > From: Søren Hauberg [mailto:so...@hauberg.org] > Sent: 14 June 2011 13:28 > To: Veitch, Liam > Cc: octave-dev@lists.sourceforge.net > Subject: Re: [OctDev] Package PDF documentation > > Hi > > The 'generate_html' package does not support generating PDFs. You should > be able to hack something together fairly easy. > > The following dirty (and untested) code: > > pack_name = "generate_html" > list = pkg ("describe", pack_name); > functions = {}; > for k = 1:numel (list {1}.provides) > functions = cat (2, functions, list {1}.provides {k}.functions); > endfor > > should give you a list of functions in the package (you can also get > categories and stuff like that in a similar way -- study the contents of > the 'list' variable). You can then get the help text of these functions > using the 'get_help_text' function, which gives you the text in texinfo. > You can then put these strings together as you want and run the > 'makeinfo' program (not sure on the details here) from the command line. > You should be able to generate a PDF that way. > > Søren > > tir, 14 06 2011 kl. 12:01 +0100, skrev Veitch, Liam: > > Hi, > > > > Is it possible to generate pdf documentation similar to the Octave > > manual, for a package which I have created? I have used the > > generate_html package which produces some very neat html > > documentation, however I would like a single file with all this in, > > preferably pdf. > > > > Fyi , I am running Microsoft Windows upon my office computer so > > whichever tools I need should ideally run on that platform, but I do > > have access to Linux on another machine if it is not possible. > > > > Kind Regards, > > > > Liam > > > > > > > > ______________________________________________________________________ > > NOTICE: This communication and any attachments ("this message") may > > contain confidential information for the sole use of the intended > > recipient(s). Any unauthorized use, disclosure, viewing, copying, > > alteration, dissemination or distribution of, or reliance on this > > message is strictly prohibited. If you have received this message in > > error, or you are not an authorized recipient, please notify the > > sender immediately by replying to this message, delete this message > > and all copies from your e-mail system and destroy any printed copies. > > ------------------------------------------------------------------------------ > > EditLive Enterprise is the world's most technically advanced content > > authoring tool. Experience the power of Track Changes, Inline Image > > Editing and ensure content is compliant with Accessibility Checking. > > http://p.sf.net/sfu/ephox-dev2dev > > _______________________________________________ Octave-dev mailing list > > Octave-dev@lists.sourceforge.net > > https://lists.sourceforge.net/lists/listinfo/octave-dev > > > > ______________________________________________________________________ > NOTICE: This communication and any attachments ("this message") may contain > confidential information for the sole use of the intended recipient(s). Any > unauthorized use, disclosure, viewing, copying, alteration, dissemination or > distribution of, or reliance on this message is strictly prohibited. If you > have received this message in error, or you are not an authorized recipient, > please notify the sender immediately by replying to this message, delete this > message and all copies from your e-mail system and destroy any printed copies. ______________________________________________________________________ NOTICE: This communication and any attachments ("this message") may contain confidential information for the sole use of the intended recipient(s). Any unauthorized use, disclosure, viewing, copying, alteration, dissemination or distribution of, or reliance on this message is strictly prohibited. If you have received this message in error, or you are not an authorized recipient, please notify the sender immediately by replying to this message, delete this message and all copies from your e-mail system and destroy any printed copies. ------------------------------------------------------------------------------ EditLive Enterprise is the world's most technically advanced content authoring tool. Experience the power of Track Changes, Inline Image Editing and ensure content is compliant with Accessibility Checking. http://p.sf.net/sfu/ephox-dev2dev _______________________________________________ Octave-dev mailing list Octave-dev@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/octave-dev
