[jbosstools-issues] [JBoss JIRA] Closed: (JBDS-1083) Hibernate guide update

[Svetlana mukhina (JIRA)]

     [ https://jira.jboss.org/jira/browse/JBDS-1083?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Svetlana mukhina closed JBDS-1083.
----------------------------------

    Resolution: Done


all demos are checked - the required ones are updated 

> Hibernate guide update 
> -----------------------
>
>                 Key: JBDS-1083
>                 URL: https://jira.jboss.org/jira/browse/JBDS-1083
>             Project: Developer Studio (JBoss Developer Studio)
>          Issue Type: Task
>          Components: Doc - Hibernate
>    Affects Versions: 3.0.0.M4
>            Reporter: Svetlana mukhina
>            Assignee: Svetlana mukhina
>             Fix For: 3.0.0.CR2-doc
>
>   Original Estimate: 1 week
>  Remaining Estimate: 1 week
>
> In documentation is written to install Hibernate Tools plugins wtp is necessary, in real life the user needs these steps to install it (if he download it separately - not from update site): http://loracular.blogspot.com/2009/09/steps-to-install-hibernate-tools-for.html
> 4.2 - refresh figures 4.1 & 4.2; it is necessary to mention that it is possible do not select any class/package on 4.1 - as result blank hbm.xml will be generated, plus checkbox on right to control dependences depth, i.e. there is class A in the list, if class A has reference on class B, then hbm.xml will be generated for class B also. Now for hbm.xml generation there is a preview results page, as Generate Hibernate/JPA annotations has - is necessary to add description;
> The same for Generate Hibernate/JPA annotations - is necessary to describe possibility to control depth.
> Figure 4.5 - is necessary to refresh, cause there is possibility to specify dialect + describe this in documentation;
> Figure 4.10 - refresh picture cause contextual menu little bit changed;
> "4.4.2. - right click on the configuration in Hibernate Configurations View->Edit Configuration or double click on console configuration" - is necessary to mention about "double click"
> Figure 4.13 - is necessary to mention that it is possible to specify absolute directory path as example "d:\temp" - in the Table 4.6;
> Figure 4.33 - refresh - now it is possible "pin" HQL editor & Criteria editor for one tab in Hibernate Query Results view; it also possible to rename tab (by default the name is a whole query - too long for some cases) - select tab -> Properties view -> Name;
> Figure 4.34 - refresh - contextual menu updated;
> Figure 4.36 - refresh - contextual menu updated;
> Figure 4.39 & Figure 4.40 - refresh - Outline view has a little change - it is possible to switch on/off alphabetical sorting;
> Figure 4.41 - refresh - contextual menu updated, plus update description;
> Figure 4.43 & Figure 4.44 - refresh - cause now diagram headers are shorter;
> For Hibernate Mapping Diagram there is no description of toolbar and it's functionality; Refresh button refresh diagram - if console configuration was changed; 
> Zoom combobox - is obligatory to mention what selected zoom will be used for diagram printing, if the user wants to put diagram on one print page he should select - "Page" in zoom combobox;
> Auto layout & Show|Hide connections & Expand|Collapse & Show|Hide shape(s) - is necessary to add description;
> Figure 4.45 - refresh - cause new context menu;
> Is necessary to describe: "Close Configuration" - this close hibernate console configuration, disconnect from DB, free other resources (for example unlock jar libs for windows);
> Figure 4.46 - refresh - cause new context menu;
> Figure 4.49 - refresh - cause white background icon, the same for Figure 4.50 & Figure 4.51;
> "4.11. Hibernate:add JPA annotations view" - is not right - should be "4.11. Hibernate:add JPA annotations refactoring"
> Figure 4.52 - refresh; add new screenshort for back page - now it is possible back and update selected classes and packages - the same as generate hbm.xml has;
> "Starting Hibernate:add JPA annotations view" - this is not a view - this is dialog -> Figure 4.53 - refresh it;
> It is not mentioned in documentation what "Error Log View" - is very important with Hibernate Tools plugins - it should be recommended for users to switch it on in Hibernate perspective and use "Error Log View" if there are some trubles to configure Hibernate console configuration;
>  
> prepare example projects which is used a as base project for documentation for user to download 

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