Adding a CHM help file in VSIX to distributed developer guide - vsix

I am writing VSIX to distribute a multi-project template with wizard for VS 2013, which allow user to write extensions for our application. I have problem in providing a user guide document, which is a chm file, along with template. VSIX manifest allow me to provide a "Getting Started Guide", however file support by these feature does not includes "CHM" file.
We use RoboHelp to create CHM, there is an option to create html files too. however the html files created are multiple files distributed into multiple folders (there is a index page, which has the link to all other html files). I am not sure how to package these files into VSIX.
I have few questions here;
Is it possible for us to run any script or batch file as part of
vsix installation?
Is it possible to create a Windiows Start manu folder to show a link to chm file?
If I point "Getting Started Guide" to any inner directory html file.
"Getting Started" link is not available in "Extensions and Updates",
is there any work around?
Am I doing all wrong? is there better way to provide a template &
help?
If i decide to deploy html help; I am thinking of deploying zipped copy of getting started help, which have many folder and files, then extract during the vsix installation. otherwise i need to mark each of those 100+ file as "Include in VSIX"

You can add the .chm (or any other file type) to the package project, select the file in the Solution Explorer, show the Properties window for the file (not for the project, and set the "Include in VSIX" property to true.

1: you can run any code on launch of your extension.
2: you can add any commands to the Tools menu

Made chm file as part of vsix and marked it as "Include in VSIX" as
suggested by #Carlos Quintero
Create a new Visual Studio Package project (using Templates -> Visual C# -> Extensibility -> Visual Studio Package) for adding a new menu item for our sdk help under VS IDE "Help" menu.Visual Studio Package wizard will be shown
Page 1) Welcome page
Page 2) Select a Programming Language: allow us to choose a programing language & way to sign the assembly
Page 3) Basic VSPackage Information: like company name, VSPackage name, icon, etc.
Page 4) Select VSPackage Options: Select Menu Command checkbox, This menu item will be added in VS IDE -> Tools
Page5) Command Options: Provided information for the menu, name & id.
After providing this information "Finish" the wizard using button
provided.
Open the ".vsct" file in the newly created project and look for "IDM_VS_MENU_TOOLS" and change it to "IDM_VS_MENU_HELP" move the menu item to VS IDE -> Help
MenuItemCallback method in the main class of the project to open chm file.
private void MenuItemCallback(object sender, EventArgs e){
string codeBase = System.Reflection.Assembly.GetExecutingAssembly().CodeBase;
UriBuilder uri = new UriBuilder(codeBase);
string path = Uri.UnescapeDataString(uri.Path);
string helpFilePath = string.Format("file://{0}\\myHelp.chm", System.IO.Path.GetDirectoryName(path))
System.Windows.Forms.Help.ShowHelp(null, helpFilePath); }

Related

How to open downloaded project?

I've downloaded example project in defold site. it's zip file, how to import it to defold? Do I must create new project and drag all file into it?
Sorry if this is beginner question, thank before.
I assume you mean these example projects?
If so, follow these steps:
Create a new project in Defold (from dashboard.defold.com) and open it in the editor
Right-click
"game.project" in the Project Explorer and select Show in Finder
(Mac) or Show in Explorer (PC)
Download and unpack the examples
archive you want
Drag the contents of the archive to the location of
the new project in the Finder/Explorer and replace the files in the
project The editor will pick up the new files and you are ready to
go
Alternatively you can add a project as a library dependency in your project ('importing' the files for read-only use). If so – add the zip url to the "dependencies" in the project section in "game.project" in Defold. See more about library usage here.
When you open a project for the first time or download, you need to create a "branch", whch is a copy of the project on your computer. Click "New branch" and name your local working copy (like "my work" or similar).
Also Check Your project compatiboly woth your OS Linux/ Windows and 32 bit or 62 bit.
You can learn basic thing from here .
http://www.defold.com/tutorials/getting-started/
Make sure you are using the latest editor and make sure to clear your browser cache.

Creating C/C++ source file in Eclipse

I am running Eclipse Mars.1 and a recent (latest?) Eclipse CDT on Fedora 23. I have a Java project and want to use C/C++ for media support. However, I can't get the IDE to create the first C file (or the second for that matter). I have created a new source folder under the Java src folder and verified that it has been created in the file system. When I R-click on that new folder and ultimately selected 'create C/C++ source file', I am presented with a 'New Source File' dialog with 2 edit fields. One is titled 'Source folder' and the other 'Source file'. No matter what I do in the 'Source folder' edit field, a status message displays that the folder doesn't exist. When I enter a file name the status field states that I haven't specified a directory. When I use the browse button to try to select a directory, nothing is displayed except a status message that says that there aren't any entries. I have enabled the C/C++ perspective, but that didn't make any difference.
I originally posted this message on the Eclipse CDT forum but didn't get an answer. I have also posted it on the Eclipse newcomers forum.
Any help or insight to resolve this difficulty would be greatly appreciated.
Java and C do mix well through the JNI. I will implement my backend media in GStreamer, so I don't really have any option. I want it to be portable to Windows, Linux and Android (iOS later). I know that the UI will be different on Android.
I did find the answer here -> http://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.cdt.doc.user%2Ftasks%2Fcdt_t_new_cpp.htm
I had searched for the answer earlier but never found it. I think that the key was to highlight the actual Java project (not the destination directory) in the project explorer pane, then R-click/new/file. I was able to select my folder that I had created before for the C files under the project and did successfully create and have now edited a C file.

Open multiple Projects/Folders in Visual Studio Code

How do I open multiple projects/folders in a single Visual Studio Code instance, and open multiple files in single view? Does it has any option for future change request?
Not sure why the simplest solution is not mentioned. You can simply do File>New Window and open the other project in the new window.
Update
This is now available out of the box as of October 2017. From the blog post:
This was our #1 feature request - it's been a while coming but it's here now.
The complete documentation is here.
You can work with multiple project folders in Visual Studio Code with multi-root workspaces. This can be very helpful when you are working on several related projects at one time. For example, you might have a repository with a product's documentation which you like to keep current when you update the product source code.
Original answer
Currently the Insider channel of VSCode gives us this out of the box.
Read more from the blog post.
Update
As mentioned in several other answers here, this 'accepted' answer is outdated and is no longer correct. VS Code now has the concept of a 'workspace' which lets you add several 'root' folders to VS Code in the same window.
For instance, when working on a project in one folder that utilizes shared code held in a different folder, you can now open both the project folder and the shared folder in the same window.
To do this you use the Add folder to Workspace... command. VS Code then saves this configuration in a new file with a .code-workspace extension. If you double-click that file, VS Code will re-open with both folders present.
Original Accepted Answer (Outdated)
As described in The Basics of Visual Studio Code article:
"VSCode is file and folder based - you can get started immediately by opening a file or folder in VSCode."
This means the concept of solution and project files, like the .sln and .csproj, have no real function in VSCode other than that it uses these only to target and identify which language to support for Intellisense and such.
Simply put, the folder you open is the root you work with. But of course there is nothing from stopping you to open multiple windows.
As for the request features options, navigate to Help > Request Features which will redirect you to the UserVoice page of VSCode.
Support for multi-root workspaces is now enabled by default in the latest stable release [November 2017 release].
The File > Add Folder to Workspace command brings up an Open Folder dialog to select the new folder.
If you are using unix like OS, you can create a soft link to your target folder.
E.g. I want to see golang source while I am using VSCode. So, I create a soft link to go/src under my project folder.
ln -s /usr/local/go/src gosrc
Hope this helps!
Update: 11/28, 2017
Multi Root Workspaces[0] landed in the stable build, finally.
https://code.visualstudio.com/updates/v1_18#_support-for-multi-root-workspaces
[0] https://github.com/Microsoft/vscode/issues/396
You can open any folder, so if your projects are in the same tree, just open the folder beneath them.
Otherwise you can open 2 instances of Code as another option
On Windows it's possible to use mklink to create directory symbolic links to the needed folders. Then keep them together in a folder, and VSCode will list the content of these.
c:\>mklink /D c:\dev\MyWork\scripts c:\ProjA\scripts
symbolic link created for c:\dev\MyWork\scripts <<===>> c:\ProjA\scripts
c:\>mklink /D c:\dev\MyWork\styles c:\ProjB\styles
symbolic link created for c:\dev\MyWork\styles <<===>> c:\dev\ProjB\styles
This is very similar to #NeilShen's idea, I guess.
Multiple Folders in VS
Click ->File ->Add Folder to Workplace.
Step 1.
Choose which project to work ->Add(press)
Step 2.
October 2017 (version 1.18):
Support for multi-root workspaces is now enabled by default in the Stable release: https://code.visualstudio.com/updates/v1_18#_support-for-multi-root-workspaces
Now we can open multiple folders in one instance, Visual studio code has named as Workspace ("Area de Trabajo"). Take a look at the images, it´s very simple.
Or you can just select multiple folders and then click open.
Go to File> Open Folder, then select multiple folders you want to open and click Select Folder
Just put your projects in the same folder and simply open that folder in vscode.
Now your projects will appear like:
GROUP OF PROJECTS
PROJECT 1
Contents
Contents
PROJECT 2
Contents
Contents
It's not possible to open a new instance of Visual Studio Code normally, neither it works if you open the new one as Administrator.
Solution: simply right click on VS Code .exe file, and click "New Window"
you can open as many new windows as you want. :)
You can install the Open Folder Context Menus for VS Code extension from Chris Dias
https://marketplace.visualstudio.com/items?itemName=chrisdias.vscode-opennewinstance
Restart Visual Studio Code
Right click a folder and select "Open New Workbench Here"
Open New Workbench Here
You can open up to 3 files in the same view by pressing [CTRL] + [^]
What I suggest for now is to create symlinks in a folder, since VSCode isn't supporting that feature.
First, make a folder called whatever you'd like it to be.
$ mkdir random_project_folder
$ cd random_project_folder
$ ln -s /path/to/folder1/you/want/to/open folder1
$ ln -s /path/to/folder2/you/want/to/open folder2
$ ln -s /path/to/folder3/you/want/to/open folder3
$ code .
And you'll see your folders in the same VSCode window.
you can create a workspace and put folders in that :
File > save workspace as
and drag and drop your folders in saved workspace
You can use this extension known as Project Manager
In this the projects are saved in a file projects.json, just save the project and by pressing Shift + Alt + P you can see the list of all your saved projects, from there you can easily switch your projects.
To run one project at a time in same solution
Open Solution explorer window -> Open Solution for Project -> Right click on it -> Select Properties from drop down list (Alt+Enter)-> Common Properties -> select Startup Project you will see "current selection,single selection and multiple selection from that select "Current Selection" this will help you to run one project at a time in same solution workspace having different coding.
You can simply add folders (as many you want) in your workspace as shown in this image:
Image
And use them unhesitatingly.

How to add a file as a link in Eclipse

In VS 2008 there is a nice feature that I can share a single file between two projects
How can i do the same in Eclipse (Android)
For Java, you can right click on the project and go to Properties then into Java Build Path. Under the Source tab you can click on the Link Source... button and then input the location of your common source directory - that will allow you to put all "shared" files in the one spot and link them into the projects you want.

How to use eclox, the doxygen plugin for Eclipse

How do I get eclox working in Eclipse 3.5?
I'm using Ubuntu 9.04. I installed Doxygen from ubuntu repositories(version 1.5.8). Then I installed eclox on eclipse through the update site.
Despite this, I don't get any option to in any menu to initiate it.
Also the eclox site doesn't seem to have any "getting started" guide.
Please help.
BTW there is a manual inside org.gna.eclox_0.8.0.jar, wierd they did not post this on the project site!!!
Here is the content
Eclox, a Doxygen frontend plugin for Eclipse.
<http://gna.org/projects/eclox>
INSTALLATION
There are two options to install the plugin: using the update site or
using the packaged feature.
The update site is the more convenient way to install eclox. It is
located at https://anb0s.github.io/eclox. See eclipse's user
guilde for additionnal details.
When using the packaged feature, you must extract the archive content into
your eclipse's root location. For additionnal details, please refer to
eclipse's user guide.
CONFIGURATION
Once the plugin installed, you must ensure that the default PATH environment
variable makes the doxygen binary reachable for the plugin. If not, you can
update PATH to include to directory containing the Doxygen binary, or you can
tell Eclox where that binary is located on your system (which is in my opinion
the better solution). To do this, open eclipse's preference edition dialog
window and go into the new "Doxygen" section.
USAGE
You can create new Doxygen projects (also called doxyfiles) using the
creation wizard. Go to "File->New->Other->Other->Doxygen Configuration". Press
next and set both file location and name. Then a empty doxyfile will be
created at the specified location, the wizard automatically adds the
".Doxyfile" extension.
You should now see a file with a blue #-sign icon. This is your new
doxyfile. Double-clicking on it will open the editor. You can now browse and
edit the settings.
Once your have properly set all doxyfile fields, you can launch a
documentation build using the toolbar icon showing a blue #-sign. In
the case the button is not visible in the toolbar, your current perspective
needs to get configured. Go to "Window->Customize perspective->Commands" and
in "Available command groups" check "Doxygen". Additionnaly, you can browse
the laetest builds by clicking the down arrow right to the toolbar button.
When the documentation build starts, a new view showing the build log opens.
In its toolbar, a button named "Stop" allows you to halt the current build
process. The current build also appears in the Eclipse job progress view and
you can control the job from there.
The build toolbar action determine the next doxyfile to build depending on
the current active workbench part (editor or view) and the current selection
in that part. For example, if the active part is a doxyfile editor, the next
doxyfile to build will be the one being edited. If the active part is the
resource explorer and the current selection is a doxyfile, that doxyfile will
be next to get build. In the case the active part selection doesn't correspond
to a doxyfile, the last built doxyfile will be rebuiled. And if the build
history is empty, you will be asked for the doxyfile to build.
HTH Anybody
Never mind, worked it out my self.
First you need to create a DoxyFile (which is the configuration file) by giving the source path and the output path.
Then only you can generate the documentation by right clicking the project and selecting the "Generate Documentation".
Thanks anyway!
I just faced a problem setting the Doxygen binary path in eclox 0.8.0 settings in Eclipse on Mac OS X 10.7.
There is no way to configure the path via Eclipse-preferences->Doxygen.
The solution is to edit the preferences file manually
add a (fake) location, let's say /Applications, using the wizard mentioned above.
close Eclipse
edit this file:
$WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefs:
Replace the value for doxygen.default (currently eclox.core.doxygen.CustomDoxygen /Applications\n) with eclox.core.doxygen.CustomDoxygen /Applications/Doxygen.app/Contents/Resources/doxygen\n.
restart Eclipse
For MacOS user there is a very easy way to get around via the issue of the Doxygen version selection. The link that provides details is here:https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse
After installing the Eclox plugging:
1)"go to "Eclipse --> Preferences --> Oxygen"
2)"Press Shift+CMD+G then Add: "/Applications/Doxygen.app/Contents/Resources/doxygen"
3) Doxygen's version should be displayed
this might help you or any windows user trying to install eclox:
Tutorial for Installing eclox — Document Transcript
Step 1: go to eclox website (http://home.gna.org/eclox/) and to copy the update link address.Step
step 2: Insert the link into the update manager in eclipse and press OK.
Step 3: Select the Eclox item and to complete the installation.
Step 4: When the installation has done, you should select a project that you want to generate thedoxygen documents. Then, create a doxygen project for it.
Step 5: config the options. Note: You have to provide the “Input directories” correctly and to select the “Scan recursively”item. Finally, save the configuration file.
Step 6: find out the “#” and to choice “Choose Doxyfile...”.
Step 7: select a doxyfile.Step 8: wait for few seconds and the doucments will be generated.
its from this link: http://www.slideshare.net/pickerweng/tutorial-for-installing-eclox
Like claus I had to dig into the preferences file maually, because eclox 0.8.0 would just not take a good path from Eclipse Preferences file chooser.
So, edit this file: $WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefs and alter the given path (in my case I had to change from
doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programm Files\\doxygen\\bin
to this
doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programme\\doxygen\\bin
Hope this helps.
I find a webpage https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse where you can find more details. Especially, for Mac users, you need to Press Shift+CMD+G then Add: "/Applications/Doxygen.app/Contents/Resources/doxygen" when you configure the doxygen in eclipse before compiling .doxygfile by using Eclox.
Alternative from eclipse is to use Javadoc:
From menu (...Search Project Run...)
Project > Generate Javadoc
You should be in Java project and add comments with tags.
!!!