HZBUILDER -- a wizard for building HZ packages == Description == [[/hop/hzbuilder|HzBuilder]] is a simple tool that assist you in the process of creating a HZ package. ++HzBuilder++ will basically create the Makefile needed to generate a package and the standard files that must be present in the package. ,( :class "weblet-facts" ( (

:rowspan 5 :class "logo" ( ( ( ( ( ( ( ( :style "text-align: center" ( :src (make-file-name (dirname (the-loading-file)) "logo.png")))) ( :style "font-size: 90%; text-align: center" ( :href "@PUBLICHOST@/hop/weblets/homepage?weblet=@HZ@" "Home page"))))) ( (string-capitalize "@HZ@") " version") ( "@VERSION@")) ( "Hop min version") ( "@MINHOP@")) ( "Hop max version") ( "@MAXHOP@")) ( "Date") ( "@DATE@")) ( "Category") ( "@CATEGORY@"))) == Related documentations == Several tutorials are related to [[/hop/hzbuilder|HzBuilder]]: * ,( "hz tutorial" "06-hz.wiki") Serveral other Weblets are also related to [[/hop/hzbuilder|HzBuilder]]: * ,( "hz" (make-file-path (hop-weblets-directory) "hz" "etc" "hz.wiki")): the documentation of the HOP Hz package manager. * ,( "weblets" (make-file-path (hop-weblets-directory) "hz" "etc" "weblets.wiki")): the documentation of the Weblets weblet that let you manage your locals weblets. At least, some internal documentation pages may be helpful to understand how HOP weblets should be programmed: * ,( "service" "service.wiki"): the definition of HOP services. * ,( "hss" "hss.wiki"): HOP CSS facilities extensions. == Services == Here are the services defined by this weblet: - ++[[/hop/hzbuilder|hzbuilder]]++: The main entry point of Hzbuilder. - ++[[/hop/hzbuilder/documentation|hzbuilder/documentation]]++: This documentation page. - ++[[/hop/hzbuilder/preferences|hzbuilder/preferences]]++: Various HzBuilder user configuration. === HzBuilder skeletons === HzBuilder creates all the files needed for an operational weblet. These files are created from //skeletons// that are installed in the created directory. Installing these files copy the skeletons and replace some patterns with the actual parameters of the weblet. Here is the list of the replacaments that take place during the installation. * ++@,(begin "HZ")@++, the name of weblet. * ++@,(begin "HZUPCASE")@++, the upcase name of the weblet. * ++@,(begin "TITLE")@++, the weblets' title. * ++@,(begin "VERSION")@++, the version. * ++@,(begin "MINHOP")@++, the minimum Hop version supporting this weblet. * ++@,(begin "MAXHOP")@++ ,the maximum Hop version supporting this weblet. * ++@,(begin "HOME")@++, the weblet homepage. * ++@,(begin "CATEGORY")@++, the category. * ++@,(begin "AUTHOR")@++, the authors. * ++@,(begin "DASHBOARD")@++ , does this weblet provides a dashboard entry. * ++@,(begin "DESCRIPTION")@++, a description of the weblet. * ++@,(begin "DATE")@++, the creation date. * ++@,(begin "DATEYEAR")@++, the year of creation. * ++@,(begin "DATEMONTH")@++, the month of creation. * ++@,(begin "DATEAMONTH")@++, the name of the creation month. * ++@,(begin "DATEDAY")@++ , the day of the creation. * ++@,(begin "REPOSITORY")@++, the directory where this weblet is to be installed. === HzBuilder server functions === ==== ++hzbuilder-rc-directory++ ==== hzbuilder-rc-directory ^ access ^ type ^ current value ^ short description ^ | r | string | ++(hzbuilder-rc-directory)++ | The RC directory associated with Hzbuilder. | This parameter specifies the directory name used to store Hzbuilder RC files. When Hzbuilder starts it checks if the file ++(hzbuilder-rc-directory)/hzbuilderrc.hop++ exists. It it exists, it is loaded. ==== ++hzbuilder-hop-skeleton++ ==== hzbuilder-hop-skeleton hzbuilder-hop-skeleton-set! ^ access ^ type ^ current value ^ short description ^ | r/w | string | ++(hzbuilder-hop-skeleton)++ | The main skeleton. | This parameter specifies the path of the file used as a skeleton for producing the main ++.hop++ file of the weblet. ==== ++hzbuilder-config-skeleton++ ==== hzbuilder-config-skeleton hzbuilder-config-skeleton-set! ^ access ^ type ^ current value ^ short description ^ | r/w | string | ++(hzbuilder-config-skeleton)++ | The config.hop skeleton. | This parameter specifies the path of the file used as a skeleton for producing the ++config.hop++ file of the weblet. ==== ++hzbuilder-hss-skeleton++ ==== hzbuilder-hss-skeleton hzbuilder-hss-skeleton-set! ^ access ^ type ^ current value ^ short description ^ | r/w | string | ++(hzbuilder-hss-skeleton)++ | The .hss skeleton. | This parameter specifies the path of the file used as a skeleton for producing the ++.hss++ file of the weblet. ==== ++hzbuilder-makefile-skeleton++ ==== hzbuilder-makefile-skeleton hzbuilder-makefile-skeleton-set! ^ access ^ type ^ current value ^ short description ^ | r/w | string | ++(hzbuilder-makefile-skeleton)++ | The Makefile skeleton. | This parameter specifies the path of the file used as a skeleton for producing the Makefile of the weblet. ==== ++hzbuilder-doc-skeleton++ ==== hzbuilder-doc-skeleton hzbuilder-doc-skeleton-set! ^ access ^ type ^ current value ^ short description ^ | r/w | string | ++(hzbuilder-doc-skeleton)++ | The .wiki skeleton. | This parameter specifies the path of the file used as a skeleton for producing the wiki manual page of the weblet. ==== ++hzbuilder-homepage-skeleton++ ==== hzbuilder-homepage-skeleton hzbuilder-homepage-skeleton-set! ^ access ^ type ^ current value ^ short description ^ | r/w | string | ++(hzbuilder-homepage-skeleton)++ | The .wiki skeleton. | This parameter specifies the path of the file used as a skeleton for producing the wiki homepage of the weblet. ==== ++hzbuilder-webletinfo-skeleton++ ==== hzbuilder-webletinfo-skeleton hzbuilder-webletinfo-skeleton-set! ^ access ^ type ^ current value ^ short description ^ | r/w | string | ++(hzbuilder-webletinfo-skeleton)++ | The weblet.info skeleton. | This parameter specifies the path of the file used as a skeleton for producing the ++weblet.info++ file of the weblet. ==== ++hzbuilder-custom-skeleton-dir++ ==== hzbuilder-custom-skeleton-dir hzbuilder-custom-skeleton-dir-set! ^ access ^ type ^ current value ^ short description ^ | r/w | string | ++(hzbuilder-custom-skeleton-dir)++ | An optional additional skeletons directory. | This parameter specifies the path of an optional directory containing skeleton files. When a weblet is built with ++HzBuilder++ all the files located in the ++hzbuilder-custom-skeleton-dir++ are copied into the weblet directory.