Publishing Scripts

Programmers who wish to share their Lipi scripts with other traders can publish them.

*Notice! If you write Lipi scripts for your personal use, there is no need to publish them; you can save them in the Lipi Editor and use the “Add” button to add your script to your chart.

Script Visibility and Access

When you publish a script, you control its visibility and access:

• Visibility is controlled by choosing to publish publicly or privately. Publish publicly when you have written a script you think can be useful to GoCharting users. Publish privately when you don’t want your script visible to all other users but want to share it with a few friends.

• Access determines if users will see your source code and how they will be able to use your script. There are two access types: open source, protected.

When You Publish a Script

• The publication’s title is determined by the argument used for the title parameter in the script’s indicator() declaration statement. That title is also used when GoCharting users search for script names.

• The name of your script on the chart will be the argument used for the shorttitle parameter in the script’s indicator() declaration statement.

• Your script must have a description explaining what it does and how to use it.

• The chart you are using when you publish will become visible in your publication, including any other scripts or drawings on it. Remove unrelated scripts or drawings from your chart before publishing your script.

• Your script’s code can later be updated. Each update can include release notes, which will appear, dated, under your original description.

• Scripts can be liked, shared, commented on, or reported by other users.

• Your published scripts appear under the “SCRIPTS” tab of your user profile.

• A script widget and a script page are created for your script. The script widget is your script’s placeholder showing in script feeds on the platform. It contains your script’s title, chart, and the first few lines of your description. When users click on your script widget, the script’s page opens, containing all the information relating to your script.

Visibility

Public

When you publish a public script:

• Your script will be included in our Community Scripts, making it visible to millions of GoCharting users on all international versions of the site.

• It becomes accessible through the search functions for scripts.

• You will not be able to edit your original description or its title, nor change its public/private visibility or its access type (open-source, protected).

• You will not be able to delete your publication.

Private

When you publish a private script:

• It will not be visible to other users unless you share its URL with them.

• It is visible to you from your user profile’s “SCRIPTS” tab.

• Private scripts are identifiable by “lock” icons in the top-right of their widget.

• You can update its original description and title.

• You cannot link to or mention it from any public GoCharting content (ideas, script descriptions, comments, chats, etc.).

• It is not accessible through the search functions for scripts.

Access

Public or private scripts can be published using one of two access types: open, protected. The access type you can select will vary with the type of account you hold.

• Open Source: The Lipi Script™ code of scripts published open is visible to all users.

• Protected: The code of protected scripts is hidden from view, and no one but its author can access it. Only accounts with paid plans may publish public protected scripts.

Preparing a Publication

1. Even if you intend to publish publicly, it is always best to start with a private publication. This approach allows you to validate what your final publication will look like. You can edit the title, description, code, or chart of private publications. Unlike public scripts, you can delete private scripts when you don’t need them anymore, making them the perfect way to practice before sharing a script publicly.

2. Prepare your chart: Load your script on the chart and remove any other scripts or drawings that won’t help users understand your script. Ensure that your script’s plots are easy to identify on the chart that will be published with it.

3. Load your code in the Lipi Editor if it isn’t already. In the Editor, click the “Publish Script” button:

4. Select the access type you want for your script: Open Source, Protected. We have selected “open-source”.

5. Fill in the details.

• Title:

  • Provide a meaningful title for your script.

• Analysis:

  • Add a description or explanation for the script (up to 1500 characters).
  • This helps users understand its purpose and usage.

• Tags:

  • Add relevant tags to make your script easily searchable.

7. Click the “Publish Private Script” button in the lower-right corner of the window. Once the publication is complete, your published script’s page will appear. You are done! You can confirm the publication by going to your User Profile and viewing your “SCRIPTS” tab. From there, you can open your script’s page and edit your private publication by using the “Edit” button in the top-right corner of your script’s page.

Note that you can also update private publications, just like public ones. If you want to share your private publication with a friend, privately send her the URL from your script’s page. Remember, you are not allowed to share links to private publications in public GoCharting content.

Publishing a Script

Whether you intend to publish privately or publicly, first follow the steps in the previous section. If you intend to publish privately, you will be done. If you intend to publish publicly and are satisfied with the preparatory process of validating your private publication, follow the same steps as above but do not check the “Private Script” checkbox and click the “Publish Public Script” button at the bottom-right of the “Publish Script” page.