Recent changes to FAQ

FAQ modified by Ingo

Ingo — Fri, 28 Sep 2018 19:12:28 -0000

--- v15
+++ v16
@@ -128,7 +128,17 @@

 ## Can I see the source code of foreign Wiki pages?
 When you are on a Wiki-Page, you should see a link named "Show Page Source". Click on it, and you can watch or copy the source of the Wiki-Page.
-# Moderation
+# Maintenance / Moderation
+## How can I delete a project
+Actually projects are always only marked as deleted. You can whipe the content manually by deleting all the tools, etc. But the project itself will be kept in the database as a sort of placeholder. So for example nobody can take the short name afterwards anymore.
+To do this:
+
+* Open the "Admin" page
+* Click on "Metadata"
+* Click on the "Edit-Link" beside "Project Status"
+* Select "Delete Project"
+
+If you wish to delete the project fully and permanently, please contact forge@codesys.com and name the project you want to be deleted. Note, that you need to be an admin of the project, and that you need to do the contact with an the E-Mail address of your CODESYS Account.
 ## Can I mark posts in my Forum as sticky?
 Yes. Just navigate to the post. Open it, and click on the "hand symbol" above it.
 This is your moderator menu. There you can mark it as sticky.

FAQ modified by codesys.com

codesys.com — Fri, 14 Sep 2018 12:53:58 -0000

--- v14
+++ v15
@@ -127,7 +127,7 @@
 ~~~

 ## Can I see the source code of foreign Wiki pages?
-When you are on a Wiki-Page, you should see a link named "Show page source". Click on it, and you can watch or copy the source of the Wiki-Page.
+When you are on a Wiki-Page, you should see a link named "Show Page Source". Click on it, and you can watch or copy the source of the Wiki-Page.
 # Moderation
 ## Can I mark posts in my Forum as sticky?
 Yes. Just navigate to the post. Open it, and click on the "hand symbol" above it.

FAQ modified by codesys.com

codesys.com — Fri, 14 Sep 2018 12:51:03 -0000

--- v13
+++ v14
@@ -94,6 +94,9 @@

 You can select "Options", and reenable it in the same way as you disabled it.

+## How can I browse pages after disabling the left navigation?
+One trick is to click on "history". Then you get the left navigation back.
+
 ## How can I navigate to a Wiki page without a link?
 This happens often when you use for example, the "IndexMain" page, how we recommended it in [Project Maintenance](/forge/wiki/Project Maintenance/#toc-index). As the page "IndexMain" is only included, but not linked anywhere.

@@ -123,6 +126,8 @@
 https://forge.codesys.com/proj/myproj/documentation/IndexMain
 ~~~

+## Can I see the source code of foreign Wiki pages?
+When you are on a Wiki-Page, you should see a link named "Show page source". Click on it, and you can watch or copy the source of the Wiki-Page.
 # Moderation
 ## Can I mark posts in my Forum as sticky?
 Yes. Just navigate to the post. Open it, and click on the "hand symbol" above it.
@@ -155,3 +160,21 @@
 You can't remove the last E-Mail address from an account. Ther needs to be always one verified E-Mail address for every active account. So, if you want to remove all E-Mail addresses from an account, you need to disable it.
 To do this, go to "Account -> Preferences", and select "Disable account".

+# Technical
+## Is there a programatical API to access CODESYS Forge?
+There is a REST API, which is provided by Allura. The easiest way is, to prepend "/rest/" to your URL.
+
+e.g.:
+
+* https://forge.codesys.com/forge/wiki/Home/
+* https://forge.codesys.com/rest/forge/wiki/Home/
+
+... gives you the pages source, some information about related artifacts, authors, ...
+
+Or if you want to process informations from a ticket system:
+
+* https://forge.codesys.com/forge/support/
+* https://forge.codesys.com/rest/forge/support/
+
+This works for most tools, and allows you to get some of the informations in json format.
+

FAQ modified by Ingo

Ingo — Thu, 07 Jun 2018 19:51:17 -0000

--- v12
+++ v13
@@ -66,7 +66,7 @@
 # Prerequisites
 ...
 # Prepare the hardware
-## Wirering of the sensors
+## Wiring of the sensors
 ...
 ## Attaching the peripherals
 ...

FAQ modified by Ingo

Ingo — Thu, 07 Jun 2018 19:46:07 -0000

--- v11
+++ v12
@@ -63,7 +63,7 @@
 ~~~
 [TOC]

-# Prerequisits
+# Prerequisites
 ...
 # Prepare the hardware
 ## Wirering of the sensors

FAQ modified by Ingo

Ingo — Wed, 09 May 2018 23:52:53 -0000

--- v10
+++ v11
@@ -149,7 +149,7 @@
 ## How can I share one Forge Account between different CODESYS Accounts?
 You can go to the [account profile](https://forge.codesys.com/u/ingo/) and claim a new E-Mail address. You will get an activation link sent to this E-Mail address which you need to visit. Once your address is approved, you can login, using a CODESYS Account which is registered to this address.

-Note, that each address can only be claimed once. Therefore thia procedure only works if there is no other account which claimed the address.
+Note, that each address can only be claimed once. Therefore this procedure only works if there is no other account which claimed the address, and when you respect the exact order (first claim the address, then login with the CODESYS Account for the first time).

 ## What can I do to disable an account and free the claimed E-Mail address?
 You can't remove the last E-Mail address from an account. Ther needs to be always one verified E-Mail address for every active account. So, if you want to remove all E-Mail addresses from an account, you need to disable it.

FAQ modified by Ingo

Ingo — Wed, 09 May 2018 23:47:47 -0000

--- v9
+++ v10
@@ -152,5 +152,6 @@
 Note, that each address can only be claimed once. Therefore thia procedure only works if there is no other account which claimed the address.

 ## What can I do to disable an account and free the claimed E-Mail address?
+You can't remove the last E-Mail address from an account. Ther needs to be always one verified E-Mail address for every active account. So, if you want to remove all E-Mail addresses from an account, you need to disable it.
+To do this, go to "Account -> Preferences", and select "Disable account".

-

FAQ modified by Ingo

Ingo — Tue, 08 May 2018 21:54:19 -0000

--- v8
+++ v9
@@ -128,7 +128,15 @@
 Yes. Just navigate to the post. Open it, and click on the "hand symbol" above it.
 This is your moderator menu. There you can mark it as sticky.

-## How to ban users?
+## How to ban forum users?
+To ban a user from your forum, you need to take him the right to post s.th. To do this, you have to follow:
+
+* Admin Forum
+* Permissions
+* Post
+* Block User
+
+Then you enter the username.

 # Community
 ## Can I send links to specific code lines?

FAQ modified by Ingo

Ingo — Tue, 08 May 2018 20:40:38 -0000

--- v7
+++ v8
@@ -138,3 +138,11 @@

 [https://forge.codesys.com/drv/io-drivers/code/HEAD/tree/trunk/I2C_Template.devdesc.xml#l21](https://forge.codesys.com/drv/io-drivers/code/HEAD/tree/trunk/I2C_Template.devdesc.xml#l21)

+## How can I share one Forge Account between different CODESYS Accounts?
+You can go to the [account profile](https://forge.codesys.com/u/ingo/) and claim a new E-Mail address. You will get an activation link sent to this E-Mail address which you need to visit. Once your address is approved, you can login, using a CODESYS Account which is registered to this address.
+
+Note, that each address can only be claimed once. Therefore thia procedure only works if there is no other account which claimed the address.
+
+## What can I do to disable an account and free the claimed E-Mail address?
+
+

FAQ modified by Ingo

Ingo — Thu, 03 May 2018 18:43:42 -0000

--- v6
+++ v7
@@ -33,6 +33,20 @@

 ~~~
 [[img src=attached-image.jpg alt=foobar]]
+~~~
+
+## How to resize embedded images?
+Embedded Images are usually embedded in their original size. When embedding photos, you usually want to make them as large as it fits good on the users device. The recommendation is to use an image size of 400px-600px and to embed it with a size, relative to the screen width. You can do this with the "img" markdown macro:
+
+~~~
+[[img src=attached-image.jpg width=50%]]
+~~~
+
+## How can an embedded image be displayed in a blog post
+Embedding images with the "img" macro (s. above) is very convenient. But it doesn't work if it is an image, at the beginning of a blog post, which should be displayed on the blog overview page. You can workaround this easily, by embedding it with their full URL:
+
+~~~
+[[img src=https://forge.codesys.com/prj/myprj/blog/2018/05/mypost/attachment/attached-image.jpg width=50%]]
 ~~~

 ## How to layout a good tutorial?