Skip to content

Commit eea8bd7

Browse files
committed
Update documentation
1 parent f32de23 commit eea8bd7

File tree

4 files changed

+14
-8
lines changed

4 files changed

+14
-8
lines changed

src/docs/guide/extending.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Input renders must implement the link:{api}/org/grails/scaffolding/registry/Doma
2323
* `Boolean supports(DomainProperty domainProperty)`
2424
Return true if your renderer supports the given property. See the link:{api}/org/grails/scaffolding/model/property/DomainProperty.html[DomainProperty] and link:https://graceframework.org/grace-data/2023.3.x/api/org/grails/datastore/mapping/model/PersistentProperty.html[PersistentProperty] interfaces to see what data is available on the domain property instance.
2525
* `Closure renderInput(Map defaultAttributes, DomainProperty property)`
26-
Return a closure to be passed to a link:http://docs.groovy-lang.org/latest/html/api/groovy/xml/MarkupBuilder.html[MarkupBuilder] that renders your property
26+
Return a closure to be passed to a link:{groovyapi}/groovy/xml/MarkupBuilder.html[MarkupBuilder] that renders your property
2727

2828
NOTE: The default attributes passed to `renderInput` are created by the link:{api}/org/grails/scaffolding/markup/PropertyMarkupRenderer.html#getStandardAttributes(org.grails.scaffolding.model.property.DomainProperty)[PropertyMarkupRenderer#getStandardAttributes] method.
2929

@@ -43,9 +43,9 @@ Output renders must implement the link:{api}/org/grails/scaffolding/registry/Dom
4343
* `Boolean supports(DomainProperty domainProperty)`
4444
Return true if your renderer supports the given property. See the link:{api}/org/grails/scaffolding/model/property/DomainProperty.html[DomainProperty] and link:https://graceframework.org/grace-data/2023.3.x/api/org/grails/datastore/mapping/model/PersistentProperty.html[PersistentProperty] interfaces to see what data is available on the domain property instance.
4545
* `Closure renderListOutput(DomainProperty property)`
46-
Return a closure to be passed to a link:http://docs.groovy-lang.org/latest/html/api/groovy/xml/MarkupBuilder.html[MarkupBuilder] that renders your property in the context of a list of domain class instances
46+
Return a closure to be passed to a link:{groovyapi}/groovy/xml/MarkupBuilder.html[MarkupBuilder] that renders your property in the context of a list of domain class instances
4747
* `Closure renderOutput(DomainProperty property)`
48-
Return a closure to be passed to a link:http://docs.groovy-lang.org/latest/html/api/groovy/xml/MarkupBuilder.html[MarkupBuilder] that renders your property in the context of a single domain class instance
48+
Return a closure to be passed to a link:{groovyapi}/groovy/xml/MarkupBuilder.html[MarkupBuilder] that renders your property in the context of a single domain class instance
4949

5050
To register your renderer, inject the "domainOutputRendererRegistry" bean and execute `registerDomainRenderer`, passing along your renderer and its priority.
5151

src/docs/guide/installation.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@ To start using this library, there are only a couple simple steps:
55
. Import the library in your `build.gradle`
66

77
[source,groovy,subs="attributes",indent=1]
8-
compile "org.graceframework:scaffolding-core:{version}"
8+
----
9+
implementation "org.graceframework:scaffolding-core:{version}"
10+
----
911

1012
. Register the scaffolding core bean configuration link:{api}/org/grails/scaffolding/ScaffoldingBeanConfiguration.html[ScaffoldingBeanConfiguration]
1113

1214
[source,groovy,indent=1]
13-
scaffoldingBeanConfiguration(ScaffoldingBeanConfiguration)
15+
----
16+
scaffoldingBeanConfiguration(ScaffoldingBeanConfiguration)
17+
----

src/docs/guide/introduction.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
The Grace scaffolding core module was created to render 3 separate views: list, show, and create/edit. By default the views are rendered in a similar way to the link:https://graceframework.org/grace-fields/6.3.x/guide/index.html[fields] plugin.
1+
The Grace scaffolding core module was created to render 3 separate views: list, show, and create/edit. By default the views are rendered in a similar way to the link:https://graceframework.org/grace-fields/{version}/guide/index.html[fields] plugin.
22

3-
All of the applicable rules of the link:https://graceframework.org/grace-fields/6.3.x/guide/index.html[fields] plugin also apply to this module.
3+
All of the applicable rules of the link:https://graceframework.org/grace-fields/{version}/guide/index.html[fields] plugin also apply to this module.
44

55
Scaffolding core is designed to render markup intended to be processed by a template engine. The classes provided by this library will always render markup based on the definition of a domain class, instead of an individual instance or instances of a domain class that contain real data.
66

src/docs/resources/doc.properties

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
springApi=https://docs.spring.io/spring-framework/docs/6.1.19/javadoc-api
21
api=../api
32
guide=../../guide
3+
groovyapi=https://docs.groovy-lang.org/4.0.26/html/api
4+
groovydoc=https://docs.groovy-lang.org/4.0.26/html/documentation
45
tags=../ref/Tags
56
sourcedir=.
67
sourceRepo=https://github.com/graceframework/grace-scaffolding/edit/6.3.x/src/docs
8+
springapidoc=https://docs.spring.io/spring-framework/docs/6.1.20/javadoc-api/
79
safe=UNSAFE
810
title=Grace Scaffolding
911
subtitle=Plugin that generates scaffolded controllers and views for a Grace application

0 commit comments

Comments
 (0)