Skip to content

Commit

Permalink
Updated documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
sbglasius committed Jan 2, 2024
1 parent 7a8e814 commit 5a92810
Show file tree
Hide file tree
Showing 4 changed files with 195 additions and 174 deletions.
181 changes: 181 additions & 0 deletions src/docs/asciidoc/changelog.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
== Changelog

=== Version 4.0.0 - Grails 4.1.x

**Important**

New `group` id.


In your `build.gradle` file, use:

[source,groovy,subs="attributes"]
----
compile 'io.github.gpc:fields:4.0.0'
----

Changelog:
https://github.com/gpc/fields/compare/v3.0.0.RC1\...v4.0.0

Thank goes to the community for all the contributions!

=== Version 3.0.0.RC1 - Grails 4.0.x

Last version that is on the "old" group `org.grails.plugins`

Changelog:
https://github.com/gpc/fields/compare/v2.2.10\...v3.0.0.RC1

=== Version 2.2.9.BUILD-SNAPSHOT

Changelog:
https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.8\...v2.2.9

=== Version 2.2.8

* BugFix: Table Tag does not render transient fields correctly (Issue https://github.com/grails-fields-plugin/grails-fields/issues/264[#264])
* BugFix: Table Tag does not render references correctly!
(Issue https://github.com/grails-fields-plugin/grails-fields/issues/269[#269])
* BugFix: Fix XSS vulnerability when rendering beans (Issue https://github.com/grails-fields-plugin/grails-fields/issue/278[#278])
https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.7...v2.2.8[GitHub diff]

=== Version 2.2.7

* BugFix: The fix for #257 did not work as described, but now it does.
* Improvement: Documentation has been improved with more examples for the various tags.
https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.6...v2.2.7[GitHub diff]

=== Version 2.2.6

* Improvement: Documentation of `maxProperties` on `<f:table/>`
* Improvement: `<f:table\>` can now show `id`, `lastUpdated` and `dateCreated` (see link:../ref/Tags/table.html[f:table] doc).
Injecting `DomainModelService` instead of instantiating `DomainModelServiceImpl` in `FormsFieldTagLib` (Issue https://github.com/grails-fields-plugin/grails-fields/issues/257[#257])

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.5...v2.2.6[GitHub diff]

=== Version 2.2.4/2.2.5

* Improvement: Introduced `maxProperties` attribute to `<f:table/>`
* Improvement: Render value that is an association but not to a grom entity
* Improvement: Rendering numbers is now Locale-aware (can be configured)

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.3...v2.2.5[GitHub diff]

=== Version 2.2.3

* Bug-fix: Another issue with old API

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.2...v2.2.3[GitHub diff]

=== Version 2.2.2

* Bug-fix: Fix issue with oneToMany expecting the old API

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.1...v2.2.2[GitHub diff]

=== Version 2.2.1

* Bug-fix: Autowire beans

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.0...v2.2.1[GitHub diff]

=== Version 2.2.0

* Conversion to the Mapping Context API.
Usages of the GrailsDomainClass and GrailsDomainClassProperty classes have been removed.
If you extend a template that relies on those classes, they have been replaced with link:http://gorm.grails.org/latest/hibernate/api/org/grails/datastore/mapping/model/PersistentEntity.html[PersistentEntity] and link:http://grails.github.io/scaffolding/latest/api/org/grails/scaffolding/model/property/DomainProperty.html[DomainProperty] respectively.

* Conversion of constraints to a common implementation between grails.validation and grails.gorm.validation.
See link:http://grails.github.io/scaffolding/latest/api/org/grails/scaffolding/model/property/Constrained.html[Constrained].

https://github.com/grails-fields-plugin/grails-fields/compare/v2.1.4...v2.2.0[GitHub diff]

=== Version 2.1.4

* Upgrade to Grails 3.2.8
* Convert documentation to Asciidoc
* Add support for themes

https://github.com/grails-fields-plugin/grails-fields/compare/v2.1.1...v2.1.4[GitHub diff from 2.1.1 to 2.1.4]

=== Version 2.0

* Redesign for Grails 3.0

=== Version 1.5

_2015_04_26_

* See https://github.com/grails-fields-plugin/grails-fields/issues?q=milestone%3A1.5+is%3Aclosed[Browse issues]

WARNING: See <<usage,Usage>> and <<customizingFieldRendering,Customizing Field Rendering>> for breaking changes.

=== Version 1.4

* Upgraded plugin to work with Grails 2.3.x (Issue #122)
* Fixed missing property exception (Issue #134)
* Fixed encoding in tag libraries (Issue #137)
* Configuring caching in dev mode (Issue #139)
* byte[] and Byte[] arrays types now look for files in byteArray folders (general for all array types) (Issue #144)

https://github.com/grails-fields-plugin/grails-fields/issues?q=is%3Aissue+milestone%3A1.4+is%3Aclosed[Browse issues]

=== Version 1.3

_2012-07-31_

* Adds the _f:display_ tag.
* Supports overriding templates by property type or by default in individual controllers and actions.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=9&state=closed[Browse issues]
Thanks to https://github.com/cdeszaq,[Rick Jensen] https://github.com/delight,[Konstantinos Kostarellis] https://github.com/guspower[Gus Power] and https://github.com/eliotsykes[Eliot Sykes] for their contributions.

=== Version 1.2

_2012-03-16_

* Pass attributes from `f:field` to the rendered input using `input-` prefix.
* Optionally use entire property path for label key.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=8&state=closed[Browse issues]
Thanks to https://github.com/bluesliverx[Brian Saville] and https://github.com/OverZealous[OverZealous] for contributions.

=== Version 1.1

_2012-03-11_

* Adds the _prefix_ attribute.
* Support `widget:'textarea'` constraint.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=7&state=closed[Browse issues]
Thanks to https://github.com/bluesliverx[Brian Saville] for contributions.

=== Version 1.0.4

_2012-02-13_: Bugfix release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=5&state=closed[Browse issues]

=== Version 1.0.3

_2012-02-09_: Bugfix release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=4&state=closed[Browse issues]

=== Version 1.0.2

_2012-02-07_: Bugfix release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=3&state=closed[Browse issues]

=== Version 1.0.1

_2012-02-03_: Bugfix release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=2&state=closed[Browse issues]

=== Version 1

_2012-02-01_: Initial release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=1&state=closed[Browse issues]
5 changes: 5 additions & 0 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@

include::introduction.adoc[]

include::changelog.adoc[]

[[installation]]
include::installation.adoc[]

[[usage]]

include::usage.adoc[]
Expand Down
9 changes: 9 additions & 0 deletions src/docs/asciidoc/installation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
== Installation
The plugin is available on Maven Central and should be a dependency like this:

[source,groovy,subs="attributes"]
----
dependencies {
compile 'io.github.gpc:fields:{version}'
}
----
174 changes: 0 additions & 174 deletions src/docs/asciidoc/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,177 +9,3 @@ The *Fields plugin* allows you to customize the rendering of input fields for pr
* Enable other plugins to provide field rendering for special property types that gets picked up automatically (e.g. the _Joda Time_ plugin can provide templates for the various date/time types).
* Support embedded properties of _GORM_ domain classes.
== Changelog

=== Version 4.0.0-RC1 - Grails 4.1.x
**Important**

New `group` id. In your build.gradle file, use:

----
compile 'io.github.gpc:fields:4.0.0-RC1'
----

Changelog:
https://github.com/gpc/fields/compare/v3.0.0.RC1...v4.0.0-RC1

Thank you for all the contributions!

=== Version 3.0.0.RC1 - Grails 4.0.x
Last version that is on the "old" group `org.grails.plugins`

Changelog:
https://github.com/gpc/fields/compare/v2.2.10...v3.0.0.RC1

=== Version 2.2.9.BUILD-SNAPSHOT
Changelog:
https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.8...v2.2.9

=== Version 2.2.8
* BugFix: Table Tag does not render transient fields correctly (Issue https://github.com/grails-fields-plugin/grails-fields/issues/264[#264])
* BugFix: Table Tag does not render references correctly! (Issue https://github.com/grails-fields-plugin/grails-fields/issues/269[#269])
* BugFix: Fix XSS vulnerability when rendering beans (Issue https://github.com/grails-fields-plugin/grails-fields/issue/278[#278])
https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.7...v2.2.8[GitHub diff]

=== Version 2.2.7
* BugFix: The fix for #257 did not work as described, but now it does.
* Improvement: Documentation has been improved with more examples for the various tags.
https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.6...v2.2.7[GitHub diff]

=== Version 2.2.6

* Improvement: Documentation of `maxProperties` on `<f:table/>`
* Improvement: `<f:table\>` can now show `id`, `lastUpdated` and `dateCreated` (see link:../ref/Tags/table.html[f:table] doc). Injecting `DomainModelService` instead of instantiating `DomainModelServiceImpl` in `FormsFieldTagLib` (Issue https://github.com/grails-fields-plugin/grails-fields/issues/257[#257])

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.5...v2.2.6[GitHub diff]

=== Version 2.2.4/2.2.5
* Improvement: Introduced `maxProperties` attribute to `<f:table/>`
* Improvement: Render value that is an association but not to a grom entity
* Improvement: Rendering numbers is now Locale-aware (can be configured)

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.3...v2.2.5[GitHub diff]

=== Version 2.2.3
* Bug-fix: Another issue with old API

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.2...v2.2.3[GitHub diff]

=== Version 2.2.2
* Bug-fix: Fix issue with oneToMany expecting the old API

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.1...v2.2.2[GitHub diff]

=== Version 2.2.1
* Bug-fix: Autowire beans

https://github.com/grails-fields-plugin/grails-fields/compare/v2.2.0...v2.2.1[GitHub diff]

=== Version 2.2.0

* Conversion to the Mapping Context API. Usages of the GrailsDomainClass and GrailsDomainClassProperty classes have been removed. If you extend a template that relies on those classes, they have been replaced with link:http://gorm.grails.org/latest/hibernate/api/org/grails/datastore/mapping/model/PersistentEntity.html[PersistentEntity] and link:http://grails.github.io/scaffolding/latest/api/org/grails/scaffolding/model/property/DomainProperty.html[DomainProperty] respectively.

* Conversion of constraints to a common implementation between grails.validation and grails.gorm.validation. See link:http://grails.github.io/scaffolding/latest/api/org/grails/scaffolding/model/property/Constrained.html[Constrained].

https://github.com/grails-fields-plugin/grails-fields/compare/v2.1.4...v2.2.0[GitHub diff]

=== Version 2.1.4

* Upgrade to Grails 3.2.8
* Convert documentation to Asciidoc
* Add support for themes

https://github.com/grails-fields-plugin/grails-fields/compare/v2.1.1...v2.1.4[GitHub diff from 2.1.1 to 2.1.4]

=== Version 2.0

* Redesign for Grails 3.0

=== Version 1.5

_2015_04_26_

* See https://github.com/grails-fields-plugin/grails-fields/issues?q=milestone%3A1.5+is%3Aclosed[Browse issues]

WARNING: See <<usage,Usage>> and <<customizingFieldRendering,Customizing Field Rendering>> for breaking changes.

=== Version 1.4

* Upgraded plugin to work with Grails 2.3.x (Issue #122)
* Fixed missing property exception (Issue #134)
* Fixed encoding in tag libraries (Issue #137)
* Configuring caching in dev mode (Issue #139)
* byte[] and Byte[] arrays types now look for files in byteArray folders (general for all array types) (Issue #144)

https://github.com/grails-fields-plugin/grails-fields/issues?q=is%3Aissue+milestone%3A1.4+is%3Aclosed[Browse issues]

=== Version 1.3


_2012-07-31_

* Adds the _f:display_ tag.
* Supports overriding templates by property type or by default in individual controllers and actions.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=9&state=closed[Browse issues]
Thanks to https://github.com/cdeszaq,[Rick Jensen] https://github.com/delight,[Konstantinos Kostarellis] https://github.com/guspower[Gus Power] and https://github.com/eliotsykes[Eliot Sykes] for their contributions.


=== Version 1.2


_2012-03-16_

* Pass attributes from `f:field` to the rendered input using `input-` prefix.
* Optionally use entire property path for label key.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=8&state=closed[Browse issues]
Thanks to https://github.com/bluesliverx[Brian Saville] and https://github.com/OverZealous[OverZealous] for contributions.


=== Version 1.1


_2012-03-11_

* Adds the _prefix_ attribute.
* Support `widget:'textarea'` constraint.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=7&state=closed[Browse issues]
Thanks to https://github.com/bluesliverx[Brian Saville] for contributions.


=== Version 1.0.4


_2012-02-13_: Bugfix release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=5&state=closed[Browse issues]

=== Version 1.0.3


_2012-02-09_: Bugfix release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=4&state=closed[Browse issues]

=== Version 1.0.2


_2012-02-07_: Bugfix release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=3&state=closed[Browse issues]

=== Version 1.0.1


_2012-02-03_: Bugfix release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=2&state=closed[Browse issues]

=== Version 1


_2012-02-01_: Initial release.

https://github.com/grails-fields-plugin/grails-fields/issues?milestone=1&state=closed[Browse issues]

0 comments on commit 5a92810

Please sign in to comment.