plumed2 icon indicating copy to clipboard operation
plumed2 copied to clipboard

Separate pdf files for modules and/or tutorials

Open GiovanniBussi opened this issue 8 years ago • 5 comments

@carlocamilloni @maxbonomi I noticed that in the supp info of the PLUMED-ISDB paper you copied part of the pdf manual, I think that's a good idea. Though I see that you "brutally" took part of the whole pdf manual.

I was wondering if we should try to improve a bit the pdf manual in general. In particular, there are currently problems with figures. In addition, I think the manual as a whole is too long, and shorter sections as you did might be more useful.

It would be nice to generate sub-parts of the manual. E.g., imagine a single pdf file for a tutorial or for a module (such as the one that you did for PLUMED-ISDB, but starting from page 1 and including only the relevant references), where links that are not solved can be redirected to the online manual.

Could this make sense?

Giovanni

GiovanniBussi avatar Aug 29 '17 13:08 GiovanniBussi

Absolutely yes! We were kind of lazy ;-)

Do you think it is hard to do?

Sent from my Nexus. Please excuse typos and brevity.

On Aug 29, 2017 3:41 PM, "Giovanni" [email protected] wrote:

@carlocamilloni https://github.com/carlocamilloni @maxbonomi https://github.com/maxbonomi I noticed that in the supp info of the PLUMED-ISDB paper you copied part of the pdf manual, I think that's a good idea. Though I see that you "brutally" took part of the whole pdf manual.

I was wondering if we should try to improve a bit the pdf manual in general. In particular, there are currently problems with figures. In addition, I think the manual as a whole is too long, and shorter sections as you did might be more useful.

It would be nice to generate sub-parts of the manual. E.g., imagine a single pdf file for a tutorial or for a module (such as the one that you did for PLUMED-ISDB, but starting from page 1 and including only the relevant references), where links that are not solved can be redirected to the online manual.

Could this make sense?

Giovanni

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/plumed/plumed2/issues/271, or mute the thread https://github.com/notifications/unsubscribe-auth/ACj-wYxOAq6OYC9smep7fTocuE9NOqt2ks5sdBTqgaJpZM4PF8-Y .

maxbonomi avatar Aug 29 '17 13:08 maxbonomi

I don't know... The only way is to try :-)

I would say the first thing to do would be to fix the image inclusion so that they appear in the pdf (otherwise at least tutorials would be sort of useless).

The other thing that might be a bit tricky is to find which links are missing so as to redirect them online.

Doxygen produces a standard .tex file, so perhaps the easiest way is to process that file with some script.

GiovanniBussi avatar Aug 29 '17 13:08 GiovanniBussi

Will give a look this week and try to do it!

Sent from my Nexus. Please excuse typos and brevity.

On Aug 29, 2017 15:51, "Giovanni" [email protected] wrote:

I don't know... The only way is to try :-)

I would say the first thing to do would be to fix the image inclusion so that they appear in the pdf (otherwise at least tutorials would be sort of useless).

The other thing that might be a bit tricky is to find which links are missing so as to redirect them online.

Doxygen produces a standard .tex file, so perhaps the easiest way is to process that file with some script.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/plumed/plumed2/issues/271#issuecomment-325670606, or mute the thread https://github.com/notifications/unsubscribe-auth/ACj-wYPJmRWqDJ75ZbaGdGL9hJ3AdaBUks5sdBd5gaJpZM4PF8-Y .

maxbonomi avatar Aug 29 '17 14:08 maxbonomi

Let me know if you need help. In case you can also take advantage of doxygen aliases (there is example now already used to get inspiration)

GiovanniBussi avatar Aug 29 '17 14:08 GiovanniBussi

Ok!

Sent from my Nexus. Please excuse typos and brevity.

On Aug 29, 2017 16:25, "Giovanni" [email protected] wrote:

Let me know if you need help. In case you can also take advantage of doxygen aliases (there is example now already used to get inspiration)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/plumed/plumed2/issues/271#issuecomment-325680915, or mute the thread https://github.com/notifications/unsubscribe-auth/ACj-wX3LE0E-XjpRDQhEy_dei9MBNb35ks5sdB9ngaJpZM4PF8-Y .

maxbonomi avatar Aug 29 '17 14:08 maxbonomi