pmd/docs/_data/sidebars/pmd_sidebar.yml

entries:
- title: sidebar
  folders:
  - title: null
    output: pdf
    type: frontmatter
    folderitems:
    - title: null
      url: /titlepage
      output: pdf
      type: frontmatter
    - title: null
      url: /tocpage
      output: pdf
      type: frontmatter
  - title: About
    output: web, pdf
    folderitems:
    - title: Home
      url: /index.html
      output: web, pdf
      type: homepage
    - title: Release notes
      url: /pmd_release_notes.html
      output: web, pdf
    - title: Release notes (PMD 7)
      url: /pmd_release_notes_pmd7.html
      output: web, pdf
    - title: Getting help
      url: /pmd_about_help.html
      output: web, pdf
    - title: Release policies
      url: /pmd_about_release_policies.html
      output: web, pdf
    - title: Support lifecycle
      url: /pmd_about_support_lifecycle.html
      output: web, pdf
  - title: User Documentation
    output: web, pdf
    folderitems:
    - title: Migration Guide for PMD 7
      url: /pmd_userdocs_migrating_to_pmd7.html
      output: web, pdf
    - title: Installation and basic CLI usage
      url: /pmd_userdocs_installation.html
      output: web, pdf
    - title: Making rulesets
      url: /pmd_userdocs_making_rulesets.html
      output: web, pdf
    - title: Configuring rules
      url: /pmd_userdocs_configuring_rules.html
      output: web, pdf
    - title: Best practices
      url: /pmd_userdocs_best_practices.html
      output: web, pdf
    - title: Suppressing warnings
      url: /pmd_userdocs_suppressing_warnings.html
      output: web, pdf
    - title: Incremental analysis
      url: /pmd_userdocs_incremental_analysis.html
      output: web, pdf
    - title: PMD CLI reference
      url: /pmd_userdocs_cli_reference.html
      output: web, pdf
    - title: PMD Report formats
      url: /pmd_userdocs_report_formats.html
      output: web, pdf
    - title: 3rd party rulesets
      output: web, pdf
      url: /pmd_userdocs_3rdpartyrulesets.html
    - title: null
      output: web, pdf
      subfolders:
      - title: CPD reference
        output: web, pdf
        subfolderitems:
        - title: Copy-paste detection
          url: /pmd_userdocs_cpd.html
          output: web, pdf
        - title: CPD Report formats
          url: /pmd_userdocs_cpd_report_formats.html
          output: web, pdf
    - title: null
      output: web, pdf
      subfolders:
      - title: Extending PMD
        output: web, pdf
        subfolderitems:
        - title: Introduction to writing rules
          url: /pmd_userdocs_extending_writing_rules_intro.html
          output: web, pdf
        - title: Your first rule
          url: /pmd_userdocs_extending_your_first_rule.html
          output: web, pdf
        - title: XPath rules
          url: /pmd_userdocs_extending_writing_xpath_rules.html
          output: web, pdf
        - title: Java rules
          url: /pmd_userdocs_extending_writing_java_rules.html
          output: web, pdf
        - title: Rule designer reference
          url: /pmd_userdocs_extending_designer_reference.html
          output: web, pdf
        - title: Defining rule properties
          url: /pmd_userdocs_extending_defining_properties.html
          output: web, pdf
        - title: Rule guidelines
          url: /pmd_userdocs_extending_rule_guidelines.html
          output: web, pdf
        - title: Testing your rules
          url: /pmd_userdocs_extending_testing.html
          output: web, pdf
        - title: Creating (XML) dump of the AST
          url: /pmd_userdocs_extending_ast_dump.html
          output: web, pdf
    - title: null
      output: web, pdf
      subfolders:
      - title: Tools / Integrations
        output: web, pdf
        subfolderitems:
        - title: Maven PMD Plugin
          output: web, pdf
          url: /pmd_userdocs_tools_maven.html
        - title: Gradle
          output: web, pdf
          url: /pmd_userdocs_tools_gradle.html
        - title: Ant
          output: web, pdf
          url: /pmd_userdocs_tools_ant.html
        - title: PMD Java API
          output: web, pdf
          url: /pmd_userdocs_tools_java_api.html
        - title: bld PMD Extension
          output: web, pdf
          url: /pmd_userdocs_tools_bld.html
        - title: CI integrations
          output: web, pdf
          url: /pmd_userdocs_tools_ci.html
        - title: Other Tools / Integrations
          output: web, pdf
          url: /pmd_userdocs_tools.html
  - title: Rule Reference
    output: web, pdf
    folderitems:
    - title: null
      output: web, pdf
      subfolders:
      - title: Apex Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_apex.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_apex_bestpractices.html
        - title: Code Style
          output: web, pdf
          url: /pmd_rules_apex_codestyle.html
        - title: Design
          output: web, pdf
          url: /pmd_rules_apex_design.html
        - title: Documentation
          output: web, pdf
          url: /pmd_rules_apex_documentation.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_apex_errorprone.html
        - title: Performance
          output: web, pdf
          url: /pmd_rules_apex_performance.html
        - title: Security
          output: web, pdf
          url: /pmd_rules_apex_security.html
    - title: null
      output: web, pdf
      subfolders:
      - title: HTML Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_html.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_html_bestpractices.html
    - title: null
      output: web, pdf
      subfolders:
      - title: Java Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_java.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_java_bestpractices.html
        - title: Code Style
          output: web, pdf
          url: /pmd_rules_java_codestyle.html
        - title: Design
          output: web, pdf
          url: /pmd_rules_java_design.html
        - title: Documentation
          output: web, pdf
          url: /pmd_rules_java_documentation.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_java_errorprone.html
        - title: Multithreading
          output: web, pdf
          url: /pmd_rules_java_multithreading.html
        - title: Performance
          output: web, pdf
          url: /pmd_rules_java_performance.html
        - title: Security
          output: web, pdf
          url: /pmd_rules_java_security.html
    - title: null
      output: web, pdf
      subfolders:
      - title: Java Server Pages Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_jsp.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_jsp_bestpractices.html
        - title: Code Style
          output: web, pdf
          url: /pmd_rules_jsp_codestyle.html
        - title: Design
          output: web, pdf
          url: /pmd_rules_jsp_design.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_jsp_errorprone.html
        - title: Security
          output: web, pdf
          url: /pmd_rules_jsp_security.html
    - title: null
      output: web, pdf
      subfolders:
      - title: JavaScript Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_ecmascript.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_ecmascript_bestpractices.html
        - title: Code Style
          output: web, pdf
          url: /pmd_rules_ecmascript_codestyle.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_ecmascript_errorprone.html
        - title: Performance
          output: web, pdf
          url: /pmd_rules_ecmascript_performance.html
    - title: null
      output: web, pdf
      subfolders:
      - title: Kotlin Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_kotlin.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_kotlin_bestpractices.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_kotlin_errorprone.html
    - title: null
      output: web, pdf
      subfolders:
      - title: Maven POM Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_pom.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_pom_errorprone.html
    - title: null
      output: web, pdf
      subfolders:
      - title: Modelica Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_modelica.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_modelica_bestpractices.html
    - title: null
      output: web, pdf
      subfolders:
      - title: PLSQL Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_plsql.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_plsql_bestpractices.html
        - title: Code Style
          output: web, pdf
          url: /pmd_rules_plsql_codestyle.html
        - title: Design
          output: web, pdf
          url: /pmd_rules_plsql_design.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_plsql_errorprone.html
    - title: null
      output: web, pdf
      subfolders:
      - title: Salesforce Visualforce Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_visualforce.html
        - title: Security
          output: web, pdf
          url: /pmd_rules_visualforce_security.html
    - title: null
      output: web, pdf
      subfolders:
      - title: Scala Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_scala.html
    - title: null
      output: web, pdf
      subfolders:
      - title: Swift Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_swift.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_swift_bestpractices.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_swift_errorprone.html
    - title: null
      output: web, pdf
      subfolders:
      - title: Velocity Template Language (VTL) Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_velocity.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_velocity_bestpractices.html
        - title: Design
          output: web, pdf
          url: /pmd_rules_velocity_design.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_velocity_errorprone.html
    - title: null
      output: web, pdf
      subfolders:
      - title: WSDL Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_wsdl.html
    - title: null
      output: web, pdf
      subfolders:
      - title: XML Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_xml.html
        - title: Best Practices
          output: web, pdf
          url: /pmd_rules_xml_bestpractices.html
        - title: Error Prone
          output: web, pdf
          url: /pmd_rules_xml_errorprone.html
    - title: null
      output: web, pdf
      subfolders:
      - title: XSL Rules
        output: web, pdf
        subfolderitems:
        - title: Index
          output: web, pdf
          url: /pmd_rules_xsl.html
        - title: Code Style
          output: web, pdf
          url: /pmd_rules_xsl_codestyle.html
        - title: Performance
          output: web, pdf
          url: /pmd_rules_xsl_performance.html
  - title: Language-Specific Documentation
    output: web, pdf
    folderitems:
    - title: Overview
      url: /pmd_languages_index.html
      output: web, pdf
    - title: Language configuration
      url: /pmd_languages_configuration.html
      output: web, pdf
    - title: Apex
      url: /pmd_languages_apex.html
      output: web, pdf
    - title: C/C++
      url: /pmd_languages_cpp.html
      output: web, pdf
    - title: C#
      url: /pmd_languages_cs.html
      output: web, pdf
    - title: Coco
      url: /pmd_languages_coco.html
      output: web, pdf
    - title: Dart
      url: /pmd_languages_dart.html
      output: web, pdf
    - title: Fortran
      url: /pmd_languages_fortran.html
      output: web, pdf
    - title: Gherkin
      url: /pmd_languages_gherkin.html
      output: web, pdf
    - title: Go
      url: /pmd_languages_go.html
      output: web, pdf
    - title: Groovy
      url: /pmd_languages_groovy.html
    - title: HTML
      url: /pmd_languages_html.html
      output: web, pdf
    - title: Java
      url: /pmd_languages_java.html
      output: web, pdf
    - title: JavaScript / TypeScript
      url: /pmd_languages_js_ts.html
      output: web, pdf
    - title: JSP
      url: /pmd_languages_jsp.html
      output: web, pdf
    - title: Julia
      url: /pmd_languages_julia.html
      output: web, pdf
    - title: Kotlin
      url: /pmd_languages_kotlin.html
      output: web, pdf
    - title: Lua
      url: /pmd_languages_lua.html
      output: web, pdf
    - title: Matlab
      url: /pmd_languages_matlab.html
      output: web, pdf
    - title: Modelica
      url: /pmd_languages_modelica.html
      output: web, pdf
    - title: Objective-C
      url: /pmd_languages_objectivec.html
      output: web, pdf
    - title: Perl
      url: /pmd_languages_perl.html
      output: web, pdf
    - title: PHP
      url: /pmd_languages_php.html
      output: web, pdf
    - title: PLSQL
      url: /pmd_languages_plsql.html
      output: web, pdf
    - title: Python
      url: /pmd_languages_python.html
      output: web, pdf
    - title: Ruby
      url: /pmd_languages_ruby.html
      output: web, pdf
    - title: Scala
      url: /pmd_languages_scala.html
      output: web, pdf
    - title: Swift
      url: /pmd_languages_swift.html
      output: web, pdf
    - title: T-SQL
      url: /pmd_languages_tsql.html
      output: web, pdf
    - title: Visualforce
      url: /pmd_languages_visualforce.html
      output: web, pdf
    - title: Velocity Template Language (VTL)
      url: /pmd_languages_velocity.html
      output: web, pdf
    - title: XML and XML dialects
      url: /pmd_languages_xml.html
      output: web, pdf
  - title: Developer Documentation
    output: web, pdf
    folderitems:
    - title: Developer resources
      url: /pmd_devdocs_development.html
      output: web, pdf
    - title: Building PMD from source
      url: /pmd_devdocs_building.html
      output: web, pdf
    - title: Contributing
      external_url: https://github.com/pmd/pmd/blob/main/CONTRIBUTING.md
      output: web, pdf
    - title: Writing documentation
      url: /pmd_devdocs_writing_documentation.html
      output: web, pdf
    - title: Roadmap
      url: /pmd_devdocs_roadmap.html
      output: web, pdf
    - title: How PMD works
      url: /pmd_devdocs_how_pmd_works.html
      output: web, pdf
    - title: Pmdtester
      url: /pmd_devdocs_pmdtester.html
      output: web, pdf
    - title: Rule Deprecation Policy
      url: /pmd_devdocs_rule_deprecation_policy.html
      output: web, pdf
    - title: null
      output: web, pdf
      subfolders:
      - title: Major contributions
        output: web, pdf
        subfolderitems:
        - title: Rule Guidelines
          url: /pmd_devdocs_major_rule_guidelines.html
          output: web, pdf
        - title: Adding a new language (JavaCC)
          url: /pmd_devdocs_major_adding_new_language_javacc.html
          output: web, pdf
        - title: Adding a new language (ANTLR)
          url: /pmd_devdocs_major_adding_new_language_antlr.html
          output: web, pdf
        - title: Adding a new CPD language
          url: /pmd_devdocs_major_adding_new_cpd_language.html
          output: web, pdf
      - title: Experimental features
        output: web, pdf
        subfolderitems:
        - title: List of experimental Features
          url: /tag_experimental.html
          output: web, pdf
  - title: Project documentation
    output: web, pdf
    folderitems:
    - title: null
      output: web, pdf
      subfolders:
      - title: Trivia about PMD
        output: web, pdf
        subfolderitems:
        - title: PMD in the press
          url: /pmd_projectdocs_trivia_news.html
          output: web, pdf
        - title: Products & books related to PMD
          url: /pmd_projectdocs_trivia_products.html
          output: web, pdf
        - title: Similar projects
          url: /pmd_projectdocs_trivia_similarprojects.html
          output: web, pdf
        - title: What does 'PMD' mean?
          url: /pmd_projectdocs_trivia_meaning.html
          output: web, pdf
    - title: Logo
      url: /pmd_projectdocs_logo.html
      output: web, pdf
    - title: FAQ
      url: /pmd_projectdocs_faq.html
      output: web, pdf
    - title: License
      url: /license.html
      output: web, pdf
    - title: Credits
      url: /pmd_projectdocs_credits.html
      output: web, pdf
    - title: Old release notes
      url: /pmd_release_notes_old.html
      output: web, pdf
    - title: Decisions
      url: /pmd_projectdocs_decisions.html
      output: web, pdf
    - title: null
      output: web, pdf
      subfolders:
      - title: Project management
        output: web, pdf
        subfolderitems:
        - title: Infrastructure
          url: /pmd_projectdocs_committers_infrastructure.html
          output: web, pdf
        - title: Release process
          url: /pmd_projectdocs_committers_releasing.html
          output: web, pdf
        - title: Merging pull requests
          url: /pmd_projectdocs_committers_merging_pull_requests.html
          output: web, pdf
        - title: Main Landing page
          url: /pmd_projectdocs_committers_main_landing_page.html
          output: web, pdf