Quantcast
Channel: Sandcastle Help File Builder
Viewing all 2184 articles
Browse latest View live
↧

New Post: Conceptual documentation tutorial / walkthrough?

January 3, 2013, 11:59 am
$
0
0

Hello. Could someone please suggest a good tutorial/walkthrough that introduces how to start creating the conceptual part of my documentation? I have all the API documentation done but I'm at a loss as to how to create the conceptual stuff with MAML + Sandcastle Help File Builder GUI. I saw the Sandcastle MAML guide but it seems to only discuss MAML syntax. I really need something that explains how to add the MAML to my VS2010 project and set it up to work with Sandcastle. Do I just add an empty XML file to the project and start typing? Do I need to configure Sandcastle in some way?

I found this: http://www.codeproject.com/Articles/22539/Sandcastle-Conceptual-Help-Quick-Start

but it's ancient. Thank you in advance.

↧
Search

New Post: Conceptual documentation tutorial / walkthrough?

January 3, 2013, 12:37 pm
$
0
0

See the Conceptual Content section of the SHFB help file and its sub-topics.  They describe the conceptual content file types that you can add to the project.  I'll make a note to add a proper walkthrough and see if I can get it in the next release.

To get started, all you need to do is add a Content Layout file to the project and open it for editing.  Add topics to the content layout file as it controls which ones appear in the help file and their layout in the TOC.  When added to the layout file, they are automatically added to the project as well.  You can organize the topics in the project in folders to match the layout file or leave them all in the root of the project if there aren't that many.  I typically organize the project files to match the content layout file so they are easier to locate for editing without having to open the layout file.  The Topic Previewer Window is a big help as it lets you preview the topics while you are developing them without having to build the entire help file.

If you have other questions, feel free to ask.

Eric

 

↧
↧

New Post: Conceptual documentation tutorial / walkthrough?

January 3, 2013, 12:48 pm
$
0
0

Thanks for the quick reply Eric. I'll give it a shot.

↧

Created Issue: Inconsitency in folder naming leads to problems when uploading generated html to web servers running case-sensitive os [33641]

January 4, 2013, 3:50 am
$
0
0
SHFB outputs inconsistent folder names and generated url paths to those; the 'styles' folder is created as 'Styles' but is sometimes referred to as 'Styles' in urls, and sometimes as 'styles'.

Also, the contained Presentation.css is alternately referred to as 'presentation.css' and 'Presentation.css' in generated urls.

Whilst this is not a problem when hosting the html on a Windows Web Server, it does become problematic when hosting the generated content on a case-sensitive OS, like Linux.

The folder naming and the corresponding url generation should be consistent.

I am using the VS2010 target.
↧

Closed Issue: Inconsitency in folder naming leads to problems when uploading generated html to web servers running case-sensitive os [33641]

January 4, 2013, 7:56 am
$
0
0
SHFB outputs inconsistent folder names and generated url paths to those; the 'styles' folder is created as 'Styles' but is sometimes referred to as 'Styles' in urls, and sometimes as 'styles'.<br><br>Also, the contained Presentation.css is alternately referred to as 'presentation.css' and 'Presentation.css' in generated urls.<br><br>Whilst this is not a problem when hosting the html on a Windows Web Server, it does become problematic when hosting the generated content on a case-sensitive OS, like Linux.<br><br>The folder naming and the corresponding url generation should be consistent.<br><br>I am using SHFB 1.9.5.0 with the VS2010 target.
Comments:

This issue was resolved and is working as expected in the latest release.

↧
↧

Patch Uploaded: #13576

January 4, 2013, 1:56 pm
$
0
0

skonves has uploaded a patch.

Description:
Updated MRefBuilder: implemented IEnumerable<T> interfaces on each list class and implemented IEnumerator<T> on each list classes' internal enumerator struct. The original GetEnumerator() methods on each list class are now explicit implementations of the non-generic IEnumerable interface.

This allows the usage of Linq extension methods with all list classes defined in ListTemplate.cs.

↧

New Post: Line break in MAML block?

January 4, 2013, 4:59 pm
$
0
0

Hello. I've been looking around and I can't seem to induce a line break/new line in a <para></para> block. I've tried to the following but it didn't work:

<para>
Line 1 text. <lineBreak/>
Line2 text. <lineBreak/>
</para>

Is there a trrick to doing this? Thanks in advance. 

↧

New Post: Line break in MAML block?

January 4, 2013, 7:23 pm
$
0
0

There isn't a lineBreak element though one could be added.  I'm not sure its really needed.  Simply doing the following would achieve the same results though with paragraph spacing:


<para>Line 1 text</para>

<para>Line 2 text</para>

If your intent is to show some arbitrarily formatted text in a block, you could use the code element with a language of "none".

Eric

 

↧
Search

New Post: Problems with in MAML

January 5, 2013, 5:04 pm
$
0
0

Sorry for the delay in replying.  I took a look at the project and found the issue.  The problem here is that the ID values must match exactly including the spacing.  In your case, you appear to have entered them by hand or adjusted the formatting to include a space after the comma in the parameter list of the member IDs.  This causes a mismatch in the ID resulting in the unknown/invalid link messages.  Removing the extra spaces in the affected links will fix the issue.

Eric

 

↧
↧

New Post: Typographical error exists in the Japanese localization ("宣伝" of VisualBasicDeclaration)

January 5, 2013, 9:38 pm
$
0
0

I found a typo in the Japanese localization files will be reported.

 

Presentation\hana\Content\ja-JP\conceptual_content.xml(56): <item id="VisualBasicDeclaration"><include item="VisualBasic"/> (宣伝)</item>

 

宣伝:Advertising

宣言:Declaration

 

Below are the results of grep.

 

Presentation\hana\Content\ja-JP\shared_content.xml(50): <item id="declarationLabel">宣伝</item>
Presentation\Prototype\content\ja-JP\reference_content.xml(47): <item id="syntaxTitle">宣伝の文法</item>
Presentation\Shared\content\ja-JP\syntax_content.xml(12): <item id="UnsupportedStaticClass_VisualBasic">Visual Basicは静的クラスの宣伝をサポートしていません。</item>
Presentation\Shared\content\ja-JP\syntax_content.xml(28): <item id="UnsupportedStructure_JScript">JScriptは構造の利用をサポートしていますが、新しい構造の宣伝はサポートしていません。</item>
Presentation\Shared\content\ja-JP\syntax_content.xml(30): <item id="UnsupportedCast_JScript">JScriptは新しいキャストオペレータの宣伝をサポートしていません。</item>
Presentation\Shared\content\ja-JP\syntax_content.xml(39): <item id="UnsupportedStructure_JavaScript">JavaScriptは構造を利用をサポートしていますが、新しい構造の宣伝はサポートしていません。</item>
Presentation\Shared\content\ja-JP\syntax_content.xml(41): <item id="UnsupportedCast_JavaScript">JavaScriptは新しいキャストオペレータの宣伝をサポートしていません。</item>
Presentation\Shared\content\ja-JP\syntax_content.xml(45): <item id="UnsupportedStaticClass_VisualBasicUsage">メンバーをアクセスするために、staticクラスのインスタンスを宣伝する必要はありません。</item>
Presentation\vs2005\Content\ja-JP\shared_content.xml(114): <item id="VisualBasicDeclaration"><include item="VisualBasic"/> (宣伝)</item>

↧

New Post: Typographical error exists in the Japanese localization ("宣伝" of VisualBasicDeclaration)

January 6, 2013, 11:26 am
$
0
0

I don't currently have a set of Japanese translations for the current version of Sandcastle.  If the files you have are for the current release (v2.7.2.0) or can be updated for it and you don't mind sharing them, I can add them to a future release.  My e-mail address is in the About box of the SHFB standalone GUI and in the footer of the pages of the SHFB help file.  Thanks.

Eric

 

↧

New Post: Problems with in MAML

January 7, 2013, 12:34 am
$
0
0

No problem. Today it is my first day at work in this year. I was also on christmas holidays.
Thank you for your support. The spaces were the problem. Now everthing works fine. :-)

Manuel

↧

New Post: Percent sign after out paramter in MS Help Viewer

January 7, 2013, 4:02 am
$
0
0

I have a C# methode with an out paramter.

For instance:
public static bool Ready(out bool enabled)

In the MS Help Viewer paramter list is a percent character after the type.

Parameters
enabled
Type: System::Boolean%
Points to a variable that receives the enable state of the keys: true if the keys are enabled or false if the keys are disabled.

This effect occurs only in MS Help Viewer at methods with out paramteres. In the Help 1 and Help 2 format is the paramter without the percent sign.

Is this an known issure or is ther a workaround or option to fix it?

Manuel

↧
↧

New Post: Additional non .NET languages

January 9, 2013, 2:39 pm
$
0
0

Eric, thank you for the prompt response.

Here is what I did:

1. \Presentation\vs2010\Branding\ps-codesnippet.xslt

 

<xsl:variablename="groupedLanguages"><value>C#</value><value>Visual Basic</value><value>PHP</value></xsl:variable>



2.  \Presentation\vs2010\Content\shared_content.xml and \Presentation\vs2010\Content\shared_content_mshc.xml:

<!-- devlang --><itemid="devlang_VisualBasic">Visual Basic</item>
...<itemid="devlang_PHP">PHP</item>

  

3. \Presentation\vs2010\transforms\codeTemplates.xsl:

<xsl:templatename="t_codeLang"><xsl:paramname="p_codeLang"/><xsl:variablename="v_codeLangLC"select="translate($p_codeLang,$g_allUpperCaseLetters,$g_allLowerCaseLetters)"/><xsl:choose><xsl:whentest="$v_codeLangLC = 'vbs' or $v_codeLangLC = 'vbscript'"><xsl:text>VBScript</xsl:text></xsl:when>
     .....<xsl:whentest="$v_codeLangLC = 'PHP'"><xsl:text>PHP</xsl:text></xsl:when><xsl:whentest="$v_codeLangLC = 'none'"><xsl:value-ofselect="$v_codeLangLC"/></xsl:when><xsl:otherwise><xsl:text>other</xsl:text></xsl:otherwise></xsl:choose></xsl:template>

and

<xsl:templatename="t_codeLangName"><xsl:paramname="p_codeLang"/><xsl:variablename="v_codeLangUnique"><xsl:call-templatename="t_codeLang"><xsl:with-paramname="p_codeLang"select="$p_codeLang"/></xsl:call-template></xsl:variable><xsl:choose><xsl:whentest="$v_codeLangUnique = 'VBScript'"><xsl:text>VBScript</xsl:text></xsl:when>
    ...<xsl:whentest="$v_codeLangUnique = 'PHP'"><xsl:text>PHP</xsl:text></xsl:when><xsl:otherwise/></xsl:choose></xsl:template>

and

<xsl:templatename="t_codeLangTitleId"><xsl:paramname="p_codeLang"/><xsl:variablename="v_codeLangUnique"><xsl:call-templatename="t_codeLang"><xsl:with-paramname="p_codeLang"select="$p_codeLang"/></xsl:call-template></xsl:variable><xsl:choose><xsl:whentest="$v_codeLangUnique = 'VisualBasic'"><xsl:value-ofselect="'devlang_VisualBasic'"/></xsl:when>
     ....<xsl:whentest="$v_codeLangUnique = 'Python'"><xsl:value-ofselect="'devlang_Python'"/></xsl:when><xsl:whentest="$v_codeLangUnique = 'PHP'"><xsl:value-ofselect="'devlang_PHP'"/></xsl:when><xsl:otherwise/></xsl:choose></xsl:template>

and

<xsl:templatename="t_mshelpCodelangAttributes"><xsl:paramname="snippets"/><xsl:for-eachselect="$snippets"><xsl:iftest="not(@language=preceding::*/@language)"><xsl:variablename="v_codeLang"><xsl:choose><xsl:whentest="@language = 'VBScript' or @language = 'vbs'"><xsl:text>VBScript</xsl:text></xsl:when>
         ....<xsl:whentest="@language = 'PHP'"><xsl:text>PHP</xsl:text></xsl:when><xsl:otherwise><xsl:text>other</xsl:text></xsl:otherwise></xsl:choose></xsl:variable><xsl:choose><xsl:whentest="$v_codeLang='other'"/><!-- If $v_codeLang is already authored, then do nothing --><xsl:whentest="/document/metadata/attribute[@name='codelang']/text() = $v_codeLang"/><xsl:otherwise><xsl:call-templatename="t_codeLangAttr"><xsl:with-paramname="p_codeLang"select="$v_codeLang"/></xsl:call-template></xsl:otherwise></xsl:choose></xsl:if></xsl:for-each></xsl:template>
 

 

4. The comment section is defined as following:

<codelanguage="PHP">
.....</code>



The section with PHP code still renders below C# and  VB and it does not have any title (e.g. - "PHP")

Am I missing something?

Thank you 

Ivan


 

↧

New Post: How to remove "Send Feedback"?

January 9, 2013, 3:03 pm
$
0
0

Well...I'm using a "Post-transform Component" to insert a logo, but that's it. I think I'll give up on this modification for now.

One more question...should I have a "Colorizer" folder in the Sandcastle folder? I can't see one and I'd like to try the advice you gave in this thread:

http://shfb.codeplex.com/discussions/393426

Thank you in advance, L

↧
Search

New Post: Additional non .NET languages

January 9, 2013, 3:05 pm
$
0
0

Eric,

 I have found the issue:

<xsl:whentest="$v_codeLangLC = 'PHP'"><xsl:text>PHP</xsl:text></xsl:when>
should be
<xsl:whentest="$v_codeLangLC = 'php'"><xsl:text>PHP</xsl:text></xsl:when>
 Thank you very much for pointing me to the right direction.


Ivan 

↧

New Post: How to remove "Send Feedback"?

January 9, 2013, 7:12 pm
$
0
0

Okay, you are using an older version as the Post-Transform component has been superceded by the Transform Arguments property page in v1.9.6.0.  There were some problems with the SelfBranded property in earlier releases so that's probably what you are running into.  The link you are seeing is coming from the help viewer not the Sandcastle transformations.  It won't appear when built with the latest release.  Also, the latest release lets you place the logo wherever you want, not just on the right in the VS2010 style.

The Colorizer folder is part of SHFB so you'll find it in its installation folder (C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder).  If you add the Code Block Component to your project, you can override the syntax rules file it uses.  Modifying the one in the SHFB folder will make the changes permanent for all projects.

Eric

↧
↧

New Post: Percent sign after out paramter in MS Help Viewer

January 10, 2013, 12:30 am
$
0
0

Hi Eric,

you are right. The VS2010 is a little bit sticky. C# was the default language. Fist I selected VB and then C# and the percent sign was never shown.

Thank you for your quick answer!

↧

New Post: How to compile with msbuilder when the project have plugin ?

January 10, 2013, 2:41 am
$
0
0

Hello everybody,

I'm doing a help site for a project for my compagny with Sandcastle.

We allready made a new style, translated the VS2005 one in french (there is still some hardcoded english in it by the way), made a custom style from this base and so on.

We commited the style and the source of our sandcastle project on an SVN server. Then we commited a .bat file to compile the project via msbuild.

This .bat work flawlessly, when used on a pre-installed sandcastle computer like mine. The problem is when I want to compile from a computer where sandcastle is not installed, the batch fails like this :

SHFB: Error BE0028: Plug-in loading errors:
Error: Unable to locate plug-in 'Additional Content Only' or it is of a version that is not supported by this version of the help file builder
Error: Unable to locate plug-in 'Additional Reference Links' or it is of a version that is not supported by this version of the help file builder

So I am imagining that I could put some missing dlls somewhere on these no-sandcastle computers (and then register these dlls) so msbuild could compile the sandcastle project.

Am I rigth ? If so, what dll files should I seek on my computer to put on the SVN ?

↧

New Post: error MSB6006: "HHC.EXE" exited with code -1073741515.

January 10, 2013, 4:27 am
$
0
0

Compiling HTML Help 1 file...[C:\Windows\Microsoft.NET\Framework64\v3.5\MSBuild.exe]C:\output\Working\Build1xHelpFile.proj(41,5): error MSB6006: "HHC.EXE" exited with code -1073741515.C:\output\Working\Build1xHelpFile.proj(52,5): error MSB3021: Unable to copy file "C:\output\Working\Output\Documentation.chm" to "C:\output\\Documentation.chm". Could not find file 'C:\output\Working\Output\Documentation.chm'.    Last step completed in 00:00:00.1200-------------------------------
SHFB: Error BE0043: Unexpected error detected in last build step.  See output above for details.

 

i cant able to generate the chm file in my machine.

Sandcastle is showing the above error.It was urgent for me to generate chm file.Please help me

↧
Viewing all 2184 articles
Browse latest View live
Search
<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>