/*
 * [ProjectHead.java]
 *
 * Summary: Produce the header for an project type HTML.
 *
 * Copyright: (c) 2004-2017 Roedy Green, Canadian Mind Products, http://mindprod.com
 *
 * Licence: This software may be copied and used freely for any purpose but military.
 *          http://mindprod.com/contact/nonmil.html
 *
 * Requires: JDK 1.8+
 *
 * Created with: JetBrains IntelliJ IDEA IDE http://www.jetbrains.com/idea/
 *
 * Version History:
 *  1.8 2009-02-06 include go package in ZIP bundle.
 */
package com.mindprod.htmlmacros.macro;

import com.mindprod.htmlmacros.support.GoogleAdSense;
import com.mindprod.htmlmacros.support.Indexing;

import static java.lang.System.*;

/**
 * Produce the header for an project type HTML.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.8 2009-02-06 include go package in ZIP bundle.
 * @since 2004
 */
public final class ProjectHead extends Macro
    {
    /**
     * how to use the macro
     */
    private static final String USAGE = "\nProjectHead macro needs title metadesc keywords";

    /**
     * Generate the header for a Project html documents.
     *
     * @param parms   parameters from macro command line. parm[0] = title of fragment. parm[1] = description
     *                of fragment. parm[2] = keywords for fragment.
     * @param quiet   true if want output suppressed.
     * @param verbose @return expanded macro HTML
     */
    public String expandMacro( String[] parms,
                               final boolean quiet, final boolean verbose )
        {
        if ( !quiet )
            {
            out.print( "P" );
            }
        if ( parms.length != 3 )
            {
            throw new IllegalArgumentException( USAGE );
            }
        String longTitle = parms[ 0 ];
        String metaDescription = parms[ 1 ] + ": Java Student Project";
        String keywords = parms[ 2 ] + ",Java, student projects, Java projects," +
                          "suggested student projects, student project outlines," +
                          " programming projects, Java programming puzzles";
        String topOfPageImage = "icon64/project.png";
        String icon16 = "icon16/project.png";
        String sectionFile = "jgloss/jgloss.html";
        String sectionTitle = "Java Glossary";
        String subSectionFile = "project/projects.html";
        String subSectionTitle = "Student Projects";
        Head head = new Head();
        head.setFileBeingProcessedAndFileBeingDistributed( fileBeingProcessed, fileBeingDistributed );
        return head.generalHead( longTitle,
                null,
                metaDescription,
                longTitle,
                "titlesubsubsection",
                keywords,
                icon16,
                null,
                topOfPageImage,
                null,
                null,
                sectionFile,
                sectionTitle,
                subSectionFile,
                subSectionTitle,
                null,
                null,
                null,
                null,
                Indexing.NONE,
                GoogleAdSense.MEDIUM_RECTANGLE,
                null,
                null
        );
        }
    }