diff options
| author | Gerald Combs <gerald@wireshark.org> | 2019-02-11 14:24:18 -0800 |
|---|---|---|
| committer | Gerald Combs <gerald@wireshark.org> | 2019-02-14 23:11:15 +0000 |
| commit | 23c9a1e036445c17ec4bbc5d0fcbea4f588253c1 (patch) | |
| tree | 37fa8cffa8ae7a2fd2cf42e3a1d85749ec3a40f3 /packaging/wix/ComponentGroups.wxi | |
| parent | ef0ef16c30a8a217645e06df47eb4e5718dabb0b (diff) | |
Convert the FAQ to Asciidoctor and remove old help files.
Convert our self-generating FAQ to Asciidoctor via the following steps:
- `help/faq.py > /tmp/faq.html`.
- `pandoc -t asciidoc -o docbook/faq.adoc /tmp/faq.html`.
- Manually clean up the markup using a text editor.
Question and answer content was left intact. Removing or updating
obsolete content will have to be done in a separate change.
The Asciidoctor project uses the .adoc extension, so start using it here
as well.
The contents of the "help" directory appear to have been used for
offline support in help_url.c, but that functionality was removed in
2008 in 242e3b78bc. Its content is covered in the User's Guide and man
pages so remove it.
Change-Id: I9060eefe97cfc137f8b414077c30f814379b576a
Reviewed-on: https://code.wireshark.org/review/32014
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Diffstat (limited to 'packaging/wix/ComponentGroups.wxi')
| -rw-r--r-- | packaging/wix/ComponentGroups.wxi | 53 |
1 files changed, 12 insertions, 41 deletions
diff --git a/packaging/wix/ComponentGroups.wxi b/packaging/wix/ComponentGroups.wxi index ba4709fc59..03f4caf851 100644 --- a/packaging/wix/ComponentGroups.wxi +++ b/packaging/wix/ComponentGroups.wxi @@ -221,44 +221,6 @@ </ComponentGroup> </Fragment> - <!-- Help files --> - <Fragment> - <DirectoryRef Id="dirHelp"> - <Component Id="cmpHelp_toc" Guid="*"> - <File Id="filHelp_toc" KeyPath="yes" Source="$(var.Help.Dir)\toc" /> - </Component> - <Component Id="cmpHelp_overview_txt" Guid="*"> - <File Id="filHelp_overview_txt" KeyPath="yes" Source="$(var.Help.Dir)\overview.txt" /> - </Component> - <Component Id="cmpHelp_getting_started_txt" Guid="*"> - <File Id="filHelp_getting_started_txt" KeyPath="yes" Source="$(var.Help.Dir)\getting_started.txt" /> - </Component> - <Component Id="cmpHelp_capturing_txt" Guid="*"> - <File Id="filHelp_capturing_txt" KeyPath="yes" Source="$(var.Help.Dir)\capturing.txt" /> - </Component> - <Component Id="cmpHelp_capture_filters_txt" Guid="*"> - <File Id="filHelp_capture_filters_txt" KeyPath="yes" Source="$(var.Help.Dir)\capture_filters.txt" /> - </Component> - <Component Id="cmpHelp_display_filters_txt" Guid="*"> - <File Id="filHelp_display_filters_txt" KeyPath="yes" Source="$(var.Help.Dir)\display_filters.txt" /> - </Component> - <Component Id="cmpHelp_faq_txt" Guid="*"> - <File Id="filHelp_faq_txt" KeyPath="yes" Source="$(var.Help.Dir)\faq.txt" /> - </Component> - </DirectoryRef> - </Fragment> - <Fragment> - <ComponentGroup Id="CG.Help"> - <ComponentRef Id="cmpHelp_toc" /> - <ComponentRef Id="cmpHelp_overview_txt" /> - <ComponentRef Id="cmpHelp_getting_started_txt" /> - <ComponentRef Id="cmpHelp_capturing_txt" /> - <ComponentRef Id="cmpHelp_capture_filters_txt" /> - <ComponentRef Id="cmpHelp_display_filters_txt" /> - <ComponentRef Id="cmpHelp_faq_txt" /> - </ComponentGroup> - </Fragment> - <!-- TShark --> <Fragment> <DirectoryRef Id="INSTALLFOLDER"> @@ -569,18 +531,27 @@ </ComponentGroup> </Fragment> - <?ifdef USER_GUIDE_DIR?> + <?ifdef DOCBOOK_DIR?> <!-- User Guide --> <Fragment> <DirectoryRef Id="INSTALLFOLDER"> <Component Id="cmpUserGuide_chm" Guid="*"> - <File Id="filUserGuide_chm" KeyPath="yes" Source="$(var.USER_GUIDE_DIR)\user-guide.chm" /> + <File Id="filUserGuide_chm" KeyPath="yes" Source="$(var.DOCBOOK_DIR)\user-guide.chm" /> + </Component> + </DirectoryRef> + </Fragment> + <!-- FAQ --> + <Fragment> + <DirectoryRef Id="INSTALLFOLDER"> + <Component Id="cmpFAQ_html" Guid="*"> + <File Id="filFAQ_html" KeyPath="yes" Source="$(var.DOCBOOK_DIR)\faq.html" /> </Component> </DirectoryRef> </Fragment> <Fragment> - <ComponentGroup Id="CG.UserGuide"> + <ComponentGroup Id="CG.Documentation"> <ComponentRef Id="cmpUserGuide_chm" /> + <ComponentRef Id="cmpFAQ_html" /> </ComponentGroup> </Fragment> <?endif?> |