Author Topic: PixInsight Reference Documentation System  (Read 24551 times)

Offline Juan Conejero

  • PTeam Member
  • PixInsight Jedi Grand Master
  • ********
  • Posts: 7111
    • http://pixinsight.com/
Re: PixInsight Reference Documentation System
« Reply #30 on: 2010 September 29 08:08:59 »
Hi David,

Quote
Where did I go wrong? I didn't get any graphics in the images subdirectory.

You did it correctly. There are no images in the images subdir because I didn't upload them to the website; I just uploaded the .pidoc file as an example. The compiler should have issued some warnings saying that some linked images don't exist.

I have uploaded the images for the ScreenTransferFunction document, so you can compile the .pidoc file to get an exact copy of the original document. Download these files to any folder on your Mac:

http://pixinsight.com/download/pidoc/examples/ScreenTransferFunction.pidoc
http://pixinsight.com/download/pidoc/examples/ScreenTransferFunction.png
http://pixinsight.com/download/pidoc/examples/ScreenTransferFunction_01.png
http://pixinsight.com/download/pidoc/examples/ScreenTransferFunction_02.png
http://pixinsight.com/download/pidoc/examples/ScreenTransferFunction_03.png

and compile the .pidoc file. Now it will work as advertised.

The only problem with Mac OS X is that exploring the "inside" of an application bundle isn't easy (you have to select "Show Package Contents" from a context menu). But it works the same as on the rest of platforms.
Juan Conejero
PixInsight Development Team
http://pixinsight.com/

Offline Juan Conejero

  • PTeam Member
  • PixInsight Jedi Grand Master
  • ********
  • Posts: 7111
    • http://pixinsight.com/
Re: PixInsight Reference Documentation System
« Reply #31 on: 2010 September 29 08:17:30 »
Hi Andy,

Quote
Question:  will the upcoming Reference Manual contain actual examples of processes/workflows in action or is that work primarily a technical manual describing the tools in detail (why you use them, what they do when used, and how they work on the image, etc.)?

In a first stage it will be a manual. Take into account that we are speaking of 70 tools, and there will be more this Winter. In a second revision I'll include practical usage examples of selected tools. This is going to be a job done by successive approximations. 

Quote
I know this is the digital age and print is going the way of the dodo but if this manual lives up to expectations, I will be getting it printed to read over and over as needed.....

I also love printed manuals. In a future version the documentation compiler will generate PostScript output, which can be easily converted into PDF files. This is not a priority now, but I definitely have it in the medium-term to-do list.
Juan Conejero
PixInsight Development Team
http://pixinsight.com/

Offline ManoloL

  • PixInsight Addict
  • ***
  • Posts: 220
Re: PixInsight Reference Documentation System
« Reply #32 on: 2010 September 29 13:20:14 »
Hola Juan:

En primer lugar te muestro mi agradecimiento por el esfuerzo que supone la creación de esta documentación largamente anhelada.

Trasteando con el archivo fuente del STM al que le he cambiado el primer párrafo que he traducido al español, colocados los archivos complementarios como has indicado, le he compilado obteniendo un archivo con este aspecto:
http://fotografiaastronomica.com/files/posted_images/user_41_stfsp.gif
Pensando que el cambio de aspecto podía ser debido a mi manipulación he compilado el archivo fuente original obteniendo un documento con la misma apariencia que el anterior. No concuerda con respecto al documento, como se muestra en la Web, el tipo de letra y la primera imagen aparece con texto en su margen derecho y no aparece en el margen izquierdo los elementos que si aparecen en el texto "original".
Sospecho que falta algún archivo complementario o no está colocado en la carpeta oportuna.

Saludos.
Saludos.

Manolo L.

Offline ammcdavid

  • Newcomer
  • Posts: 40
Re: PixInsight Reference Documentation System
« Reply #33 on: 2010 September 29 18:51:09 »
Hi Andy,

In a first stage it will be a manual. Take into account that we are speaking of 70 tools, and there will be more this Winter. In a second revision I'll include practical usage examples of selected tools. This is going to be a job done by successive approximations. 

Quote
I know this is the digital age and print is going the way of the dodo but if this manual lives up to expectations, I will be getting it printed to read over and over as needed.....

I also love printed manuals. In a future version the documentation compiler will generate PostScript output, which can be easily converted into PDF files. This is not a priority now, but I definitely have it in the medium-term to-do list.


Juan,
Thank you for your response and the good information.

In this age of "instant gratification" it is sometimes easy to overlook the practical logistics involved in creating something like PI, especially when we tend to think every "company" as this huge corporation with tons of staff and resources.  I think most folks would be surprised at how many companies are really just comprised of a few people working out of their homes/garage/small office/etc.  In just creating, revising, and polishing the software to its current state is no mean feat and it has been given its due in terms of attention and expertise.  To do less on a practical manual would be a crime that I know you and the team would not commit.....it will be worth the wait I am sure but I may also wait to buy the software until such time as that practical manual is available.....I haven't decided yet. 

On the one hand, I can keep muddling along and learn through trial and error and the documentation on the website/forum......but too me at least, that is rather cumbersome and in-efficient.  (I still haven't gotten past the HTTP501 Error on Harry's site despite a fair amount of research but that is another issue & I only bring it up to speak to the cumbersome & in-efficient comments above).   On the other hand, I do have other aspects of this astrophotography endeavor that I could concentrate on in lieu of actual image processing until such time as the practical manual(s) is(are) ready.

I understand, to some degree, what you are facing in that I manage the development of entire family of engine-powered (up to 750 hp) machines with microprocessor based electronic controls and we too develop the specification, then the machine including the controls, and finally the manual (one for the overall machine and one for the controls).  The manuals are the last thing produced in a development project but are often the most critical item for our customers.  We have even lost customers because of the lack of a relevant and accurate manual.  A $250K machine is only so much scrap if our customer doesn't know how to use it, maintain it, and/or service it.

Back in the day (even 4-5 years ago), we used to develop machines and sell them to customers before the manual was developed or perhaps send them a manual that was "close enough".  As I stated above, our customers were not happy.  Now, we can't launch a new product unless the manual is finished and approved by engineering (me), quality, sales, and service.  Such are the mandates when you are part of a large corporation (though we still don't have nearly enough staff).  Fundamentally, we made the correct change in our practices/policies for our customers.

I only give you this summary as a point of reference and to share my feelings on PI.  I like the software and recognize its potential and given enough time, I could learn it without a practical manual but in all honesty I shouldn't have to.  I know you already know this and I know you are doing all you can to remedy the situation and when the practical manual does become a reality, it will likely be the best manual ever created because I don't believe you could produce the second best anything.  I hope this doesn't come across as a rant or flame as that is not my intent.  I am just a bit frustrated and wanted to express this novice's views.  I truly do applaud what you have created even though I barely know any of its nuances.....I can recognize the potential.

Regards,
Andy
Losmandy G11 on pier with Celestron C8 and Astrometric Instruments drive system. Canon EOS Rebel T1i (500D).  Coming soon: Orion Short Tube 80 w/Star Shoot Autoguider.

Offline Juan Conejero

  • PTeam Member
  • PixInsight Jedi Grand Master
  • ********
  • Posts: 7111
    • http://pixinsight.com/
Re: PixInsight Reference Documentation System
« Reply #34 on: 2010 September 30 00:57:53 »
Hola Manolo

Gracias por todo lo que dices, y doy las gracias por anticipado también a todos los que tenéis el proyecto de colaborar para traducir el nuevo manual. Irá algo despacio, y pienso ir publicando cada nuevo documento en la web, así que tendréis tiempo ;)

Quote
No concuerda con respecto al documento, como se muestra en la Web, el tipo de letra y la primera imagen aparece con texto en su margen derecho y no aparece en el margen izquierdo los elementos que si aparecen en el texto "original".
Sospecho que falta algún archivo complementario o no está colocado en la carpeta oportuna.

Como has podido comprobar, trabajar con el nuevo sistema de documentación de PI es muy fácil y cómodo. El cambio de aspecto se debe a que te faltan las hojas de estilo y otros archivos necesarios.

Lo primero que tienes que hacer, si no lo has hecho ya, es crear un directorio "doc" dentro de C:\PCL (o c:\PCL64), o donde hayas instalado PI. Dentro de doc tienes que crear otro directorio "pidoc", y dentro de éste debes reproducir lo que tienes aquí:

http://pixinsight.com/doc/

Es decir, el subárbol de directorios que tienes que tener es:

doc
   pidoc
      css
      graphics
      icons
      images
      scripts
      titles


Algunos de estos directorios están vacíos por el momento. En css, icons y titles hay archivos que debes copiar tal cual están (los tienes en el enlace de arriba). De esta forma te funcionará perfectamente. Por supuesto, todo esto ya no será necesario cuando publiquemos la próxima versión.

Hoy voy a publicar una nueva versión del compilador de documentación, que anunciaré aquí.

Un saludo.
Juan Conejero
PixInsight Development Team
http://pixinsight.com/

Offline bosch

  • PixInsight Addict
  • ***
  • Posts: 123
Re: PixInsight Reference Documentation System
« Reply #35 on: 2010 September 30 09:42:27 »
Me uno a las felicitaciones de Manolo y de hecho casi que nos viene bien el que saques los documentos despacito, para poder ir traduciéndolos a medida que aparezcan.

Respecto a la configuración de los diferentes directorios, me apunto las instrucciones.

Gracias.


Offline Jordi Gallego

  • PixInsight Addict
  • ***
  • Posts: 279
Re: PixInsight Reference Documentation System
« Reply #36 on: 2010 October 02 01:55:49 »
Juan,

es una tarea ingente la que has acometido, pero era muy necesaria y el resultado, por lo que he visto es una presentación y sistema muy profesional.

Felicitaciones y muchas gracias por el esfuerzo que sigues poniendo en este proyecto ;)
Jordi Gallego
www.astrophoto.es

Offline Niall Saunders

  • PTeam Member
  • PixInsight Jedi Knight
  • *****
  • Posts: 1456
  • We have cookies? Where ?
Re: PixInsight Reference Documentation System
« Reply #37 on: 2010 October 02 10:21:56 »
Juan,

Although my reply is somewhat 'late' in reaching the Forum, please understand that - like everybody else - I really appreciate the huge effort you have put in to get the Documentation System launched.

And further, despite the huge number of cookies available over here on the Dark Side, I have already learned one 'new thing' from the pre-released information - so that just goes to show that we are ALL still 'learners' when it comes to PixInsight :cheesy:

Good red wine and warm Spanish solitude seem to work wonders for your energy levels - time for another holiday? ::)
Cheers,
Niall Saunders
Clinterty Observatories
Aberdeen, UK

Altair Astro GSO 10" f/8 Ritchey Chrétien CF OTA on EQ8 mount with homebrew 3D Balance and Pier
Moonfish ED80 APO & Celestron Omni XLT 120
QHY10 CCD & QHY5L-II Colour
9mm TS-OAG and Meade DSI-IIC

astropixel

  • Guest
Re: PixInsight Reference Documentation System
« Reply #38 on: 2010 October 02 11:22:45 »
Good documentation is a great selling point, not to mention an obvious benefit to users.

Offline Jaxdialation

  • Newcomer
  • Posts: 2
PixInsight Reference Documentation System
« Reply #39 on: 2010 October 26 17:06:47 »
This is a huge accomplishment! And very well done.

I now have no excuse for my incompetency.  So
here I go up another learning curve.  Wish me well.

   

Offline William McLaughlin

  • Member
  • *
  • Posts: 58
    • Images from the Night Sky
Re: PixInsight Reference Documentation System
« Reply #40 on: 2010 November 02 08:58:06 »
I am very glad to see this happening!  PixInsight has always been strong on features and somewhat weak on documentation. This has not been a good combination, especially for a new user. It is probably accurate to say that the interface is very different than most astro-imaging SW and this makes good documentation even more critical.

The hardest thing to do for documentation is always to make it intelligible for the newbie. This can be tough for someone that has deep knowledge as they often have a hard time thinking about the software in the same way one of us stupid newer PixInsight users does. What is obvious to an experienced user (much less the programmer), may be totally cryptic to a newbie.

In my particular case, since my imaging season is short and I am very fussy about data quality, I produce very few images (maybe 2-10 per year). What that means is that by the time I get more data and go to use PixInsight again, I may have forgotten a lot and have to relearn. This would be helped greatly by documentation that assumes absolutely no prior knowledge.

In fact, to date what I have been forced to do, especially for things where there are no good tutorials available, is to do screen captures and make notes as I puzzle things out so that I can refer to them next time around. Essentially making my own help files.

Having said all of the above, it is clearly the most powerful program of it's kind. Such programs are never easy to learn well. I have always told any non-user that asks to be prepared for a steep learning curve as PixInsight is truly the "Photoshop of astro-imaging SW". But if you want results, you have to pay that price in learning. Better documentation will help this greatly.
« Last Edit: 2010 November 02 09:09:39 by CCD-PIX »
Website: http://nightskypictures.com/

Observatory: http://nightskypictures.com/raptor-ridge.html

For every complex problem there is an answer
that is clear, simple, and wrong.

H. L. Mencken

Offline Emanuele

  • PixInsight Addict
  • ***
  • Posts: 270
Re: PixInsight Reference Documentation System
« Reply #41 on: 2010 December 21 01:35:21 »
Jaxdialation good to see you here!

I see that finally you have found the "light"! ;)

E.