projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Allow the title of top level pages to be overridden in the Atmel Studio help.
[pub/USBasp.git] / LUFA / StudioIntegration / makefile
diff --git a/LUFA/StudioIntegration/makefile b/LUFA/StudioIntegration/makefile
index 042a374..471ab6d 100644 (file)
--- a/LUFA/StudioIntegration/makefile
+++ b/LUFA/StudioIntegration/makefile
@@ -11,11 +11,23 @@
 
 LUFA_ROOT            := ..
 LUFA_VERSION_NUM     := $(shell grep LUFA_VERSION_STRING $(LUFA_ROOT)/Version.h | cut -d'"' -f2)
 
 LUFA_ROOT            := ..
 LUFA_VERSION_NUM     := $(shell grep LUFA_VERSION_STRING $(LUFA_ROOT)/Version.h | cut -d'"' -f2)
+
+ifneq ($(LUFA_VERSION_NUM),000000)
+  EXT_VERSION_NUM    := $(shell date +"%y.%m.%d").$(LUFA_VERSION_NUM)
+  EXT_VSIX_NAME      := LUFA-RELEASE-$(LUFA_VERSION_NUM).vsix
+else
+  EXT_VERSION_NUM    := 0.$(shell date +"%y%m%d.%H%M%S")
+  EXT_VSIX_NAME      := LUFA-TESTING-$(shell date +"%y.%m.%d-%H.%M.%S").vsix
+
+  $(warning No LUFA version set - assuming a test version should be created.)
+endif
+
 DOXYGEN_TAG_FILE_XML := $(LUFA_ROOT)/Documentation/lufa_doc_tags.xml
 DOXYGEN_COMBINED_XML := $(LUFA_ROOT)/Documentation/xml/lufa_doc.xml
 TEMP_MANIFEST_XML    := manifest.xml
 EXTENSION_OUTPUT_XML := $(LUFA_ROOT)/../extension.xml
 MODULE_OUTPUT_XML    := $(LUFA_ROOT)/asf.xml
 DOXYGEN_TAG_FILE_XML := $(LUFA_ROOT)/Documentation/lufa_doc_tags.xml
 DOXYGEN_COMBINED_XML := $(LUFA_ROOT)/Documentation/xml/lufa_doc.xml
 TEMP_MANIFEST_XML    := manifest.xml
 EXTENSION_OUTPUT_XML := $(LUFA_ROOT)/../extension.xml
 MODULE_OUTPUT_XML    := $(LUFA_ROOT)/asf.xml
+MSHELP_OUTPUT_XML    := $(LUFA_ROOT)/../lufa_help_$(EXT_VERSION_NUM).mshc
 XML_FILES            := $(filter-out $(TEMP_MANIFEST_FILE), $(shell ls *.xml))
 VSIX_ASSETS          := $(LUFA_ROOT)/DoxygenPages/Images/LUFA_thumb.png \
                         $(LUFA_ROOT)/DoxygenPages/Images/LUFA.png       \
 XML_FILES            := $(filter-out $(TEMP_MANIFEST_FILE), $(shell ls *.xml))
 VSIX_ASSETS          := $(LUFA_ROOT)/DoxygenPages/Images/LUFA_thumb.png \
                         $(LUFA_ROOT)/DoxygenPages/Images/LUFA.png       \
@@ -27,22 +39,21 @@ VSIX_ASSETS          := $(LUFA_ROOT)/DoxygenPages/Images/LUFA_thumb.png \
                         VSIX/GettingStarted.htm                         \
                         Blob/Atmel.Studio.Services.Interfaces.dll       \
                         Blob/LUFA.dll                                   \
                         VSIX/GettingStarted.htm                         \
                         Blob/Atmel.Studio.Services.Interfaces.dll       \
                         Blob/LUFA.dll                                   \
-                        Blob/LUFA.pkgdef
+                        Blob/LUFA.pkgdef                                \
 
 
-ifneq ($(LUFA_VERSION_NUM),000000)
-  EXT_VERSION_NUM    := $(shell date +"%y.%m.%d").$(LUFA_VERSION_NUM)
-  EXT_VSIX_NAME      := LUFA-RELEASE-$(LUFA_VERSION_NUM).vsix
-else
-  EXT_VERSION_NUM    := 0.$(shell date +"%y%m%d.%H%M%S")
-  EXT_VSIX_NAME      := LUFA-TESTING-$(shell date +"%y.%m.%d-%H.%M.%S").vsix
-
-  $(warning No LUFA version set - assuming a test version should be created.)
-endif
+MSHELP_GEN_PARAMS   := --stringparam generate.toc "book toc"            \
+                       --stringparam chunk.quietly "1"                  \
+                       --stringparam chunk.section.depth "3"            \
+                       --stringparam chunk.first.sections "1"           \
+                       --stringparam chapter.autolabel "0"              \
+                       --stringparam html.stylesheet "lufa_studio_help_styling.css"
 
 all: generate_xml check_filenames generate_vsix
 
 clean:
 
 all: generate_xml check_filenames generate_vsix
 
 clean:
-       @rm -f $(TEMP_MANIFEST_XML) $(MODULE_OUTPUT_XML) $(EXTENSION_OUTPUT_XML) $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML)
+       @rm -f $(TEMP_MANIFEST_XML) $(MODULE_OUTPUT_XML) $(EXTENSION_OUTPUT_XML) $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML) $(MSHELP_OUTPUT_XML)
+       @rm -rf mshelp
+       @cd $(LUFA_ROOT)/.. && rm -f contents.zip exampleProjects.xml content.xml.cache extension.vsixmanifest asf-manifest.xml extension.xml helpcontentsetup.msha $(notdir $(VSIX_ASSETS)) *.vsix *.mshc
 
 $(DOXYGEN_TAG_FILE_XML):
        @$(MAKE) -C ../ doxygen DOXYGEN_OVERRIDE_PARAMS="GENERATE_TAGFILE=Documentation/lufa_doc_tags.xml GENERATE_HTML=no GENERATE_XML=yes"
 
 $(DOXYGEN_TAG_FILE_XML):
        @$(MAKE) -C ../ doxygen DOXYGEN_OVERRIDE_PARAMS="GENERATE_TAGFILE=Documentation/lufa_doc_tags.xml GENERATE_HTML=no GENERATE_XML=yes"
@@ -71,29 +82,43 @@ $(EXTENSION_OUTPUT_XML): $(TEMP_MANIFEST_XML)
        @xsltproc XDK/lufa_extension_transform.xslt $< | xsltproc XDK/lufa_indent_transform.xslt - > $(EXTENSION_OUTPUT_XML)
        @echo "Atmel Studio extension.xml file generated."
 
        @xsltproc XDK/lufa_extension_transform.xslt $< | xsltproc XDK/lufa_indent_transform.xslt - > $(EXTENSION_OUTPUT_XML)
        @echo "Atmel Studio extension.xml file generated."
 
+$(MSHELP_OUTPUT_XML): $(DOXYGEN_COMBINED_XML)
+       @echo Converting Doxygen XML to Docbook...
+       @-mkdir mshelp 2> /dev/null
+       @xsltproc HV1/lufa_docbook_transform.xslt $(DOXYGEN_COMBINED_XML) > mshelp/lufa_docbook.xml
 
 
-generate_xml: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML)
+       @echo Converting Docbook XML to Microsoft Help 1.0...
+       @cd mshelp && xsltproc $(MSHELP_GEN_PARAMS) ../HV1/lufa_hv1_transform.xslt lufa_docbook.xml
+
+       @echo Copying help assets...
+       @cp HV1/lufa_studio_help_styling.css mshelp
+       @-mkdir mshelp/images 2> /dev/null
+       @cp `find $(LUFA_ROOT)/DoxygenPages/Images -type f` mshelp/images
 
 
-generate_vsix: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML)
-       @echo "Cleaning all projects..."
-       @make -C $(LUFA_ROOT)/../ clean
+       @echo Archiving help content...
+       @cd mshelp && zip ../$(MSHELP_OUTPUT_XML) -q -0  -r *.html *.css images
+
+
+generate_xml: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML)
 
 
+generate_vsix: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML) $(MSHELP_OUTPUT_XML)
        @echo "Generating ASF cache files..."
        @rm -f $(LUFA_ROOT)/../content.xml.cache
        @rm -f $(LUFA_ROOT)/../ExampleProjects.xml
        @python VSIX/generate_caches.py $(LUFA_ROOT)/../
 
        @echo "Generating ASF cache files..."
        @rm -f $(LUFA_ROOT)/../content.xml.cache
        @rm -f $(LUFA_ROOT)/../ExampleProjects.xml
        @python VSIX/generate_caches.py $(LUFA_ROOT)/../
 
-       @echo "Archiving Content..."
+       @echo "Archiving ASF content..."
        @rm -f contents.zip
        @cd $(LUFA_ROOT)/../ && zip contents.zip -q -0 -r --exclude=*Documentation* --exclude=*StudioIntegration* LUFA Bootloaders Demos Projects README.txt
 
        @rm -f contents.zip
        @cd $(LUFA_ROOT)/../ && zip contents.zip -q -0 -r --exclude=*Documentation* --exclude=*StudioIntegration* LUFA Bootloaders Demos Projects README.txt
 
-       @echo "Creating VSIX Dependencies..."
+       @echo "Creating VSIX dependencies..."
        @cp $(VSIX_ASSETS) $(LUFA_ROOT)/..
        @xsltproc --stringparam extension-version "$(EXT_VERSION_NUM)" VSIX/lufa_vsmanifest_transform.xslt VSIX/extension.vsixmanifest > $(LUFA_ROOT)/../extension.vsixmanifest
        @xsltproc --stringparam lufa-version "$(LUFA_VERSION_NUM)" VSIX/lufa_asfmanifest_transform.xslt VSIX/asf-manifest.xml > $(LUFA_ROOT)/../asf-manifest.xml
        @cp $(VSIX_ASSETS) $(LUFA_ROOT)/..
        @xsltproc --stringparam extension-version "$(EXT_VERSION_NUM)" VSIX/lufa_vsmanifest_transform.xslt VSIX/extension.vsixmanifest > $(LUFA_ROOT)/../extension.vsixmanifest
        @xsltproc --stringparam lufa-version "$(LUFA_VERSION_NUM)" VSIX/lufa_asfmanifest_transform.xslt VSIX/asf-manifest.xml > $(LUFA_ROOT)/../asf-manifest.xml
+       @xsltproc --stringparam extension-version "$(EXT_VERSION_NUM)" HV1/lufa_helpcontentsetup_transform.xslt HV1/helpcontentsetup.msha > $(LUFA_ROOT)/../helpcontentsetup.msha
 
 
-       @echo "Generating Atmel Studio VSIX Extension file..."
-       cd $(LUFA_ROOT)/../ && zip $(EXT_VSIX_NAME) -q -9 contents.zip exampleProjects.xml content.xml.cache extension.vsixmanifest asf-manifest.xml extension.xml $(notdir $(VSIX_ASSETS))
+       @echo "Generating Atmel Studio VSIX file..."
+       cd $(LUFA_ROOT)/../ && zip $(EXT_VSIX_NAME) -q -9 contents.zip exampleProjects.xml content.xml.cache extension.vsixmanifest asf-manifest.xml extension.xml helpcontentsetup.msha $(notdir $(MSHELP_OUTPUT_XML)) $(notdir $(VSIX_ASSETS))
        @echo "Atmel Studio VSIX Extension file generated."
 
 check_filenames: $(MODULE_OUTPUT_XML)
        @echo "Atmel Studio VSIX Extension file generated."
 
 check_filenames: $(MODULE_OUTPUT_XML)
@@ -113,4 +138,4 @@ check_filenames: $(MODULE_OUTPUT_XML)
 sanity_check:
        python ProjectGenerator/project_generator.py -b $(LUFA_ROOT)/../ --main-ext-uuid=0e160d5c-e331-48d9-850b-e0387912171b CHECK
 
 sanity_check:
        python ProjectGenerator/project_generator.py -b $(LUFA_ROOT)/../ --main-ext-uuid=0e160d5c-e331-48d9-850b-e0387912171b CHECK
 
-.PHONY: all clean generate_xml generate_vsix check_filenames
+.PHONY: all clean generate_xml generate_vsix check_filenames sanity_check
USB isp AVR programmer