Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
- master
paths-ignore:
- 'scripts/**'
- 'docs/**'
- '**/*.md'
push:
branches:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/scripts-android.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ name: Test Android build scripts
- '!Ports/Android/**/*.md'
- 'tests/**'
- '!tests/**/*.md'
- '!docs/**'
push:
branches:
- master
Expand All @@ -42,6 +43,7 @@ name: Test Android build scripts
- '!Ports/Android/**/*.md'
- 'tests/**'
- '!tests/**/*.md'
- '!docs/**'

# The token in secrets.CN1SS_GH_TOKEN was generated on
# Oct 16th 2025. If in Oct 2026 builds start failing, it
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/scripts-ios.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ on:
- '!vm/**/*.md'
- 'tests/**'
- '!tests/**/*.md'
- '!docs/**'
push:
branches: [ master ]
paths:
Expand All @@ -34,6 +35,7 @@ on:
- '!vm/**/*.md'
- 'tests/**'
- '!tests/**/*.md'
- '!docs/**'

jobs:
build-ios:
Expand Down
71 changes: 71 additions & 0 deletions docs/developer-guide/About-This-Guide.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
toc::[]

[preface]
== Preface

This developer guide is automatically generated from the wiki pages at https://github.com/codenameone/CodenameOne/wiki[https://github.com/codenameone/CodenameOne/wiki].

You can edit any page within the wiki pages using AsciiDoc. Your changes might make it (after review) into the official documentation available on the web here: https://www.codenameone.com/manual/ and available as a PDF file here: https://www.codenameone.com/files/developer-guide.pdf[https://www.codenameone.com/files/developer-guide.pdf].

Occasionally this book is updated to the print edition available here: https://www.amazon.com/dp/1549910035

We also recommend that you check out the full https://www.codenameone.com/javadoc/[JavaDoc] reference for Codename One which is very complete.

You can download the full Codename One source code from the https://github.com/codenameone/CodenameOne/[Codename One git repository] where you can also edit the JavaDocs and submit pull requests to https://www.codenameone.com/blog/how-to-use-the-codename-one-sources.html[include new features into Codename One].

<<<

**Authors**

This document includes content from multiple authors and community wiki edits. If you edit pages within the guide feel free to add your name here alphabetized by surname:

- https://github.com/codenameone/[Shai Almog]
- https://github.com/Isborg[Ismael Baum]
- https://twitter.com/ericcoolmandev[Eric Coolman]
- http://github.com/chen-fishbein/[Chen Fishbein]
- http://github.com/shannah/[Steve Hannah]
- https://github.com/kheops37[Matt]

<<<

**Rights & Licensing**

You may copy/redistribute/print this document without prior permission from Codename One. However, you may not charge for the document itself although charging for costs such as printing is permitted.

Notice that while you can print and reproduce sections arbitrarily such changes must explicitly and clearly state that this is a modified copy and link to the original source at https://www.codenameone.com/manual/ in a clear way!

<<<<

**Conventions**

This guide uses some notations to provide tips and further guidance.

In case of further information that breaks from the current tutorial
flow we use a sidebar as such:

.Sidebar
****
Dig deeper into some details that don't quite fit into the current flow. We use sidebars for things that are an important detour, you can skip them while reading but you might want to come back and read them later.
****

Here are common conventions for highlighting notes:

IMPORTANT: This is an important note

TIP: This is a helpful tip

NOTE: This is a general informational note, something interesting but not crucial

WARNING: This is a warning something we should pay attention to

#This# convention is used when we refer to a button or a widget to press in the UI. E.g. press the button labeled #Press Here#.

Quotes are presented as:
[quote,By Author]
____
This is a quote
____

*Bold* is used for light emphasis on a specific word or two within a sentence.

<<<<
Loading
Loading