LUFA Help

From dd723813d922b5fd27946787cf42b9881ab2eb46 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 21 Apr 2013 12:15:57 +0000 Subject: Add HV1 integration into Atmel Studio (native Help). --- LUFA/StudioIntegration/Blob/LUFA.dll | Bin 377856 -> 378880 bytes .../Docbook/mshelp/placeholder.txt | 1 + LUFA/StudioIntegration/Docbook/placeholder.txt | 1 + LUFA/StudioIntegration/HV1/helpcontentsetup.msha | 19 ++++++++ .../HV1/lufa_helpcontentsetup_transform.xslt | 54 +++++++++++++++++++++ LUFA/StudioIntegration/VSIX/[Content_Types].xml | 2 + LUFA/StudioIntegration/VSIX/extension.vsixmanifest | 1 + LUFA/StudioIntegration/makefile | 53 +++++++++++++------- 8 files changed, 113 insertions(+), 18 deletions(-) create mode 100644 LUFA/StudioIntegration/Docbook/mshelp/placeholder.txt create mode 100644 LUFA/StudioIntegration/Docbook/placeholder.txt create mode 100644 LUFA/StudioIntegration/HV1/helpcontentsetup.msha create mode 100644 LUFA/StudioIntegration/HV1/lufa_helpcontentsetup_transform.xslt (limited to 'LUFA/StudioIntegration') diff --git a/LUFA/StudioIntegration/Blob/LUFA.dll b/LUFA/StudioIntegration/Blob/LUFA.dll index 069c1f84b..ad8a942fc 100644 Binary files a/LUFA/StudioIntegration/Blob/LUFA.dll and b/LUFA/StudioIntegration/Blob/LUFA.dll differ diff --git a/LUFA/StudioIntegration/Docbook/mshelp/placeholder.txt b/LUFA/StudioIntegration/Docbook/mshelp/placeholder.txt new file mode 100644 index 000000000..486e9a427 --- /dev/null +++ b/LUFA/StudioIntegration/Docbook/mshelp/placeholder.txt @@ -0,0 +1 @@ +Copy the Microsoft HV1 Docbook transform contents into this directory (i.e. with the XSLT files in the current folder). The HV1 transform proposal can be found at http://sourceforge.net/tracker/?func=detail&aid=3610290&group_id=21935&atid=373750 . diff --git a/LUFA/StudioIntegration/Docbook/placeholder.txt b/LUFA/StudioIntegration/Docbook/placeholder.txt new file mode 100644 index 000000000..c017acfd7 --- /dev/null +++ b/LUFA/StudioIntegration/Docbook/placeholder.txt @@ -0,0 +1 @@ +Copy the Docbook XSLT docbook-xsl-1.78.1 release contents into this directory (i.e. with the root Docbook files in the current folder). The Docbook releases can be found at http://sourceforge.net/projects/docbook/files/docbook-xsl/ . diff --git a/LUFA/StudioIntegration/HV1/helpcontentsetup.msha b/LUFA/StudioIntegration/HV1/helpcontentsetup.msha new file mode 100644 index 000000000..8bf554338 --- /dev/null +++ b/LUFA/StudioIntegration/HV1/helpcontentsetup.msha @@ -0,0 +1,19 @@ + + + LUFA Help + + +

+ FourWalledCubicle + LUFA + LUFA Help + en-us +

+ LUFA + lufa_studio_help.mshc +

+ + diff --git a/LUFA/StudioIntegration/HV1/lufa_helpcontentsetup_transform.xslt b/LUFA/StudioIntegration/HV1/lufa_helpcontentsetup_transform.xslt new file mode 100644 index 000000000..f1a0add3d --- /dev/null +++ b/LUFA/StudioIntegration/HV1/lufa_helpcontentsetup_transform.xslt @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + ( + + ) + + + + + + + + + lufa_help_ + + .mshc + + + lufa_help_ + + .mshc + + + diff --git a/LUFA/StudioIntegration/VSIX/[Content_Types].xml b/LUFA/StudioIntegration/VSIX/[Content_Types].xml index 04d85a7bb..05ef8b6ba 100644 --- a/LUFA/StudioIntegration/VSIX/[Content_Types].xml +++ b/LUFA/StudioIntegration/VSIX/[Content_Types].xml @@ -8,4 +8,6 @@ + + diff --git a/LUFA/StudioIntegration/VSIX/extension.vsixmanifest b/LUFA/StudioIntegration/VSIX/extension.vsixmanifest index d60ccb756..e8b1db6e9 100644 --- a/LUFA/StudioIntegration/VSIX/extension.vsixmanifest +++ b/LUFA/StudioIntegration/VSIX/extension.vsixmanifest @@ -27,6 +27,7 @@ LUFA.pkgdef GettingStarted.htm + helpcontentsetup.msha asf-manifest.xml diff --git a/LUFA/StudioIntegration/makefile b/LUFA/StudioIntegration/makefile index 3f681f8f9..5b50a2221 100644 --- 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) + +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 +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 \ @@ -29,21 +41,12 @@ VSIX_ASSETS := $(LUFA_ROOT)/DoxygenPages/Images/LUFA_thumb.png \ Blob/LUFA.dll \ 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 - 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) - @cd $(LUFA_ROOT)/.. && rm -f contents.zip exampleProjects.xml content.xml.cache extension.vsixmanifest asf-manifest.xml extension.xml $(notdir $(VSIX_ASSETS)) LUFA-*.vsix + @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" @@ -72,26 +75,40 @@ $(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." +$(MSHELP_OUTPUT_XML): $(DOXYGEN_COMBINED_XML) + @echo Converting Doxygen XML to Docbook... + @-mkdir mshelp 2> /dev/null + @xsltproc HV1/lufa_docbook_transform.xsl $(DOXYGEN_COMBINED_XML) > mshelp/lufa_docbook.xml + @cd mshelp && xsltproc ../Docbook/mshelp/docbook.xsl lufa_docbook.xml + + @echo Copying help assets... + @-mkdir mshelp/images 2> /dev/null + @cp -r $(LUFA_ROOT)/DoxygenPages/Images/* mshelp/images + + @echo Archiving help content... + @cd mshelp && zip ../$(MSHELP_OUTPUT_XML) -q -0 -r *.html images + generate_xml: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML) -generate_vsix: $(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 "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 - @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 + @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) @@ -111,4 +128,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 -.PHONY: all clean generate_xml generate_vsix check_filenames +.PHONY: all clean generate_xml generate_vsix check_filenames sanity_check -- cgit v1.2.3