### Install Jekyll for Documentation

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/bootstrap/README.md

Instructions for installing Jekyll, a static site generator used for Bootstrap's documentation. Ensure you have Jekyll v2.5.x installed.

```bash
gem install rouge
```

--------------------------------

### Install metisMenu via Bower

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/metisMenu/README.md

Use this command to install the metisMenu plugin using Bower.

```bash
bower install metisMenu
```

--------------------------------

### Install metisMenu via npm

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/metisMenu/README.md

Use this command to install the metisMenu plugin using npm.

```bash
npm install metismenu
```

--------------------------------

### Basic Series Customization Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Example of setting options to show both lines and points for a data series, with specific fill and color settings for lines.

```javascript
var options = {
    series: {
        lines: { show: true, fill: true, fillColor: "rgba(255, 255, 255, 0.8)" },
        points: { show: true, fill: false }
    }
};
```

--------------------------------

### Build and Run JMeter from Distribution

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Builds the project, copies necessary JARs to the root directory, and starts JMeter.

```bash
gw createDist; ./bin/jmeter
```

--------------------------------

### Simple Line Chart Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/README.md

A minimal example demonstrating how to draw a line chart with Flot, plotting points from (0,0) to (1,1) and setting the maximum value for the y-axis.

```javascript
$.plot($("#placeholder"), [ [[0, 0], [1, 1]] ], { yaxis: { max: 1 } });
```

--------------------------------

### Markings Array Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

An example of how to define markings using an array, specifying ranges and colors for background elements like lines and areas.

```javascript
markings: [ { xaxis: { from: 0, to: 2 }, yaxis: { from: 10, to: 10 }, color: "#bb0000" }, ... ]
```

--------------------------------

### Jmeter Plotting Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Example of how to plot data using $.plot, illustrating data points and series.

```javascript
$.plot($("#placeholder"), [ { label: "Foo", data: [[0, 10], [7, 3]] } ], ...);
```

--------------------------------

### Complete Debug Plugin Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/PLUGINS.md

A comprehensive example of a Flot plugin that alerts series information. It demonstrates using options to control debug level, registering hooks for option processing and data point handling, and avoiding name pollution.

```javascript
(function ($) {
    function init(plot) {
        var debugLevel = 1;

        function checkDebugEnabled(plot, options) {
            if (options.debug) {
                debugLevel = options.debug;
                plot.hooks.processDatapoints.push(alertSeries);
            }
        }

        function alertSeries(plot, series, datapoints) {
            var msg = "series " + series.label;
            if (debugLevel > 1) {
                msg += " with " + series.data.length + " points";
                alert(msg);
            }
        }

        plot.hooks.processOptions.push(checkDebugEnabled);
    }

    var options = { debug: 0 };
      
    $.plot.plugins.push({
        init: init,
        options: options,
        name: "simpledebug",
        version: "0.1"
    });
})(jQuery);
```

--------------------------------

### Flot Data Example: Series with Label and Data

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Example of a data specification with multiple series, each having a label and associated data points.

```javascript
[ { label: "Foo", data: [ [10, 1], [17, -14], [30, 5] ] },
  { label: "Bar", data: [ [11, 13], [19, 11], [30, -7] ] }
]
```

--------------------------------

### Ruby Time Conversion Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/NEWS.md

This snippet provides an example of time conversion using Ruby, as included in the Flot 0.8.2 release notes.

```ruby
require 'date'

# Convert a Unix timestamp to a human-readable date and time
unix_timestamp = 1371336000 # Example timestamp
date_time = DateTime.strptime(Time.at(unix_timestamp).to_s, '%Y-%m-%d %H:%M:%S')
puts "Converted date and time: #{date_time.strftime('%Y-%m-%d %H:%M:%S')}"

# Convert a date and time string to a Unix timestamp
date_string = "2023-10-27 10:30:00"
date_object = DateTime.parse(date_string)
unix_timestamp_from_date = date_object.to_time.to_i
puts "Converted Unix timestamp: #{unix_timestamp_from_date}"
```

--------------------------------

### Start JMeter Function

Source: https://github.com/apache/jmeter/blob/master/src/protocol/http/src/test/resources/testfiles/HTMLScript.html

Calls the HM_f_StartIt function, likely initiating a JMeter test or process.

```javascript
HM_f_StartIt();
```

--------------------------------

### Flot Data Example: Raw Points

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Example of raw data points for a Flot series. Ensure numeric values for coordinates.

```javascript
[ [1, 3], [2, 14.01], [3.5, 3.14] ]
```

--------------------------------

### Plugin Usage Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/PLUGINS.md

Illustrates how to include and use the 'simpledebug' plugin in an HTML page by referencing the JavaScript file and passing the 'debug' option when calling $.plot.

```javascript
$.plot($("#placeholder"), [...], { debug: 2 });
```

--------------------------------

### Run JMeter GUI with Gradle

Source: https://github.com/apache/jmeter/blob/master/README.md

Launch the JMeter GUI directly using the `runGui` Gradle task. This is a convenient way to start JMeter for test plan creation and execution in GUI mode.

```sh
./gradlew runGui
```

--------------------------------

### Custom Flot Tick Formatter Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Provide a custom function to format ticks on a Flot time-based axis. This example formats dates as DD/MM.

```javascript
tickFormatter: function (val, axis) {
    var d = new Date(val);
    return d.getUTCDate() + "/" + (d.getUTCMonth() + 1);
}
```

--------------------------------

### Jmeter Grid Background Gradient

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Example of specifying a gradient for the grid background, transitioning from black to gray.

```javascript
grid: {
    backgroundColor: { colors: ["#000", "#999"] }
}
```

--------------------------------

### Default Color Theme Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Specifies an array of colors to be used as a default theme for data series. Flot will generate additional colors if needed.

```javascript
colors: ["#d18b2c", "#dba255", "#919733"]
```

--------------------------------

### Markings Function Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Demonstrates how to create vertical stripes in the plot background using a function that generates markings based on axis data.

```javascript
markings: function (axes) {
    var markings = [];
    for (var x = Math.floor(axes.xaxis.min); x < axes.xaxis.max; x += 2)
        markings.push({ xaxis: { from: x, to: x + 1 } });
    return markings;
}
```

--------------------------------

### Basic Axis Label Configuration

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot-axislabels/README.md

Configure basic axis labels for Flot charts using the flot-axislabels plugin. This example shows how to enable axis labels and define labels for the x-axis and both y-axes.

```javascript
$(function () {
    var options = {
        axisLabels: {
            show: true
        },
        xaxes: [{
            axisLabel: 'foo',
        }],
        yaxes: [{
            position: 'left',
            axisLabel: 'bar',
        }, {
            position: 'right',
            axisLabel: 'bleem'
        }]
    };

    $.plot($("#placeholder"),
           yourData,
           options);
    );
});
```

--------------------------------

### Build All Distributions

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Assembles both source and binary distributions for the project.

```bash
gw :src:dist:assemble
```

--------------------------------

### List All Build Parameters

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Displays all configurable build parameters available for the project.

```bash
gw parameters
```

--------------------------------

### Build Project

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Executes the default 'build' task, which includes compiling, testing, and packaging.

```bash
gw build
```

--------------------------------

### Preview Site

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Generates a preview of the project's website, outputting to `src/dist/build/site`.

```bash
gw :src:dist:previewSite
```

--------------------------------

### Flot processDatapoints Hook Example

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

The processDatapoints hook is called after data normalization but before min/max calculation. This example multiplies all y coordinates by 2.

```javascript
function multiply(plot, series, datapoints) {
    var points = datapoints.points, ps = datapoints.pointsize;
    for (var i = 0; i < points.length; i += ps)
        points[i + 1] *= 2;
}
```

--------------------------------

### Publish Site Preview

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Builds and publishes the site preview to a Git repository.

```bash
gw :src:dist:pushPreviewSite
```

--------------------------------

### Serve Bootstrap Documentation Locally

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/bootstrap/README.md

Command to run the Bootstrap documentation locally using Jekyll. Access it via http://localhost:9001 in your browser.

```bash
jekyll serve
```

--------------------------------

### Apply Code Formatting with Spotless

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Runs Spotless to automatically format the code according to the defined rules.

```bash
gw spotlessApply
```

--------------------------------

### Display Dependencies for All Projects

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Lists the dependency trees for all modules in the project.

```bash
gw allDependencies
```

--------------------------------

### Get JavaScript Timestamp

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Use `(new Date()).getTime()` to get the current time as a JavaScript timestamp (milliseconds since January 1, 1970 UTC).

```javascript
alert((new Date()).getTime())
```

--------------------------------

### Prepare Release Vote (RC 1)

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Builds the project, pushes artifacts to a development repository, and stages them in a Nexus repository for a release vote. Uses an ASF-like release environment.

```bash
gw prepareVote -Prc=1
```

--------------------------------

### Apply Code Formatting and Checks

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Runs Spotless (for formatting) and Checkstyle (for code quality) on the entire project.

```bash
gw style
```

--------------------------------

### Display Project Dependencies

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Shows the dependency tree for the current module. Gradle's 'configurations' define different classpaths.

```bash
gw dependencies
```

--------------------------------

### Define and Parse Command-Line Options in Java

Source: https://github.com/apache/jmeter/blob/master/src/jorphan/src/main/resources/org/apache/commons/cli/avalon/package.html

Demonstrates how to define command-line options with short and long forms, their argument requirements, and descriptions. It then parses arguments using CLArgsParser and processes them using a switch statement.

```java
import java.util.List;

import org.apache.commons.cli.avalon.CLArgsParser;
import org.apache.commons.cli.avalon.CLOption;
import org.apache.commons.cli.avalon.CLOptionDescriptor;
import org.apache.commons.cli.avalon.CLUtil;

/**
 * Demonstrates the excalibur command-line parsing utility.
 *
 */
public class CLDemo {
    // Define our short one-letter option identifiers.
    protected static final int HELP_OPT = 'h';
    protected static final int VERSION_OPT = 'v';
    protected static final int MSG_OPT = 'm';

    /**
     *  Define the understood options. Each CLOptionDescriptor contains:
     * - The "long" version of the option. Eg, "help" means that "--help" will
     * be recognised.
     * - The option flags, governing the option's argument(s).
     * - The "short" version of the option. Eg, 'h' means that "-h" will be
     * recognised.
     * - A description of the option.
     */
    protected static final CLOptionDescriptor [] options = new CLOptionDescriptor [] {
        new CLOptionDescriptor("help",
                CLOptionDescriptor.ARGUMENT_DISALLOWED,
                HELP_OPT,
                "print this message and exit"),
        new CLOptionDescriptor("version",
                CLOptionDescriptor.ARGUMENT_DISALLOWED,
                VERSION_OPT,
                "print the version information and exit"),
        new CLOptionDescriptor("msg",
                CLOptionDescriptor.ARGUMENT_REQUIRED,
                MSG_OPT,
                "the message to print"),
    };

    public static void main(String args[]) {
        // Parse the arguments
        CLArgsParser parser = new CLArgsParser(args, options);

        if( null != parser.getErrorString() ) {
           System.err.println( "Error: " + parser.getErrorString() );
           return;
        }

        // Get a list of parsed options
        List clOptions = parser.getArguments();
        int size = clOptions.size();

        for (int i = 0; i < size; i++) {
            CLOption option = (CLOption) clOptions.get(i);

            switch (option.getId()) {
                case CLOption.TEXT_ARGUMENT:
                    System.out.println("Unknown arg: "+option.getArgument());
                    break;

                case HELP_OPT:
                    printUsage();
                    break;

                case VERSION_OPT:
                    printVersion();
                    break;


                case MSG_OPT:
                    System.out.println(option.getArgument());
                    break;
            }
        }
    }

    private static void printVersion() {
        System.out.println("1.0");
        System.exit(0);
    }

    private static void printUsage() {
        String lSep = System.getProperty("line.separator");
        StringBuffer msg = new StringBuffer();
        msg.append("------------------------------------------------------------------------ ").append(lSep);
        msg.append("Excalibur command-line arg parser demo").append(lSep);
        msg.append("Usage: java "+CLDemo.class.getName()+" [options]").append(lSep).append(lSep);
        msg.append("Options: ").append(lSep);
        msg.append(CLUtil.describeOptions(CLDemo.options).toString());
        System.out.println(msg.toString());
        System.exit(0);
    }
}
```

--------------------------------

### Custom Legend Label Formatter in Flot

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/NEWS.md

Use the legend.labelFormatter option to customize legend labels, for example, to turn them into links.

```javascript
legend: {
  labelFormatter: function(label, series) {
    return '<a href="#">' + label + '</a>';
  }
}
```

--------------------------------

### Build Project Jar

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Builds the project's JAR file, which will be located in the `build/libs/` directory.

```bash
gw jar
```

--------------------------------

### Build and Run JMeter GUI

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Use this command to build the JMeter project and then launch the graphical user interface.

```bash
gw runGui
```

--------------------------------

### Convert to Timestamp in PHP

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

In PHP, convert a date string to a timestamp by using `strtotime()` and multiplying by 1000 to get milliseconds.

```php
strtotime("2002-02-20 UTC") * 1000
```

--------------------------------

### JavaScript Font Specification Object

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Provides an example of a font specification object for detailed control over axis tick label styles.

```javascript
{
    size: 11,
    lineHeight: 13,
    style: "italic",
    weight: "bold",
    family: "sans-serif",
    variant: "small-caps",
    color: "#545454"
}
```

--------------------------------

### Bootstrap Project Structure

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/bootstrap/README.md

This tree shows the common directories and files included in a Bootstrap download, including compiled and minified CSS and JS, source maps, and fonts.

```bash
bootstrap/
├── css/
│   ├── bootstrap.css
│   ├── bootstrap.css.map
│   ├── bootstrap.min.css
│   ├── bootstrap-theme.css
│   ├── bootstrap-theme.css.map
│   └── bootstrap-theme.min.css
├── js/
│   ├── bootstrap.js
│   └── bootstrap.min.js
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
    ├── glyphicons-halflings-regular.woff
    └── glyphicons-halflings-regular.woff2
```

--------------------------------

### Flot Series Object Example: Label and Data

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

A minimal series object specification including a label for the legend and the data points.

```javascript
{
    label: "y = 3",
    data: [[0, 3], [10, 3]]
}
```

--------------------------------

### List Available Gradle Build Parameters

Source: https://github.com/apache/jmeter/blob/master/README.md

Execute the `parameters` Gradle task to display all available build parameters and options. This is useful for understanding and customizing the build process.

```sh
./gradlew parameters
```

--------------------------------

### Get Javascript Timestamp in .NET

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Use this .NET method to convert a DateTime object into a JavaScript-compatible timestamp (milliseconds since epoch).

```csharp
public static int GetJavascriptTimestamp(System.DateTime input)
{
    System.TimeSpan span = new System.TimeSpan(System.DateTime.Parse("1/1/1970").Ticks);
    System.DateTime time = input.Subtract(span);
    return (long)(time.Ticks / 10000);
}
```

--------------------------------

### Bind Mouse Down Event Handler

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Example of binding a mousedown event handler to the eventHolder. This hook is called after Flot has set up its event handlers.

```javascript
function (plot, eventHolder) {
    eventHolder.mousedown(function (e) {
        alert("You pressed the mouse at " + e.pageX + " " + e.pageY);
    });
}
```

--------------------------------

### Prepare Release Vote (RC 2 with ASF)

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Prepares another release candidate for a vote, specifically using ASF conventions.

```bash
gw prepareVote -Prc=2 -Pasf
```

--------------------------------

### Jmeter Series Color Gradient

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Specifies a gradient for series colors, adjusting opacity and brightness. This example shows bars gradually disappearing.

```javascript
{ colors: [{ opacity: 0.8 }, { brightness: 0.6, opacity: 0.8 } ] }
```

--------------------------------

### Build Project in Parallel

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Builds the project, enabling parallel execution of tasks to potentially speed up the process.

```bash
gw build --parallel
```

--------------------------------

### Deprecated axis.noTicks in Flot

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/NEWS.md

Replaced axis.noTicks with axis.ticks for specifying the number of ticks. For example, use { ticks: 10 } instead of { noTicks: 10 }.

```javascript
xaxis: { ticks: 10 }
```

--------------------------------

### Display Tasks for Current Module

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Shows all available tasks for the currently selected Gradle module.

```bash
gw tasks
```

--------------------------------

### Build JMeter Addons with Ant

Source: https://github.com/apache/jmeter/blob/master/extras/addons.txt

Use this command to compile JMeter addon sources and create a JAR file. Ensure 'addons.xml' is in the JMeter home directory.

```bash
ant -buildfile addons.xml
```

--------------------------------

### Getting Plot Dimensions in Jmeter

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Use width() and height() to retrieve the dimensions of the plotting area within the grid, excluding space for labels and other elements.

```javascript
width()
```

```javascript
height()
```

--------------------------------

### Custom Tick Generator Function in Flot

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Implement a function to dynamically generate ticks based on axis properties. This example generates ticks at intervals of pi.

```javascript
function piTickGenerator(axis) {
    var res = [], i = Math.floor(axis.min / Math.PI);
    do {
        var v = i * Math.PI;
        res.push([v, i + "\u03c0"]);
        ++i;
    } while (v < axis.max);
    return res;
}
```

--------------------------------

### Display Submodules

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Lists all the submodules within the Gradle project.

```bash
gw projects
```

--------------------------------

### Check Code Formatting with Spotless

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Runs Spotless to check if the code adheres to the defined formatting rules without applying changes.

```bash
gw spotlessCheck
```

--------------------------------

### Getting Plot Offset in Jmeter

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

The offset() method returns the position of the plotting area relative to the document, useful for calculating mouse coordinates within the plot.

```javascript
offset()
```

--------------------------------

### Getting Plot Data Series in Jmeter

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

getData() returns an array of the current data series with normalized settings. This is useful for inspecting properties like color or datapoints.

```javascript
var series = plot.getData();
    for (var i = 0; i < series.length; ++i)
        alert(series[i].color);
```

--------------------------------

### Run Core Module Tests

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Executes the unit tests specifically for the ':src:core' module.

```bash
gw :src:core:test
```

--------------------------------

### Convert to Timestamp in Ruby

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

In Ruby, multiply the result of `Time.now.to_i` by 1000 to get milliseconds. This also applies to `DateTime` and `ActiveSupport::TimeWithZone` objects when using the `active_support` gem.

```ruby
Time.now.to_i * 1000     # => 1383582043000
# ActiveSupport examples:
DateTime.now.to_i * 1000 # => 1383582043000
ActiveSupport::TimeZone.new('Asia/Shanghai').now.to_i * 1000
```

--------------------------------

### Custom Legend Label Formatting

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Example of a labelFormatter function to make legend labels clickable links. The function receives the label and series object, returning an HTML string for the label.

```javascript
labelFormatter: function(label, series) {
    // series is the series object for the label
    return '<a href="#' + label + '">' + label + '</a>';
}
```

--------------------------------

### Publish to Maven Local

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Publishes the project's artifacts to the local Maven repository.

```bash
gw publishToMavenLocal
```

--------------------------------

### Generate Eclipse Project with Gradle

Source: https://github.com/apache/jmeter/blob/master/CONTRIBUTING.md

Use the Gradle wrapper to generate an Eclipse project configuration. This command is useful for developers using Eclipse as their IDE.

```bash
./gradlew eclipse
```

--------------------------------

### Calculating Data Point Offset in Jmeter

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

Use pointOffset() to get the pixel offset of a data point within the placeholder div, based on its data coordinates. You can specify axes for multi-axis plots.

```javascript
o = pointOffset({ x: xpos, y: ypos, xaxis: 2, yaxis: 3 })
```

--------------------------------

### Generate Javadocs

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Builds the Javadoc documentation for the project, outputting to `build/docs/javadoc`.

```bash
gw javadoc
```

--------------------------------

### Initialize metisMenu

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/metisMenu/README.md

Call the metisMenu plugin on your menu element to initialize it.

```javascript
$("#menu").metisMenu();
```

--------------------------------

### Getting Plot Axes in Jmeter

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/API.md

getAxes() returns an object containing all axes, accessible via properties like xaxis or y2axis. It provides access to tick information and transformation functions (p2c, c2p).

```javascript
getAxes().xaxis.ticks
```

```javascript
getAxes().xaxis.p2c
```

```javascript
getAxes().xaxis.c2p
```

```javascript
getAxes().y2axis.used
```

--------------------------------

### Run Check Task with Gradle

Source: https://github.com/apache/jmeter/blob/master/CONTRIBUTING.md

Execute the check task using Gradle to ensure all tests pass before submitting a patch. This is a mandatory step for contributions.

```bash
./gradlew check
```

--------------------------------

### Run All Tests

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Executes all tests, including unit tests, checkstyle, and other static analysis tasks.

```bash
gw check
```

--------------------------------

### Run Unit Tests

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Executes only the unit tests for the project.

```bash
gw test
```

--------------------------------

### Run Release Audit Tool (RAT)

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Executes the Release Audit Tool to check for license compliance in the project's files.

```bash
gw rat
```

--------------------------------

### Basic Plugin Initialization

Source: https://github.com/apache/jmeter/blob/master/bin/report-template/sbadmin2-1.0.7/bower_components/flot/PLUGINS.md

Demonstrates the fundamental structure for creating a Flot plugin by defining an init function and adding it to the $.plot.plugins array. This plugin adds a custom attribute to the plot object.

```javascript
function myCoolPluginInit(plot) {
    plot.coolstring = "Hello!";
};

$.plot.plugins.push({ init: myCoolPluginInit, options: { ... } });

// if $.plot is called, it will return a plot object with the
// attribute "coolstring"
```

--------------------------------

### Run Checkstyle for All Code

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Executes the Checkstyle tool on all source files in the project to enforce coding standards.

```bash
gw checkstyleAll
```

--------------------------------

### Create JMeter Distribution with Gradle

Source: https://github.com/apache/jmeter/blob/master/README.md

Use the `createDist` Gradle task to compile the application and prepare it for running JMeter from the `bin` directory. Note that this task refreshes `lib/` contents, potentially removing custom plugins.

```sh
./gradlew createDist
```

--------------------------------

### Sign Artifacts

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Signs all artifacts of the current module using the Gradle signing plugin. Results are found in `build/**/*.asc`. Signing is automatically performed as part of the release artifact build.

```bash
gw sign
```

--------------------------------

### Generate POM Files

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Generates all necessary POM files (e.g., pom-default.xml) for Maven compatibility. Files are placed in individual `src/**/build/publications` folders.

```bash
gw generatePom
```

--------------------------------

### Configure Gradle Proxy Settings

Source: https://github.com/apache/jmeter/blob/master/README.md

Set proxy host, port, username, and password for Gradle to use when building JMeter behind a proxy. These properties should be added to `~/.gradle/gradle.properties`.

```properties
systemProp.http.proxyHost=proxy.example.invalid
systemProp.http.proxyPort=8080
systemProp.http.proxyUser=your_user_name
systemProp.http.proxyPassword=your_password
systemProp.https.proxyHost=proxy.example.invalid
systemProp.https.proxyPort=8080
systemProp.https.proxyUser=your_user_name
systemProp.https.proxyPassword=your_password
```

--------------------------------

### Generate Javadoc JAR

Source: https://github.com/apache/jmeter/blob/master/gradle.md

Builds a JAR file containing the Javadoc documentation, typically for distribution.

```bash
gw javadocJar
```