How do I format my forum post?


(Arjan) #1

The TTN forum is using Discourse, which supports several ways to format your post:

  • Markdown
  • BBCode
  • HTML
  • Any combination of the above

Quite often you’ll need an empty line above specific formatting to make it work. You’ll also have to type blank lines to create proper paragraphs; just pressing Return once and then typing a new block of text right below a previous block only creates a so-called line break, which might be harder to read.

Leaving one blank line between two blocks of texts nicely creates a new paragraph with some whitespace, which looks great on both mobile and in a regular desktop browser.

Toolbar

The toolbar above the editor’s input helps create mostly Markdown posts:

  • To apply formatting to parts of your post, first select the text you want to format and then click one of the toolbar buttons.

  • See the button’s tooltip for some hints. From left to right: quote post you’re replying to, bold, emphasis (italic), hyperlink, blockquote, preformatted text, upload an image or file, bulleted list, numbered list, heading, horizontal rule, emoij, other options (such as hidden details).

Code and logs

There are many options to format your code or logs:

  • “Fenced code blocks”: type 3 backticks above and below your text, optionally followed by a specification of the language for syntax highlighting, like ```cpp for C++, and likewise javascript, json and sql:

    Here is my code:
    
    ```cpp
    #define LMIC_DEBUG_LEVEL 0
    #include <avr/sleep.h>
    #ifdef PROGMEM
    // On AVR, these values are stored in flash and only copied to RAM
    int a = 0;
    ```
    

    …yielding highlighted C++ code:

    Here is my code:

    #define LMIC_DEBUG_LEVEL 0
    #include <avr/sleep.h>
    #ifdef PROGMEM
    // On AVR, these values are stored in flash and only copied to RAM
    int a = 0;
    
  • …or, as highlighting might be wrong, use ```text to suppress any highlighting:

    ```text
    ## some log output
    ## here
    ```
    
  • Or, also without any highlighting: indent the code with 4 spaces (or select your code and use the toolbar </> button to make the editor indent the selected code for you):

    Here is my code:
    
        #define LMIC_DEBUG_LEVEL 0
        #include <avr/sleep.h>
        #ifdef PROGMEM
        // On AVR, these values are stored in flash and only copied to RAM
        int a = 0;
    
  • Or: use BBCode [code] above your code or logs, and [/code] below it.

  • If you have many details, you can collapse them to avoid a very long post:

    [details=Click to see the full logs]
    ```text
    This text will be hidden,
    until clicked
    ```
    [/details]
    

    …which will get you:

    Click to see the full logs
    This text will be hidden,
    until clicked
    

Markdown

See http://commonmark.org/help/ for a nice overview. It’s really easy; just a few of its options:

Just type, **use plenty of whitespace** and [link your sources](https:/thethingsnetwork.org)!

- An unordered list.
- Item B.    

Or:

1. An ordered list
    1. Nested item
    2. Nested item

2. Item 2.
    - Nested unordered list

3. Item 3.

    Nested paragraph.

    > Nested quote.

        Nested code

> A quote
>
>     with nested code

Images have a Discourse-specific option to scale down the preview size: add a percentage such as ,10% after the image size that is already added when uploading an image:

![TTN logo|649x500,10%](upload://svFg8QtnafrQD36BNhWCepOMnzG.png)

…to get a small image that is still clickable for the full version:

TTN logo

HTML

Only some limited tags are supported; other HTML will be invisible, so use code to see that. Like type `<include ...>` to see <include ...>.

BBCode

[b]strong[/b]
[i]emphasis[/i]
[u]underlined[/u]
[s]strikethrough[/s]
[ul][li]option one[/li][/ul]
[quote="eviltrout"]They said...[/quote]
[quote="eviltrout, post:1, topic:2"]They said...[/quote]
[img]http://eviltrout.com/eviltrout.png[/img]
[url]http://bettercallsaul.com[/url]
[email]eviltrout@mailinator.com[/email]
[code]\nx++\n[/code]

Getting high current in low power mode
Connecting IMST LiteGateway ? Stuck
Gateway status not connected, no data visible
The Things Uno does not work unless serial monitor is open
Big ESP32 + SX127x topic part 2
Device not activated Lora feather 32u4 RFM9X
Ttn - json -python (paho-mqtt)
Ttgo T-beam
Whisper Node and RFM95 DIOs
Can't get the Device EUI out of TTN Node
Sandbox LoRaGo PORT gateway on TTN
DRAGINO problems and solutions topic
LoraWan Pager project
Node Fails after sending ~200 Messages
Dual-Chan Gateway with Raspberry PI3 + Dragino Hat v1.4 and Downstream messages
[solved] LoRa32u4 II joins only sometimes
[solved] Raspi3+Ic88a gateway not connected on TTN
RHF76-052 and decrypting payloads
The LIBRARY basement part 5
Is there any "increase antenna gain" on arduino LMIC sketch?
Over-the-air-activation OTAA with LMIC
Package forwarding
Altitude of node/device incorrect
P2P RN2903/RN2483 Arduino
Single Channel Gateway part 3
Issues with New Pi-based LoRa Gateway using Linklabs Shield
Has anyone experience with Sensing Labs devices?
433 MHz band support and alternatives
Uplink message is saved as "[object Object]" in Node.js
BSFrance Lora32u4 stuck in sleep mode
Helltec board on AUS915
Has anyone tried sending GPS coords to TTN?
Got Adafruit Feather 32u4 LoRa Radio to work and here is how
BIG ESP32 / SX127x topic part 1
BME280 with TTN & CayenneLPP Library not working
Doing my first attempts to connect - failed
DRAGINO problems and solutions topic
Reliable packer forwarder release for AEP Conduit?
Simulated confirmed downlinks no longer getting to the gateway
The LIBRARY basement part 2
Lights on/Off TTN Node Code
Payload[Not provided] in application data
Payload[Not provided] in application data
Help with Dragino Outdoor gateway
Payload Decoder