[ 
http://jira.codehaus.org/browse/MSITE-320?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=133478#action_133478
 ] 

Alfonsas Stonis commented on MSITE-320:
---------------------------------------

Hi,

It is really nice to have examples, but I was looking for was reference. I do 
understand that it covers some part of functionality, but is it all?
If you look at this example you will find that you can change:
o) title, 
o) public date, 
o) powered by logo
o) inheritance
o) include 3 types of generated content
o) change skins
o) and use expressions

Is this all?
I doubt it.

Starting from small things:
o) publishDate can have format cool, but what is the syntax? You do not need to 
describe it, reference is enough.
o) when I inherit something from something I can have menu. Nice. But the code 
I found has not only menu, but menu items too. They have references, how they 
are described?
o) how many levels can be in menu?
o) what items can be in menu?
o) what kind of files can be referenced? 
o) which of them are interpreted by site and regenerated?
o) how files are referenced? I see that there are different files are used in 
other projects and they are referenced the same, but they are picked from 
different locations
o) where is the definition of the files that can be included
o) schema definition for site.xml would be nice. Documentation is much easier 
to read, but I can deal with it. Of course I still will have no idea what these 
items are used for, but at least I will know what can be included in site.xml 
and validate it.

I like maven and site plugin. I think it can be useful, but without the 
information I can do very little with it (change logo for empty document).

> Reference documentation
> -----------------------
>
>                 Key: MSITE-320
>                 URL: http://jira.codehaus.org/browse/MSITE-320
>             Project: Maven 2.x Site Plugin
>          Issue Type: Bug
>          Components: site descriptor
>    Affects Versions: 2.0-beta-6
>         Environment: All
>            Reporter: Alfonsas Stonis
>
> There is no documentation for site. I mean there is some, but this is not 
> enough. For example there is no reference what elements can be included in 
> site.xml. What are tags? No clue. It is not possible to use it as it is now. 
> I do understand I can find out what they do by trying, but at least I need to 
> know what they are. I tried to search on internet for any documentation, but 
> no success. It is very frustrating. I think many users give up using it, just 
> because they can not find what it can do and how to use it.
> Please provide at least simple list of the elements that are available in 
> site.xml.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Reply via email to