1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.pluginwizard.service.generator;
35
36 import fr.paris.lutece.plugins.pluginwizard.business.model.PluginModel;
37
38 import java.util.HashMap;
39 import java.util.Map;
40
41 /**
42 * Site Documenation Generator
43 */
44 public class SiteDocumentationGenerator extends AbstractGenerator
45 {
46 private static final String PATH = "src/site/";
47 private static String [ ] _files = {
48 "site.xml", "site_fr.xml", "xdoc/index.xml", "fr/xdoc/index.xml", "resources/images/readme.txt", "fr/resources/images/readme.txt"
49 };
50
51 @Override
52 public Map generate( PluginModel pm, String generationSchemeName )
53 {
54 HashMap map = new HashMap( );
55
56 for ( int i = 0; i < _files.length; i++ )
57 {
58 String strPath = getFilePath( pm, PATH, _files [i] );
59
60 String strSourceCode = getCode( pm, i );
61 map.put( strPath, strSourceCode );
62 }
63
64 return map;
65 }
66
67 /**
68 * Build code
69 *
70 * @param pm
71 * The plugin model
72 * @param nTemplateType
73 * The template index
74 * @return The code
75 */
76 private String getCode( PluginModel pm, int nTemplateType )
77 {
78 Map<String, Object> model = new HashMap<>( );
79
80 model.put( Markers.MARK_PLUGIN_MODEL, pm );
81 model.put( Markers.MARK_TEMPLATE_TYPE, nTemplateType );
82
83 return build( model );
84 }
85 }