Including a PDF file in SHFB generated .chm (Html Helpfile 1) - sandcastle

I need to include a pdf file in my sandcastle documentation. The user should be able to navigate to the pdf on clicking it in the .chm file. Is it possible to do this? I've been searching all forums with no proper answer.
I have tried using href tag in the xml comment and providing the url of the pdf file. But it opens the browser instead of the pdf file.
Has anyone done this before?

I have a download link for you:
http://www.help-info.de/files_download/CHM-example_project.zip
This is from my "HTMLhelp - Download" section (see link below) and you'll find a complete HH Workshop project and of course the resulting CHM file.
www.help-info.de/en/Help_Info_HTMLHelp/hh.htm
(1) So, please download and save to your local drive.
(2) Please unzip and you'll find a CHM-example.chm file.
(3) To open this file right-click the file, click Properties, and then click Unblock and OK
(4) Double-click to the file and resize the help window for your needs
(5) Open node "HTMLHelp Examples"
(6) Search for "Link to PDF .." in the TOC and open this topic
(7) Please note that the topics themselves include specific information.
So, go deeper into the code for your needs. Of course you must compile the CHM again after editing.
Hope that's it ;-)
Note there are tricky links from the TOC to "Volkswagen". You may need to go deeper into code here.
Ulrich Kulle - Microsoft Help MVP - (2007-2009) - http://www.help-info.de

Related

How to Merge PDF file with Annotation

i used this link 's code to merge pdf file ,pdf merge sucessfully with loss of annotation i want to merge pdf with annotattion i checked following link:
How to Merge Multiple PDF Files Into One PDF
Merge 2 pdf files in iOS
any other method to merge pdf file with annotation
Please Help me
For adding annotations to a PDF document I suggest you use this library which provides a sample code of PSPDFKIT. Also please follow this link which has loads of methods and libraries to add annotations to a PDF file. The first one is the PSPDFKIT itself which is free as a demo version but includes namely all kinds of functionalities you would need generally.
Create PDF Annotations in iOS
If you have Adobe Acrobat Pro you can:
open one of the pdf you want to merge
open the menu Comments (top right)
under "Comments List" click on the option icon cf the printscreen
select Import data file and select the second pdf

change html output doxygen link

I am working on a project that is heavily documented with doxygen.
In a UI I have a list of all the classes available - I would like to be able to open the right documentation page of the class I select. In order to do that I need an easy to read link, so I can dynamically build it and run it.
Is it there any way I can control the generated link of the html file? Because the ones I have right now are impossible do be built dynamically.
You could use Doxygen's tag file mechanism for that (see GENERATE_TAGFILE in the config file).
A tag file is a reasonably easy to understand and parse XML file that basically lists all symbols in your project, with for each symbol the corresponding (relative) URL to the documentation.
So you could parse the tag file from your UI to resolve the links to the doxygen generated documentation in a robust way.

How to export data from Chrome developer tool?

Network analysis by Chrome when page loads
I would like to export this data to Microsoft Excel so that I will have a list of similar data when loaded at different times. Loading a page one time doesn't really tell me much especially if I want to compare pages.
if you right click on any of the rows you can export the item or the entire data set as HAR which appears to be a JSON format.
It shouldn't be terribly difficult to script up something to transform that to a csv if you really need it in excel, but if you're already scripting you might as well just use the script to ask your questions of the data.
If anyone knows how to drive the "load page, export data" part of the process from the command line I'd be quite interested in hearing how
from Chrome 76, you have Import/Export buttons.
I was trying to copy the size data measured from Chrome Network and stumbled on this post. I just found an easier way to "export" the data out to excel which is to copy the table and paste to excel.
The trick is click Control + A (select all) and once the entire table will be highlighted, paste it to Microsoft Excel. The only issue is if there are too many fields, not all rows are copied and you might have to copy and paste several times.
UPDATED: I found that copying the data only works when I turn off the filter options (the funnel-looking button above the table). – bendur
Right-click and export as HAR, then view it using Jan Odvarko's HAR Viewer
This helps in visualising the already captured HAR logs.
I came across the same problem, and found that easier way is to undock the developer tool's video to a separate window! (Using the right hand top corner toolbar button of developer tools window)
and in the new window , simply say select all and copy and paste to excel!!
In Chrome, in the Developer Tools, under Network, in the Name column, right-click and select "Save as HAR with content". Then open a new tab, go to https://toolbox.googleapps.com/apps/har_analyzer/ and open the saved HAR file.
Note that ≪Copy all as HAR≫ does not contain response body.
You can get response body via ≪Save as HAR with Content≫, but it breaks if you have any more than a trivial amount of logs (I tried once with only 8k requests and it doesn't work.) To solve this, you can script an output yourself using _request.contentData().
When there's too many logs, even _request.contentData() and ≪Copy response≫ would fail, hopefully they would fix this problem. Until then, inspecting any more than a trivial amount of network logs cannot be properly done with Chrome Network Inspector and its best to use another tool.
You can use fiddler web debugger to import the HAR and then it is very easy from their on... Ctrl+A (select all) then Ctrl+c (copy summary) then paste in excel and have fun
I don't see an export or save as option.
I filtered out all the unwanted requests using -.css -.js -.woff then right clicked on one of the requests then Copy > Copy all as HAR
Then pasted the content into a text editor and saved it.
I had same issue for which I came here. With some trials, I figured out for copying multiple pages of chrome data as in the question I zoomed out till I got all the data in one page, that is, without scroll, with very small font size. Now copy and paste that in excel which copies all the records and in normal font.
This is good for few pages of data I think.
In more modern versions of Chrome you can just drag a .har file into the network tab of Chrome Dev Tools to load it.
To get this in excel or csv format- right click the folder and select "copy response"- paste to excel and use text to columns.
You can try use Haiphen, which is a chrome extension that allows you to analyze network traffic and what API calls a web application is making.

Use of doxygen's \link command

I have an external HTML file I'd like to have linked form either my doxygen "Related Pages" tab or the left hand frame. It seems I need to use the \link command but I can't find a good example of how to use it or where. I am currently using doxywizard to generate the HTML.
So, is \link something I incorporate into my doxygen config file or do I add it when I build the HTML somehow?
Update
So I ended up having to do the following:
Create a new page (docs_main.html) that had the following:
/*! \mainpage MY TITLE HERE
* \section intro_sec External resources
* My external page
*/
Include that page in my doxygen included files list
Rebuild my documentation
That added to my doxygen "Main Page" the following
MY TITLE HERE
My external page (which was a link to that page)
We have a Markdown support in doxygen nowadays. Your code may be a clearer:
/*! \mainpage MY TITLE HERE
* \anchor intro_sec
* # External resources
* [My external page](http://link_to_my_external_page.html)
*/
The above should render somewhat close to:
External resources
My external page
Doxygen allows you to insert certain HTML commands in to your documentation, including links. In case you didn't know this is how you make a link in HTML:
External file
cdiggins' answer is also worth reading.
The \link (and anything of the form \command or #command) is called a "special command" and is part of the mark-up used in the input files processed by Doxygen not part of the configuration. The \link command does not do what you want.
You could perhaps use the \page command to create a new related page and then use the \htmlinclude command to insert the external HTML file as the contents of that page.
As other answers here looks bits and pieces for a beginner, here is the complete procedure.
1) create an html file with content(ex:abc.html) as below
/*! \mainpage MY TITLE HERE
* \section intro_sec External resources
* My external page
*/
2) Add this file path in config file here
INPUT =
3)Also add your file type here
FILE_PATTERNS =
The above procedure opens your file in doxygen window
Add the below content to open the file in explorer
<b>My external page</b>
Note: If file doesn't open try giving absolute path
You can add a tab to the main navigation bar (with your link) by using a custom layout file.
Take a look at the Customizing the Output page of the Doxygen manual. It's pretty clear about how to do it, assuming I understood your question.

How can I simply add a downloadable PDF file to my page?

I want to add a pdf and word format of my resume to my portfolio page and make it downloadable. Does anyone have some simple script?
Add a link to the file and let the browser handle the download.
You may be over-complicating the problem. It's possible to use a href pointing to the location of the .pdf or .doc file, when a user clicks on this in their browser, generally they will be asked if they would like to save or open the file, depending on their OS/configuration.
If this is still confusing, leave a comment and I'll explain anything you don't get.
Create the PDF. Upload it. Add a link.
Save yourself 30 minutes tossing around with PDFGEN code.
You will want to issue or employ the Content-Disposition HTTP header to force the download otherwise some browsers may recognize the common file extensions and try to automatically open the file contents. It will feel more professional if the link actually downloads the file instead of launching an app - important for a resume I think.
Content-Disposition must be generated within the page from the server side as far as I know.
Option:
Upload your resume to Google Docs.
Add a link to the file on your portfolio page just as I do in the menu of my blog:
Use Google Docs Viewer passing to it the URL of the PDF as you can see in this link.