[DOCU-2832] Update javadoc syntax (because of extension disabling) - non-product-docs repos Created: 08/Sep/23  Updated: 04/Oct/23  Resolved: 03/Oct/23

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Alex Mansell Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File image-2023-09-15-16-37-31-573.png    
Issue Links:
Cloners
clones DOCU-2818 Update javadoc syntax (because of ext... Closed
dependency
is depended upon by DOCU-2833 CLONE - Javadoc syntax audit cleanup Closed

 Description   

We want to regex the javadoc syntax away from all current javadoc items. However, we would like to wrap those in a custom id so we could future proof usage (perhaps getting element by id).

Example:

javadoc:blah.info.blah[]

javadoc:blah.info.blah[isEnterprise=true]

should be

[#inlineBean]#blah.info.blah#

 



 Comments   
Comment by Martin Drápela [ 15/Sep/23 ]

before the javadoc.js was removed, javadoc syntax was rendered as follows:

in source view:

<p><a href="#" target="_blank" rel="noopener">ConfigScannerCommand</a></p>

Comment by Martin Drápela [ 15/Sep/23 ]

for cleanup:

grep -nHIrF --include=*.html -- <a href="#" target="_blank" rel="noopener"> (v adresáři: /home/martin/grab/6239docs_20230926/docs.magnolia-cms.com)
./instrumentation/probes/rendering-probes.html:1311:The rendering probes are implemented as rendering engine listeners (see <a href="#" target="_blank" rel="noopener">AbstractRenderingListener</a> for more) and are called as the rendering engine is executed.
./magnolia-rabbitmq/index.html:1785:<p>Consumer class which implements <a href="#" target="_blank" rel="noopener">AbstractMQConsumerJob</a> .</p>
./magnolia-sso/3.1.7/index.html:1447:<p>By convention, this is required in order to include the user&#8217;s groups in the <code>groups</code> property, see <a href="#" target="_blank" rel="noopener">GroupsAuthorizationGenerator</a>. Without this data, a user won&#8217;t be assigned any Magnolia permission, and hence won&#8217;t be able to go past the login screen. Here&#8217;s how to configure the mapper in various applications:</p>
./magnolia-sso/2.0.6/index.html:1437:<p>By convention, this is required in order to include the user&#8217;s groups in the <code>groups</code> property, see <a href="#" target="_blank" rel="noopener">GroupsAuthorizationGenerator</a>. Without this data, a user won&#8217;t be assigned any Magnolia permission, and hence won&#8217;t be able to go past the login screen. Here&#8217;s how to configure the mapper in various applications:</p>
./rest/3.0.0/api/delivery-endpoint/delivery-endpoint-cds.html:2254:<p>The reference resolver defines how references are resolved. The properties are defined in <a href="#" target="_blank" rel="noopener">ReferenceResolverDefinition</a>.</p>
./rest/3.0.0/api/delivery-endpoint/delivery-endpoint-jcr.html:3580:<p>The reference resolver defines how references are resolved. The properties are defined in <a href="#" target="_blank" rel="noopener">ReferenceResolverDefinition</a>.</p>
./task-email-notifications/index.html:1430:Both scripts interact with <a href="#" target="_blank" rel="noopener">TaskNodeModel</a> by way of the <a href="../product-docs/6.2/Developing/Templating/Template-scripts/Rendering-context-objects.html" class="xref page">Rendering context objects</a> model.
./seo/auditors/HtmlElementAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">HtmlElementAuditor</a> checks for the presence of a specified HTML element. If the HTML element is found at least once, the audit passes, otherwise the audit fails. This auditor can be applied to any renderable node. The auditor uses jsoup queries to parse and find HTML elements. These queries have a jQuery or CSS like syntax.</p>
./seo/auditors/I18NPropertyDefinitionAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">I18NPropertyDefinitionAuditor</a> is a companion to <code>PropertyDefinitionAuditor</code>. Instead of checking for the definition of a node property for the default language, this auditor can check that values are defined for all or some of the available languages for the site.</p>
./seo/auditors/I18NPropertyValidationAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">I18NPropertyValidationAuditor</a> is a companion to <code>PropertyValidationAuditor</code>. Instead of validating the definition of a node property for the default language, the auditor can validate the values of a designated property for all or some of the available languages for the site.</p>
./seo/auditors/MetaDescriptionAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">MetaDescriptionAuditor</a> checks a node for a property named "description" and if defined, checks the length of the value.  Many search engines ignore long meta descriptions. Typically all text after about 160 to 180 characters is ignored. This auditor can help you check pages for long meta descriptions.</p>
./seo/auditors/PropertyValidatorAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">PropertyValidationAuditor</a> is a companion to <code>I18NPropertyValidationAuditor</code>. This auditor checks the values of a designated property. Use I18NPropertyValidationAuditor to check the values of internationalized properties (properties with language variants).</p>
./seo/auditors/ParagraphLengthAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">ParagraphLengthAuditor</a> checks the length in words of HTML elements containing text, not the overall length in characters. You can use this auditor to check for pages with overly long text blocks. This can any HTML element that containing text which can be located by a jsoup query.</p>
./seo/auditors/LinkAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">LinkAuditor</a> will find links in a rendered HTML page and check if they are accessible. The URLs contained in HTML anchor, link and, IMG elements are extracted and checked. Other URLs, such as URLs contained in JavaScript functions won&#8217;t be detected and so won&#8217;t be checked.</p>
./seo/auditors/PropertyDefinitionAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">PropertyDefinitionAuditor</a> checks to see if a specified node property is defined. Use this auditor for missing properties in pages or content nodes. It doesn&#8217;t check the value of the property, use <code>PropertyValidationAuditor</code> for that. Use <code>I18NPropertyDefinitionAuditor</code> to check the definition of internationalized properties (properties with language variants).</p>
./seo/auditors/ValidHtmlAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">ValidHtmlAuditor</a> checks the rendered HTML of a page for correctness using the W3C HTML validator. This auditor will capture and save any HTML errors found by the W3C HTML validator.</p>
./seo/auditors/I18NAuditor.html:1268:<p>The <a href="#" target="_blank" rel="noopener">I18NAuditor</a> will find all internationalized fields in a page and determine if the field has values for all supported languages. Supported languages and the default language are configured in the site definition.</p>
./seo/auditors/I18NAuditor.html:1347:See <a href="#" target="_blank" rel="noopener">ThresholdDelegate</a>.

a couple still found in prod-docs, so also fixed (#1782 DOCU-2832 convert to inLineBean)

grep -nHIrF -- /apidocs/ (v adresáři: /home/martin/grab/grab6238-Sep15-2023/docs.magnolia-cms.com/product-docs/6.2/Modules/List-of-modules)

./Device-Detection-module.html:3877:<p><a href="https://nexus.magnolia-cms.com/content/sites/magnolia.forge.sites/magnolia-module-device-detection/1.0.2/magnolia-module-device-detection/apidocs/index.html?info/magnolia/module/devicedetection/filter/DeviceDetectionFilter.html"><code>DeviceDetectionFilter</code></a>
./Device-Detection-module.html:3928:<a href="https://nexus.magnolia-cms.com/content/sites/magnolia.forge.sites/magnolia-module-device-detection/1.0.2/magnolia-module-device-detection/apidocs/index.html?info/magnolia/module/devicedetection/DeviceInfo.html"><code>DeviceInfo</code></a>
Search completed with 3 matches.
Generated at Mon Feb 12 01:30:41 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.