Last forum posts : Documentation http://oscada.org/forum/topics/documentation-1/ Documentation en Sun, 19 Apr 2026 17:30:51 +0300 mm_forum powered by TYPO3 60 The knowledge base moving to a new Wiki engine http://oscada.org/forum/posts///8972/ Mon, 18 Sep 2017 11:10:16 +0300 Wiki-pages in processing and their current state and progress for: moving to the new wiki, presenting (revision, translation to the generic languages, creation): Home: OK, OK About: OK, OK About/Related_projects: WAIT, WAIT Functions_and_demands: OK, OK Documents: OK, OK Documents/0.8.0: OK, OK Documents/*: WAIT, WAIT Documents/Terms: OK, OK Documents/FAQ: OK, OK Documents/Quick_start: OK, WAIT Documents/Program_manual: OK, OK Documents/DAQ: OK, WAIT Documents/User API (from the Program manual end): OK, OK Documents/Operator_manual: WAIT, WAIT Documents/API: OK, WAIT Documents/Program_donors: WAIT, WAIT Documents/Build_from_source: OK, OK Documents/Create_module: OK, WAIT Documents/Crash_report: OK, WAIT Works: OK, OK Works/Developers: WAIT, WAIT Works/Road_map: OK, OK Works/To_do: OK, OK Fund: OK, OK Works/Technical support: -, WAIT Works/Tests: WAIT, WAIT Works/Tests/*: WAIT, WAIT Works/Errors: WAIT, WAIT Using: OK, OK Libs: -, OK Libs/User_protocol_devices: OK, OK Sub-projects: OK, OK Sub-projects/Adaption_to_Android: OK, OK Sub-projects/Automation_Linux_distributive: LINK, WAIT Sub-projects/Embedding_and_PLC: OK, OK Sub-projects/*: LINK, WAIT Modules: OK, OK Modules/SQLite: OK, WAIT Modules/MySQL: OK, WAIT Modules/PostgreSQL: OK, WAIT Modules/FireBird: OK, WAIT Modules/DBF: OK, WAIT Modules/ODBC: -, WAIT Modules/LDAP: OK, WAIT Modules/Sockets: OK, WAIT Modules/Serial: OK, WAIT Modules/SSL: OK, WAIT Modules/SelfSystem: OK, WAIT Modules/UserProtocol: OK, WAIT Modules/HTTP: OK, WAIT Modules/JavaLikeCalc: OK, WAIT Modules/LogicLev: OK, WAIT Modules/BlockCalc: OK, WAIT Modules/DAQGate: OK, WAIT Modules/System: OK, WAIT Modules/ModBus: OK, WAIT Modules/DCON: OK, WAIT Modules/OPC_UA: OK, WAIT Modules/MMS: -, WAIT Modules/SNMP: OK, OK Modules/ICP_DAS: OK, WAIT Modules/Siemens: OK, WAIT Modules/DiamondBoards: OK, WAIT Modules/Comedi: OK, WAIT Modules/SoundCard: OK, OK Modules/BFN: OK, WAIT Modules/SMH2Gi: OK, WAIT Modules/AMRDevs: WAIT, WAIT Modules/Fastwel: WAIT, WAIT Modules/FT3: WAIT, WAIT Modules/(BCM2835->GPIO): OK, WAIT Modules/FSArch: OK, WAIT Modules/DBArch: OK, WAIT Modules/VCAEngine: OK, WAIT Modules/QTStarter: OK, OK Modules/QTCfg: OK, WAIT Modules/VCAEngine: OK, WAIT Modules/WebCfgD: OK, WAIT Modules/WebCfg: OK, WAIT Modules/WebVision: OK, WAIT Modules/WebUser: OK, WAIT Modules/FLibSYS: OK, WAIT Modules/SystemTests: OK, WAIT Modules/FLibMath: OK, WAIT Modules/FLibComplex1: OK, WAIT moving to the new wiki, presenting (revision, translation to the generic languages, creation):
Home: OK, OK
About: OK, OK
About/Related_projects: WAIT, WAIT
Functions_and_demands: OK, OK
Documents: OK, OK
Documents/[Releases/]0.8.0: OK, OK
Documents/[Releases/]*: WAIT, WAIT
Documents/Terms: OK, OK
Documents/FAQ: OK, OK
Documents/Quick_start: OK, WAIT
Documents/Program_manual: OK, OK
Documents/DAQ: OK, WAIT
Documents/User API (from the Program manual end): OK, OK
Documents/Operator_manual: WAIT, WAIT
Documents/API: OK, WAIT
Documents/Program_donors: WAIT, WAIT
Documents/Build_from_source: OK, OK
Documents/Create_module: OK, WAIT
Documents/Crash_report: OK, WAIT
Works: OK, OK
Works/Developers: WAIT, WAIT
Works/Road_map: OK, OK
Works/To_do: OK, OK
[Works/]Fund: OK, OK
Works/Technical support: -, WAIT
Works/Tests: WAIT, WAIT
Works/Tests/*: WAIT, WAIT
Works/Errors: WAIT, WAIT
Using: OK, OK
Libs: -, OK
Libs/User_protocol_devices: OK, OK
Sub-projects: OK, OK
Sub-projects/Adaption_to_Android: OK, OK
Sub-projects/Automation_Linux_distributive: LINK, WAIT
Sub-projects/Embedding_and_PLC: OK, OK
Sub-projects/*: LINK, WAIT
Modules: OK, OK
Modules/SQLite: OK, WAIT
Modules/MySQL: OK, WAIT
Modules/PostgreSQL: OK, WAIT
Modules/FireBird: OK, WAIT
Modules/DBF: OK, WAIT
Modules/ODBC: -, WAIT
Modules/LDAP: OK, WAIT
Modules/Sockets: OK, WAIT
Modules/Serial: OK, WAIT
Modules/SSL: OK, WAIT
Modules/SelfSystem: OK, WAIT
Modules/UserProtocol: OK, WAIT
Modules/HTTP: OK, WAIT
Modules/JavaLikeCalc: OK, WAIT
Modules/LogicLev: OK, WAIT
Modules/BlockCalc: OK, WAIT
Modules/DAQGate: OK, WAIT
Modules/System: OK, WAIT
Modules/ModBus: OK, WAIT
Modules/DCON: OK, WAIT
Modules/OPC_UA: OK, WAIT
Modules/MMS: -, WAIT
Modules/SNMP: OK, OK
Modules/ICP_DAS: OK, WAIT
Modules/Siemens: OK, WAIT
Modules/DiamondBoards: OK, WAIT
Modules/Comedi: OK, WAIT
Modules/SoundCard: OK, OK
Modules/BFN: OK, WAIT
Modules/SMH2Gi: OK, WAIT
Modules/AMRDevs: WAIT, WAIT
Modules/Fastwel: WAIT, WAIT
Modules/FT3: WAIT, WAIT
Modules/(BCM2835->GPIO): OK, WAIT
Modules/FSArch: OK, WAIT
Modules/DBArch: OK, WAIT
Modules/VCAEngine: OK, WAIT
Modules/QTStarter: OK, OK
Modules/QTCfg: OK, WAIT
Modules/VCAEngine: OK, WAIT
Modules/WebCfgD: OK, WAIT
Modules/WebCfg: OK, WAIT
Modules/WebVision: OK, WAIT
Modules/WebUser: OK, WAIT
Modules/FLibSYS: OK, WAIT
Modules/SystemTests: OK, WAIT
Modules/FLibMath: OK, WAIT
Modules/FLibComplex1: OK, WAIT ]]> Documentation roman The knowledge base moving to a new Wiki engine http://oscada.org/forum/posts///8916/ Tue, 01 Aug 2017 21:11:11 +0300 Base: Road map Funding: nope Begin: 21.12.2015 Priority: high Complexity: high and long term State: The same moving are mostly done. During using: migration, updating, appending and translation. Participants: Roman Savochenko (common work) Objective Actual knowledge base (on WackoWiki) moving to a new Wiki engine on MediaWiki but the previous Wiki mostly deprecated and has more limitations and inconveniences and it is a condition of OpenSCADA 0.9 LTS releasing. Estimation : 10* compatibility or simplicity for the original Wiki content migration — a procedure "wacko2media" into OpenSCADA was created to simplify the migration for most syntax specific; 9* multilanguage from box; 8* UTF-8; 9* big page's content; 9* subpages including; 5* correct searching; 4* correct the syntax highlight for source texts; 4* provides template/skeleton pages for include as IFRAME into TYPO3, test on FAQ and also for OpenSCADA. 4* easy for print-ready documentation generation from Wiki, see to different tools: export through LaTEX, asciidoc, pandoc, DocBook; Summary: 21.12.2015 MediaWiki test deploy 20.07.2017 MediaWiki final configuration and preparing to migration 30.07.2017 A new clean structure of the Wiki creation 01.09.2017 Main pages migration, updating, appending and translation for: Home, About, Work, Work/Road map, Functions and demands, Using 01.08.2017 Cross-linking between old and new Wikis. Switching to the new Wiki on the main site. 01.08.2017 Try and work-out of using articles of the Wiki on the main site. 09.09.2017 WackoWiki Converter work-out for simplify the migration — the converter uses "pandoc" (1.12.4.2) which mostly broken for tables, html2wiki also has more lacks, then there was written a procedure "wacko2media" into OpenSCADA to do this migration directly from WackoSource. (*) Core documents migration, updating, appending and translation. 04.11.2017 A procedure creation for user accounts of the main-site (TYPO3) sync to the new Wiki. 20.10.2017 Switch OpenSCADA to the online documentation on the new Wiki. 03.11.2017 A script creation for prepare the offline documentation from the new Wiki — the script "docOffLine" into OpenSCADA directly created for the function. (-) Moving to different VPS with newer PHP and the environment in whole. Problems with the Wiki-engine MediaWiki: 25.10.2017 Moving to a different VPS is mostly successful but the redirection from "http://oscada.org/wiki" to "http://192.168.0.14/wiki" has problems but the HTTP server Apache2 changes the filed "Host: " of the HTTP header to 192.168.0.14. 24.10.2017 Big articles (> 65536) translation impossibility but the row "job_params" of the table "job" has type "BLOB" which limited in 2^16. The report here. Base: Road map
Funding: nope
Begin: 21.12.2015
Priority: high
Complexity: high and long term
State: The same moving are mostly done. During using: migration, updating, appending and translation.
Participants: Roman Savochenko (common work)
Objective Actual knowledge base (on WackoWiki) moving to a new Wiki engine on MediaWiki but the previous Wiki mostly deprecated and has more limitations and inconveniences and it is a condition of OpenSCADA 0.9 LTS releasing.

Estimation [Wacko,Media]:
10*[10,5] compatibility or simplicity for the original Wiki content migration — a procedure "wacko2media" into OpenSCADA was created to simplify the migration for most syntax specific;
9*[0,10] multilanguage from box;
8*[0,10] UTF-8;
9*[8,10] big page's content;
9*[8,10] subpages including;
5*[3,5] correct searching;
4*[2,5] correct the syntax highlight for source texts;
4*[2,10] provides template/skeleton pages for include as IFRAME into TYPO3, test on FAQ and also for OpenSCADA.
4*[3,7] easy for print-ready documentation generation from Wiki, see to different tools: export through LaTEX, asciidoc, pandoc, DocBook;
Summary: [287,513]

21.12.2015 MediaWiki test deploy
20.07.2017 MediaWiki final configuration and preparing to migration
30.07.2017 A new clean structure of the Wiki creation
01.09.2017 Main pages migration, updating, appending and translation for: Home, About, Work, Work/Road map, Functions and demands, Using
01.08.2017 Cross-linking between old and new Wikis. Switching to the new Wiki on the main site.
01.08.2017 Try and work-out of using articles of the Wiki on the main site.
09.09.2017 WackoWiki Converter work-out for simplify the migration — the converter uses "pandoc" (1.12.4.2) which mostly broken for tables, html2wiki also has more lacks, then there was written a procedure "wacko2media" into OpenSCADA to do this migration directly from WackoSource.
(*) Core documents migration, updating, appending and translation.
04.11.2017 A procedure creation for user accounts of the main-site (TYPO3) sync to the new Wiki.
20.10.2017 Switch OpenSCADA to the online documentation on the new Wiki.
03.11.2017 A script creation for prepare the offline documentation from the new Wiki — the script "docOffLine" into OpenSCADA directly created for the function.
(-) Moving to different VPS with newer PHP and the environment in whole.

Problems with the Wiki-engine MediaWiki:
25.10.2017 Moving to a different VPS is mostly successful but the redirection from "http://oscada.org/wiki" to "http://192.168.0.14/wiki" has problems but the HTTP server Apache2 changes the filed "Host: " of the HTTP header to 192.168.0.14.
24.10.2017 Big articles (> 65536) translation impossibility but the row "job_params" of the table "job" has type "BLOB" which limited in 2^16. The report here. ]]> Documentation roman Generalizing of helping mechanism http://oscada.org/forum/posts///2423/ Sat, 20 Nov 2010 19:35:51 +0200 Base: Initiative Component: The control interface OpenSCADA and all its visualizers. Funding: nope Begin: Priority: low State: Mostly done (+) Help pages structure preparation according to attribute "help" from information part of the control interface. (+) Implementation for calls and context-help representing into the configurator UI.QTCfg. (+) Implementation for calls and context-help representing into visualizer UI.Vision. (+) Information elements of OpenSCADA control interface pages filling to context help content. (+) Implementation for calls and context-help representing into configurator UI.WebCfgD. Base: Initiative
Component: The control interface OpenSCADA and all its visualizers.
Funding: nope
Begin:
Priority: low
State: Mostly done

(+) Help pages structure preparation according to attribute "help" from information part of the control interface.
(+) Implementation for calls and context-help representing into the configurator UI.QTCfg.
(+) Implementation for calls and context-help representing into visualizer UI.Vision.
(+) Information elements of OpenSCADA control interface pages filling to context help content.
(+) Implementation for calls and context-help representing into configurator UI.WebCfgD. ]]> Documentation roman