Difference between revisions of "ProfiWiki"

From BITPlan Wiki
Jump to navigation Jump to search
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Language|master page=ProfiWiki|language=en}}
 
{{Language|master page=ProfiWiki|language=en}}
−
[[File:Profiwikiicon.png|128px]]{{Link|target=http://www.profiwiki.de|title=Profiwiki}} is a product that increases the benefit you
+
{{Backlink|target=Products}}{{Eyecatcher|picture=Profiwikiicon.png}}
 +
= What is the BITPlan ProfiWiki? =
 +
ProfiWiki may be used as a
 +
* ContentMangementSystem (CMS)
 +
* DocumentManagemtSystem (DMS)
 +
that is based on [https://www.mediawiki.org/wiki/MediaWiki MediaWiki] and [https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic MediaWiki].
 +
 
 +
A BITPlan ProfiWiki is a standard MediaWiki which is extended with Semantic MediaWiki and other extensions.
 +
The result is a combination of a Wiki and a Graph database system.
 +
Useful functions like a UML documentation, comfortable upload by drag&drop and PDF export are already integrated.
 +
 
 +
To make the approach useable the BITPlan ProfiWiki system uses a predefined {{Link|target=MetaModel}}
 +
 
 +
The database structure can be modified directly in the Wiki. MetaModel, Model and generated pages are handled in the same way.
 +
In principle a ProfiWiki works like a small "integrated development environment".
 +
 
 +
The utility of the Wiki lies in the collaboration possibilities. It is possibble to combine unstructured. spontaneous content with structure contend based on Forms Lists and Categories. This way users on different levels can be addressed. Those that want to use all details as well as users
 +
that do just want to occasionaly use the wiki without reading any manuels and just want to "click from page to page" and add data with predefined forms.
 +
 
 +
BITPlan ProfiWiki is a product that increases the benefit you
 
get from Semantic Media Wiki and simplifies the structuring of your wiki.
 
get from Semantic Media Wiki and simplifies the structuring of your wiki.
  
−
Profiwiki consists of:
+
BITPlan Profiwiki consists of:
 
* a set of predefined templates, pages and media files  
 
* a set of predefined templates, pages and media files  
−
* an extension that allows to use Java Code and libraries
 
−
* a {{Link|target=Rythm}} template engine based configurable page generator
 
 
* applying the {{Link|target=Y-Prinzip|title=Y-Principle}} to the structuring and use of Semantic MediaWiki
 
* applying the {{Link|target=Y-Prinzip|title=Y-Principle}} to the structuring and use of Semantic MediaWiki
−
{{OsProject|storemode=property
+
 
 +
= Open Source Project =
 +
 
 +
{{OsProject
 
|id=ProfiWiki
 
|id=ProfiWiki
 +
|state=active
 
|owner=BITPlan
 
|owner=BITPlan
−
|title=Professional Semantic Media Wiki
+
|title=BITPlan Professional Semantic Media Wiki
 
|url=https://github.com/BITPlan/ProfiWiki
 
|url=https://github.com/BITPlan/ProfiWiki
−
|version=0.0.1
+
|version=0.2.1
−
|date=2018-12-31
+
|description=Y-Principle driven Semantic MediaWiki
 +
|date=2024-10-24
 +
|since=2015-05-06
 +
|storemode=property
 
}}
 
}}
  
 +
= Why ProfiWiki? =
 +
<div style="font-size:24px;color:#FF8000">
 +
Professional Wiki for your Enterprise
 +
</div>
 +
<div class="bitplanorange">
 +
ProfiWiki is based on [[File:MediaWikiLogo.png|100px|link=http://www.mediawiki.org]]
 +
</div>
 +
== Why use the original MediaWiki? ==
 +
* there are some 2.500 {{Link|target=https://www.mediawiki.org/wiki/Category:All_extensions|title=Extensions}} available
 +
* there are many different skins available
 +
* it is free (as in free beer)
 +
* it is free (as in OpenSource)
 +
* the WikiMedia Foundation keeps maintaining it as the infrastucture for {{Link|target=http://www.wikipedia.org|title=WikiPedia}}
 +
== An Example: Seeing is believing ... ==
 +
<youtube>U1zBJO_aIvc</youtube>
 +
 +
 +
<div class="bitplanorange">
 +
ProfiWiki is based on [[File:SemanticMediaWikiLogo.png|100px|link=http://www.semantic-mediawiki.org]]
 +
</div>
 +
<youtube>OM6XIICm_qo</youtube>
 +
 +
[[Category:frontend]]
 
= Installation =
 
= Installation =
 +
 +
 +
= Usage =
 +
== command line ==
 
<source lang='bash'>
 
<source lang='bash'>
−
git clone https://github.com/BITPlan/ProfiWiki
+
profwiki -h
−
cd ProfiWiki
+
zsh: command not found: profwiki
−
</source>
+
wf@fixit ProfiWiki % profiwiki -h
−
choose your target Mediawiki version e.g. 1.31.1 and call the corresponding install script:
+
usage: profiwiki [-h] [-cn CONTAINER_NAME] [-d] [-el [EXTENSIONNAMELIST ...]]
−
<source lang='bash'>
+
                [-ej EXTENSIONJSONFILE] [-f] [-fu] [--host HOST]
−
./mw1_31_1
+
                [-dp DOCKER_PATH] [--logo LOGO] [-mv MARIADBVERSION]
 +
                [--mysqlPassword MYSQLPASSWORD] [-rp] [-p PASSWORD]
 +
                [-pl PASSWORD_LENGTH] [--prefix PREFIX] [--prot PROT]
 +
                [--script_path SCRIPT_PATH] [--url URL] [-sp SQL_PORT]
 +
                [-smw SMW_VERSION] [-u USER] [-q] [-bp BASE_PORT]
 +
                [-vl [VERSIONS ...]] [--about] [--apache] [--all] [--bash]
 +
                [--create] [--check] [--update] [--cron] [--down] [--patch]
 +
                [--list] [-fa] [-wuc] [-pu] [-i] [-V]
 +
                [--debugServer DEBUGSERVER] [--debugPort DEBUGPORT]
 +
                [--debugPathMapping DEBUGPATHMAPPING [DEBUGPATHMAPPING ...]]
 +
 
 +
Copyright 2015-2024 contributors. All rights reserved.
 +
  Licensed under the Apache License 2.0
 +
  http://www.apache.org/licenses/LICENSE-2.0
 +
  Distributed on an "AS IS" basis without warranties
 +
  or conditions of any kind, either express or implied.
 +
 
 +
options:
 +
  -h, --help            show this help message and exit
 +
  -cn CONTAINER_NAME, --container_name CONTAINER_NAME
 +
                        set container name (only valid and recommended for
 +
                        single version call)
 +
  -d, --debug          enable debug mode [default: False]
 +
  -el [EXTENSIONNAMELIST ...], --extensionList [EXTENSIONNAMELIST ...]
 +
                        list of extensions to be installed [default: ['Admin
 +
                        Links', 'Diagrams', 'Graph', 'Header Tabs',
 +
                        'ImageMap', 'ImageLink', 'MagicNoCache', 'Maps9',
 +
                        'Mermaid', 'MsUpload', 'Nuke', 'Page Forms',
 +
                        'ParserFunctions', 'PDFEmbed', 'Renameuser', 'Replace
 +
                        Text', 'Semantic Result Formats', 'SyntaxHighlight',
 +
                        'Variables', 'UserFunctions', 'YouTube']]
 +
  -ej EXTENSIONJSONFILE, --extensionJson EXTENSIONJSONFILE
 +
                        additional extension descriptions default: [default:
 +
                        None]
 +
  -f, --forceRebuild    force rebuilding [default: False]
 +
  -fu, --force_user    force overwrite of wikiuser
 +
  --host HOST          the host to serve / listen from [default:
 +
                        fixit.bitplan.com]
 +
  -dp DOCKER_PATH, --docker_path DOCKER_PATH
 +
                        the base directory to store docker and jinja template
 +
                        files [default: /Users/wf/.pymediawikidocker]
 +
  --logo LOGO          set Logo [default: https://wiki.bitplan.com/images/wik
 +
                        i/thumb/6/63/Profiwikiicon.png/96px-Profiwikiicon.png]
 +
  -mv MARIADBVERSION, --mariaDBVersion MARIADBVERSION
 +
                        mariaDB Version to be installed [default: 10.11]
 +
  --mysqlPassword MYSQLPASSWORD
 +
                        set sqlRootPassword [default: None] - random password
 +
                        if None
 +
  -rp, --random_password
 +
                        create random password and create wikiuser while at it
 +
  -p PASSWORD, --password PASSWORD
 +
                        set password for initial user [default: sysop-1234!]
 +
  -pl PASSWORD_LENGTH, --password_length PASSWORD_LENGTH
 +
                        set the password length for random passwords[default:
 +
                        15]
 +
  --prefix PREFIX      the container name prefix to use [default: pw]
 +
  --prot PROT          change to https in case [default: http]
 +
  --script_path SCRIPT_PATH
 +
                        change to any script_path you might need to set
 +
                        [default: ]
 +
  --url URL            will set prot host,script_path, and optionally port
 +
                        based on the url given [default: None]
 +
  -sp SQL_PORT, --sql_base_port SQL_PORT
 +
                        set base mySql port 3306 to be exposed - incrementing
 +
                        by one for each version [default: 9078]
 +
  -smw SMW_VERSION, --smw_version SMW_VERSION
 +
                        set SemanticMediaWiki Version to be installed default
 +
                        is None - no installation of SMW
 +
  -u USER, --user USER  set username of initial user with sysop rights
 +
                        [default: Sysop]
 +
  -q, --quiet          not verbose [default: False]
 +
  -bp BASE_PORT, --base_port BASE_PORT
 +
                        set how base html port 80 to be exposed - incrementing
 +
                        by one for each version [default: 9079]
 +
  -vl [VERSIONS ...], --version_list [VERSIONS ...]
 +
                        mediawiki versions to create docker applications for
 +
                        [default: ['1.39.8']]
 +
  --about              show about info [default: False]
 +
  --apache              generate apache configuration
 +
  --all                do all necessary steps for a full setup
 +
  --bash                bash into container
 +
  --create              create the wiki
 +
  --check              check the wiki
 +
  --update              start the update script -e.g. to fix SMW key
 +
  --cron                start cron service
 +
  --down                shutdown the wiki [default: False]
 +
  --patch              apply LocalSettings.php patches [default: False]
 +
  --list                list the available profi wikis [default: False]
 +
  -fa, --fontawesome    install fontawesome
 +
  -wuc, --wikiuser_check
 +
                        check wikiuser
 +
  -pu, --plantuml      install plantuml
 +
  -i, --info            show system info
 +
  -V, --version        show program's version number and exit
 +
  --debugServer DEBUGSERVER
 +
                        remote debug Server
 +
  --debugPort DEBUGPORT
 +
                        remote debug Port
 +
  --debugPathMapping DEBUGPATHMAPPING [DEBUGPATHMAPPING ...]
 +
                        remote debug Server path mapping - needs two arguments
 +
                        1st: remotePath 2nd: local Path
 
</source>
 
</source>

Latest revision as of 06:27, 24 October 2024

This page in other languages: de

ProfiWiki en

Nav left blue.svg

Profiwikiicon.png

What is the BITPlan ProfiWiki?

ProfiWiki may be used as a

  • ContentMangementSystem (CMS)
  • DocumentManagemtSystem (DMS)

that is based on MediaWiki and Semantic MediaWiki.

A BITPlan ProfiWiki is a standard MediaWiki which is extended with Semantic MediaWiki and other extensions. The result is a combination of a Wiki and a Graph database system. Useful functions like a UML documentation, comfortable upload by drag&drop and PDF export are already integrated.

To make the approach useable the BITPlan ProfiWiki system uses a predefined MetaModel

The database structure can be modified directly in the Wiki. MetaModel, Model and generated pages are handled in the same way. In principle a ProfiWiki works like a small "integrated development environment".

The utility of the Wiki lies in the collaboration possibilities. It is possibble to combine unstructured. spontaneous content with structure contend based on Forms Lists and Categories. This way users on different levels can be addressed. Those that want to use all details as well as users that do just want to occasionaly use the wiki without reading any manuels and just want to "click from page to page" and add data with predefined forms.

BITPlan ProfiWiki is a product that increases the benefit you get from Semantic Media Wiki and simplifies the structuring of your wiki.

BITPlan Profiwiki consists of:

  • a set of predefined templates, pages and media files
  • applying the Y-Principle to the structuring and use of Semantic MediaWiki

Open Source Project

OsProject
edit
id  ProfiWiki
state  active
owner  BITPlan
title  BITPlan Professional Semantic Media Wiki
url  https://github.com/BITPlan/ProfiWiki
version  0.2.1
description  Y-Principle driven Semantic MediaWiki
date  2024-10-24
since  2015-05-06
until  

Why ProfiWiki?

Professional Wiki for your Enterprise

ProfiWiki is based on MediaWikiLogo.png

Why use the original MediaWiki?

  • there are some 2.500 Extensions available
  • there are many different skins available
  • it is free (as in free beer)
  • it is free (as in OpenSource)
  • the WikiMedia Foundation keeps maintaining it as the infrastucture for WikiPedia

An Example: Seeing is believing ...


ProfiWiki is based on SemanticMediaWikiLogo.png

Installation

Usage

command line

profwiki -h
zsh: command not found: profwiki
wf@fixit ProfiWiki % profiwiki -h
usage: profiwiki [-h] [-cn CONTAINER_NAME] [-d] [-el [EXTENSIONNAMELIST ...]]
                 [-ej EXTENSIONJSONFILE] [-f] [-fu] [--host HOST]
                 [-dp DOCKER_PATH] [--logo LOGO] [-mv MARIADBVERSION]
                 [--mysqlPassword MYSQLPASSWORD] [-rp] [-p PASSWORD]
                 [-pl PASSWORD_LENGTH] [--prefix PREFIX] [--prot PROT]
                 [--script_path SCRIPT_PATH] [--url URL] [-sp SQL_PORT]
                 [-smw SMW_VERSION] [-u USER] [-q] [-bp BASE_PORT]
                 [-vl [VERSIONS ...]] [--about] [--apache] [--all] [--bash]
                 [--create] [--check] [--update] [--cron] [--down] [--patch]
                 [--list] [-fa] [-wuc] [-pu] [-i] [-V]
                 [--debugServer DEBUGSERVER] [--debugPort DEBUGPORT]
                 [--debugPathMapping DEBUGPATHMAPPING [DEBUGPATHMAPPING ...]]

Copyright 2015-2024 contributors. All rights reserved.
  Licensed under the Apache License 2.0
  http://www.apache.org/licenses/LICENSE-2.0
  Distributed on an "AS IS" basis without warranties
  or conditions of any kind, either express or implied.

options:
  -h, --help            show this help message and exit
  -cn CONTAINER_NAME, --container_name CONTAINER_NAME
                        set container name (only valid and recommended for
                        single version call)
  -d, --debug           enable debug mode [default: False]
  -el [EXTENSIONNAMELIST ...], --extensionList [EXTENSIONNAMELIST ...]
                        list of extensions to be installed [default: ['Admin
                        Links', 'Diagrams', 'Graph', 'Header Tabs',
                        'ImageMap', 'ImageLink', 'MagicNoCache', 'Maps9',
                        'Mermaid', 'MsUpload', 'Nuke', 'Page Forms',
                        'ParserFunctions', 'PDFEmbed', 'Renameuser', 'Replace
                        Text', 'Semantic Result Formats', 'SyntaxHighlight',
                        'Variables', 'UserFunctions', 'YouTube']]
  -ej EXTENSIONJSONFILE, --extensionJson EXTENSIONJSONFILE
                        additional extension descriptions default: [default:
                        None]
  -f, --forceRebuild    force rebuilding [default: False]
  -fu, --force_user     force overwrite of wikiuser
  --host HOST           the host to serve / listen from [default:
                        fixit.bitplan.com]
  -dp DOCKER_PATH, --docker_path DOCKER_PATH
                        the base directory to store docker and jinja template
                        files [default: /Users/wf/.pymediawikidocker]
  --logo LOGO           set Logo [default: https://wiki.bitplan.com/images/wik
                        i/thumb/6/63/Profiwikiicon.png/96px-Profiwikiicon.png]
  -mv MARIADBVERSION, --mariaDBVersion MARIADBVERSION
                        mariaDB Version to be installed [default: 10.11]
  --mysqlPassword MYSQLPASSWORD
                        set sqlRootPassword [default: None] - random password
                        if None
  -rp, --random_password
                        create random password and create wikiuser while at it
  -p PASSWORD, --password PASSWORD
                        set password for initial user [default: sysop-1234!]
  -pl PASSWORD_LENGTH, --password_length PASSWORD_LENGTH
                        set the password length for random passwords[default:
                        15]
  --prefix PREFIX       the container name prefix to use [default: pw]
  --prot PROT           change to https in case [default: http]
  --script_path SCRIPT_PATH
                        change to any script_path you might need to set
                        [default: ]
  --url URL             will set prot host,script_path, and optionally port
                        based on the url given [default: None]
  -sp SQL_PORT, --sql_base_port SQL_PORT
                        set base mySql port 3306 to be exposed - incrementing
                        by one for each version [default: 9078]
  -smw SMW_VERSION, --smw_version SMW_VERSION
                        set SemanticMediaWiki Version to be installed default
                        is None - no installation of SMW
  -u USER, --user USER  set username of initial user with sysop rights
                        [default: Sysop]
  -q, --quiet           not verbose [default: False]
  -bp BASE_PORT, --base_port BASE_PORT
                        set how base html port 80 to be exposed - incrementing
                        by one for each version [default: 9079]
  -vl [VERSIONS ...], --version_list [VERSIONS ...]
                        mediawiki versions to create docker applications for
                        [default: ['1.39.8']]
  --about               show about info [default: False]
  --apache              generate apache configuration
  --all                 do all necessary steps for a full setup
  --bash                bash into container
  --create              create the wiki
  --check               check the wiki
  --update              start the update script -e.g. to fix SMW key
  --cron                start cron service
  --down                shutdown the wiki [default: False]
  --patch               apply LocalSettings.php patches [default: False]
  --list                list the available profi wikis [default: False]
  -fa, --fontawesome    install fontawesome
  -wuc, --wikiuser_check
                        check wikiuser
  -pu, --plantuml       install plantuml
  -i, --info            show system info
  -V, --version         show program's version number and exit
  --debugServer DEBUGSERVER
                        remote debug Server
  --debugPort DEBUGPORT
                        remote debug Port
  --debugPathMapping DEBUGPATHMAPPING [DEBUGPATHMAPPING ...]
                        remote debug Server path mapping - needs two arguments
                        1st: remotePath 2nd: local Path
Retrieved from "https://wiki.bitplan.com/index.php?title=ProfiWiki&oldid=19138"