annotate wiki/Original HELP page.md @ 865:cb386cccc7c5

When opening the logbook, or scrolling inside a logbook page, show 'Page' instead of 'Back' to make it clear that this is the way to page through the logbook pages. from mikeller
author heinrichsweikamp
date Mon, 22 Jul 2024 16:39:48 +0200
parents 5f11787b4f42
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
1 # Welcome
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
2
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
3 Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
4
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
5 ## Wiki features
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
6
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
7 This wiki uses the [Markdown](http://daringfireball.net/projects/markdown/) syntax. The [MarkDownDemo tutorial](https://bitbucket.org/tutorials/markdowndemo) shows how various elements are rendered. The [Bitbucket documentation](https://confluence.atlassian.com/x/FA4zDQ) has more information about using a wiki.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
8
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
9 The wiki itself is actually a mercurial repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
10
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
11 Go ahead and try:
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
12
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
13 ```
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
14 $ hg clone https://JeanDo@bitbucket.org/JeanDo/ostc4/wiki
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
15 ```
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
16
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
17 Wiki pages are normal files, with the .md extension. You can edit them locally, as well as creating new ones.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
18
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
19 ## Syntax highlighting
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
20
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
21
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
22 You can also highlight snippets of text (we use the excellent [Pygments][] library).
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
23
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
24 [Pygments]: http://pygments.org/
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
25
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
26
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
27 Here's an example of some Python code:
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
28
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
29 ```
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
30 #!python
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
31
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
32 def wiki_rocks(text):
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
33 formatter = lambda t: "funky"+t
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
34 return formatter(text)
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
35 ```
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
36
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
37
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
38 You can check out the source of this page to see how that's done, and make sure to bookmark [the vast library of Pygment lexers][lexers], we accept the 'short name' or the 'mimetype' of anything in there.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
39 [lexers]: http://pygments.org/docs/lexers/
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
40
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
41
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
42 Have fun!