Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
sams-classes
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
coding-at-fu
sams-classes
Commits
e041e77a
Commit
e041e77a
authored
8 years ago
by
Sebastian Lobinger
Browse files
Options
Downloads
Patches
Plain Diff
add SAMSApp documentation to README.md
#16
parent
8faac3d8
No related branches found
No related tags found
1 merge request
!12
Resolve "Dokumentation aktualisieren"
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+99
-2
99 additions, 2 deletions
README.md
with
99 additions
and
2 deletions
README.md
+
99
−
2
View file @
e041e77a
...
@@ -84,8 +84,105 @@ gezogen werden.
...
@@ -84,8 +84,105 @@ gezogen werden.
### SAMSApp
### SAMSApp
**TODO**
#### Methoden
##### Konstruktor
Minimalistischste App:
```
python
app
=
SAMSApp
(
name
=
'
appname
'
,
manifest
=
{
'
default_language
'
:
'
en
'
}
,
langDict
=
{
'
en
'
:{}})
```
Eine SAMSApp benötigt name (name des python packages oder moduls der app),
langDict und manifest. Das Dictionary vom manifest muss eine default_language
definieren, die im langDict enthalten ist.
Eine derart definierte App beinhaltet keine views und keinen Proxy, macht also
relativ wenig Sinn.
In der Regel wird eine SAMSApp eher so aussehen:
```
python
app
=
SAMSApp
(
manifest
=
{
'
default_language
'
:
'
en
'
,
'
views
'
:
[{
'
url
'
:
'
test/do_nothing
'
,
'
function
'
:
'
views.do_nothing
'
}],
'
menu
'
:[
{
'
url
'
:
''
,
'
name_string
'
:
menu_main
},
{
'
url
'
:
'
topic
'
,
'
name_string
'
:
'
menu_topic
'
,
'
menu
'
:[
{
'
url
'
:
'
topic/subtopic01
'
,
'
name_string
'
:
'
menu_topic_subtopic01
'
},
{
'
url
'
:
'
topic/subtopic02
'
,
'
name_string
'
:
'
menu_topic_subtopic02
'
}
]
}
]
},
name
=
'
test.app
'
,
langDict
=
{
'
en
'
:
{
'
menu_main
'
:
'
Home
'
,
'
menu_topic
'
:
'
Topic
'
,
'
menu_topic_subtopic01
'
:
'
Subtopic 01
'
,
'
menu_topic_subtopic02
'
:
'
Subtopic 02
'
},
'
de
'
:{
'
menu_main
'
:
'
Startseite
'
}
}
)
```
##### lang
```
python
langDict
=
app
.
lang
(
langCode
=
'
de
'
)
```
Gibt ein Dictionary für die angeforderte Sprache zurück. Sind Einträge im default
dictionary und nicht in der Angeforderten Sprache vorhanden, werden diese verwendet.
##### menu
```
python
# mandatory
menuEntries
=
SAMSApp
.
menu
(
langCode
=
'
de
'
)
# optional
menuEntries
=
SAMSApp
.
menu
(
langCode
=
'
de
'
,
urlPrefix
=
'
/app/
'
)
```
Gibt eine Liste von Menüeinträgen zurück. Jeder Eintrag ist ein Dictionary.
Dieses Dictionary enthält immer 'url' und 'name' und kann außerdem wieder
über 'menu' ein Menü enthalten. Der Anzeigename ('name') ist entweder der zu
langCode passende oder der, der defaultSprache.
#### Eigenschaften
##### module
Das zur App gehörende python Modul. Führt zu einer Exception falls das
Modul nicht geladen werden kann,
##### name
Der Name der app.
##### blueprint
Das flask Blueprint der app.
##### manifest
Das manifest Dictionary. Hier wird folgendes festgelegt:
-
Standardsprache über
```default_language```
-
Menüeinträge über
```menu```
-
URL View regeln über
```views```
-
proxies
Die Menüeinträge bestehen jeweils aus einem Eintrag 'url' und dem 'name_string'
Die zeichenkette in 'name_string' wird über einen Eintrag im langDict aufgelöst.
Eine View besteht aus 'url' und dem Namen der function in 'function'.
Die ist eine Liste von Proxy definitionen. Die Proxydefinition wird als proxySpec
für SAMSProxy verwendet.
##### proxies
Eine Liste an SAMSProxy Objekten erzeugt aus den Spezifikationen im Manifest.
### SAM
S
Proxy
### SAMProxy
**TODO**
**TODO**
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment