Hello,
We've been manually creating a developer's guide that contains such details as code samples, the methods and classes, and their descriptions and comments. So far, developers send us the content, we copy and paste it into Flare and format it. This is very time consuming.
I just found the Syntax highlighter tool and this might help me with the code sample formatting. However, there must be a way in which we can take the information from the code and import it (as automatically as possible into Flare).
Sandcastle (a documentation compiler) is able to extract all this information and dump it into an HTML Help (.chm) format. In fact, it looks pretty good as it retains all the style and formatting. It even has a full Index plus search capabilities. Is there any way to use this tool (or something similar) and generate it into an XHTML file that Flare can easily import?
Thanks!
Importing Code into Flare
-
RamonS
- Senior Propellus Maximus
- Posts: 4293
- Joined: Thu Feb 02, 2006 9:29 am
- Location: The Electric City
Re: Importing Code into Flare
There are CHM decompilers that create HTML files (google for it, there are also freeware tools). You can import these files into Flare. As far as styling is concerned, I am not sure if that will come over, but you will find out.
New Book: Creating user-friendly Online Help
Paperback http://www.amazon.com/dp/1449952038/ or https://www.createspace.com/3416509
eBook http://www.amazon.com/dp/B005XB9E3U

Paperback http://www.amazon.com/dp/1449952038/ or https://www.createspace.com/3416509
eBook http://www.amazon.com/dp/B005XB9E3U
Re: Importing Code into Flare
Sandcastle can also output documentation as HTML files as well as a CHM; I'd ask your developers to do that and see how 'importable' it is.
-
alienwriter
- Propeller Head
- Posts: 11
- Joined: Tue Jul 13, 2010 2:36 pm
Re: Importing Code into Flare
Yes, they are in the process of doing that.
I am now able to 'automate' a few things so my code samples look a bit better without too much effort. In the meantime, I will keep on searching for something better. Thanks for your replies!
I am now able to 'automate' a few things so my code samples look a bit better without too much effort. In the meantime, I will keep on searching for something better. Thanks for your replies!
Re: Importing Code into Flare
I have very similar requirements, and I'm looking into using Sandcastle output with Flare. I'd love to hear what you came up with. Have you been able to automat the process? Which Sandcastle output are you using?
-
alienwriter
- Propeller Head
- Posts: 11
- Joined: Tue Jul 13, 2010 2:36 pm
Re: Importing Code into Flare
We didn't end up using Sandcastle. Surprisingly, the output (code samples) was not formatted?!
We ended up manually copying code and pasting it on a Flare topic. We did use Syntax Highlighter to format our code and it's working quite well.
You can see the steps on how used Syntax Highlighter here:
http://kungfuwit.wordpress.com/2010/12/ ... hter-2010/
Let me know if you have any questions!
We ended up manually copying code and pasting it on a Flare topic. We did use Syntax Highlighter to format our code and it's working quite well.
You can see the steps on how used Syntax Highlighter here:
http://kungfuwit.wordpress.com/2010/12/ ... hter-2010/
Let me know if you have any questions!
-
mmtechwriter
- Jr. Propeller Head
- Posts: 6
- Joined: Mon Feb 21, 2011 9:00 pm
Re: Importing Code into Flare
I will greatly appreciate if you could please help me in implementing those steps.alienwriter wrote:You can see the steps on how used Syntax Highlighter here:
http://kungfuwit.wordpress.com/2010/12/ ... hter-2010/
Let me know if you have any questions!
My project has numerous topics and nearly all of them use large code snippets. I wish to use master page to keep highlighting scripts at one place to avoid copying these to each topic manually. However, I couldn't understand the steps mentioned in the above link.
[Just to add - The steps mentioned in an older post: http://kungfuwit.wordpress.com/2009/06/ ... cap-flare/ worked well in Flare 6. However that procedure required me to manually edit the source of all the topics (having code snippets) one by one, which doesn't look like a error-free solution.]
Will look forward to your reply.
Thanks