Std New: Difference between revisions

From LabRPS Documentation
Jump to navigation Jump to search
(Created page with "{{Docnav |Std File New aspect |Std File New table |Std File Menu |IconL=Std_File_New_aspect.svg |IconR=Std_File_New_table.svg |IconC=Labrps.svg }} {{GuiCommand |Name=Std New |MenuLocation=File → New → New Project |Phenomena=All |Shortcut={{KEY|Ctrl}}+{{KEY|N}} |Version=0.001 |SeeAlso=Std File New aspect, Std File New table }} ==Description== The '''Std F...")
 
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Docnav
{{Docnav
|[[Std_File_New_aspect|Std File New aspect]]
|
|[[Std_File_New_table|Std File New table]]
|[[Std_New_Table|Std New table]]
|[[Std_File_Menu|Std File Menu]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_File_New_aspect.svg
|IconL=
|IconR=Std_File_New_table.svg
|IconR=Std_New_Table.svg
|IconC=Labrps.svg
|IconC=Labrps.svg
}}
}}
Line 10: Line 10:
{{GuiCommand
{{GuiCommand
|Name=Std New
|Name=Std New
|MenuLocation=File → New → New Project
|MenuLocation=File → New  
|Phenomena=All
|Phenomena=All
|Shortcut={{KEY|Ctrl}}+{{KEY|N}}
|Shortcut={{KEY|Ctrl}}+{{KEY|N}}
|Version=0.001
|Version=0.1
|SeeAlso=[[Std_File_New_aspect|Std File New aspect]], [[Std_File_New_table|Std File New table]]
|SeeAlso=[[Std_New_Table|Std New table]]
}}
}}


==Description==
==Description==


The '''Std File New project''' command creates new project.  
The '''Std New''' command creates a new empty document and makes it the active document.  


==Usage==
==Usage==
There are several ways to invoke the command:
There are several ways to invoke the command:
#* Press the {{ComboBox|[[Image:Std_File_New_aspect.svg|16px]] [[Std_File_New_aspect|New]]}} → {{Button|[[Image:Std_File_New_project.svg|16px]] [[Std_File_New_project|New Project]]}} button.
#* Press the {{Button|[[Image:Std_New.svg|16px]] [[Std_New|New]]}} button.
#* Select the {{MenuCommand|File → [[Image:Std_File_New_aspect.svg|16px]] New → [[Image:Std_File_New_project.svg|16px]]New Project}} option from the menu.
#* Select the {{MenuCommand|File → [[Image:Std_New.svg|16px]] New}} option from the menu.
#* Use the keyboard shortcut: {{KEY|Ctrl}}+{{KEY|N}}.
#* Use the keyboard shortcut: {{KEY|Ctrl}}+{{KEY|N}}.


==Note==
==Preferences==  
This command will first close any existing project that is opened. Please in cas e you would like to create a new project, save the existing one first if you want to keep your current works.


==Properties==
See also: [[Preferences_Editor|Preferences Editor]].


The project properties can be shown in the [[Project_property|Project property]]:
* By default LabRPS start without a new document. Check the {{MenuCommand|Edit → Preferences... → General → Document → Create new document at start up}} option to change this behavior.
* Some document properties: author name, company name and license information, can be preset: {{MenuCommand|Edit → Preferences... → General → Document → Authoring and License}}.
 
==Properties==
 
See also: [[Property_editor|Property editor]].
 
Most properties can also be changed in the dialog box of the [[Std_ProjectInfo|Std ProjectInfo]] command.
 
===Data===
 
{{TitleProperty|Base}}
 
* {{PropertyData|Comment|String}}: Any comment that may apply.
* {{PropertyData|Company|String}}: Company name.
* {{PropertyData|Created By|String}}: Author name.
* {{PropertyData|Creation Date|String}}: Automatic date stamp (read-only).
* {{PropertyData|File Name|String}}: The full path of the file. Blank if the document has not been saved (read-only).
* {{PropertyData|Id|String}}: Not implemented yet.
* {{PropertyData|Label|String}}: The name that will appear in the [[Tree_view|Tree view]]. Replaced by the name of the document after reopening.
* {{PropertyData|Last Modified By|String}}: Author name.
* {{PropertyData|Last Modified Date|String}}: Automatic date stamp (read-only).
* {{PropertyData|License|String}}: License type.
* {{PropertyData|License URL|String}}: License URL.
* {{PropertyData|Material|Map|Hidden}}: Map with material properties.
* {{PropertyData|Meta|Map|Hidden}}: Map with additional meta information.
* {{PropertyData|Show Hidden|Bool}}: If true, items that have been hidden in the [[Tree_view|Tree view]] will be displayed anyway. Hiding items in the tree can be useful when working on larger models.
* {{PropertyData|Tip|Link}}: Not implemented yet.
* {{PropertyData|Tip Name|String}}: Not implemented yet.
* {{PropertyData|Transient Dir|String}}: The transient directory used for recovery data (read-only).
* {{PropertyData|Uid|UUID|Hidden}}: UUID of the document (read-only).
 
==Scripting==
 
See also: [https://labrps.github.io/SourceDoc/ Autogenerated API documentation] and [[LabRPS_Scripting_Basics|LabRPS Scripting Basics]].
 
To create a new document use the {{incode|newDocument([name], [hidden<nowiki>=</nowiki>False])}} method of the LabRPS application. The document name must be unique, which is checked automatically. If no name is supplied, the document will be named "Untitled". If {{incode|hidden<nowiki>=</nowiki>True}} is used, the new document won't be displayed in the GUI and no tab will appear for it.
 
{{Code|code=
import LabRPS
from pathlib import Path
 
# The folder and filename we will use:
fld = 'D:/testfiles/'
fnm = fld + 'test.RPSStd'
 
# Make sure fld exists:
Path(fld).mkdir(parents=True, exist_ok=True)
 
doc = LabRPS.newDocument()
doc.saveAs(fnm)
 
LabRPS.closeDocument(doc.Name)
 
doc = LabRPS.open(fnm)
doc.save()
 
LabRPS.closeDocument(doc.Name)
}}


* {{PropertyData|Type}}: The type of document. {{Emphasis|Not editable}}.
* {{PropertyData|Status}}: The status of the project's document.
* {{PropertyData|File Name}}: The full path of the file. "Never saved" if the document has not been saved. {{Emphasis|Not editable}}.
* {{PropertyData|Size}}: The size of the project document file.
* {{PropertyData|Path}}: The content of the project.
* {{PropertyData|Comment}}: Any comment that may apply.
* {{PropertyData|Company}}: Company name. {{Emphasis|Can be preset}}.
* {{PropertyData|Created By}}: Author name. {{Emphasis|Can be preset}}.
* {{PropertyData|Creation Date}}: Automatic date stamp. {{Emphasis|Not editable}}.
* {{PropertyData|Id}}: Not implemented yet.
* {{PropertyData|Label}}: The name that will appear in the [[Project_tree_view|Tree view]]. By default the name of the document.
* {{PropertyData|Last Modified By}}: Author name. {{Emphasis|Can be preset}}.
* {{PropertyData|Last Modified Date}}: Automatic date stamp. {{Emphasis|Not editable}}.
* {{PropertyData|License}}: License type. {{Emphasis|Can be preset}}.
* {{PropertyData|License URL}}: License URL. {{Emphasis|Can be preset}}.
* {{PropertyData|Show Hidden}}: If true, items that have been hidden in the [[Project_tree_view|Tree view]] will be displayed anyway. Hiding items in the tree can be useful when working on larger models.
* {{PropertyData|Tip}}: Not implemented yet.
* {{PropertyData|Tip Name}}: Not implemented yet.


{{Docnav
{{Docnav
|[[Std_File_New_aspect|Std File New aspect]]
|
|[[Std_File_New_table|Std File New table]]
|[[Std_New_Table|Std New table]]
|[[Std_File_Menu|Std File Menu]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_File_New_aspect.svg
|IconL=
|IconR=Std_File_New_table.svg
|IconR=Std_New_Table.svg
|IconC=Labrps.svg
|IconC=Labrps.svg
}}
}}


{{Std Base navi}}
{{Std_Base_navi}}
{{Userdocnavi}}
{{Userdocnavi}}
{{clear}}

Latest revision as of 03:30, 26 October 2024

Std New.svg Std New

Menu location
File → New
Phenomena
All
Default shortcut
Ctrl+N
Introduced in version
0.1
See also
Std New table

Description

The Std New command creates a new empty document and makes it the active document.

Usage

There are several ways to invoke the command:

    • Press the Std New.svg New button.
    • Select the File → Std New.svg New option from the menu.
    • Use the keyboard shortcut: Ctrl+N.

Preferences

See also: Preferences Editor.

  • By default LabRPS start without a new document. Check the Edit → Preferences... → General → Document → Create new document at start up option to change this behavior.
  • Some document properties: author name, company name and license information, can be preset: Edit → Preferences... → General → Document → Authoring and License.

Properties

See also: Property editor.

Most properties can also be changed in the dialog box of the Std ProjectInfo command.

Data

Base

  • DataComment (String): Any comment that may apply.
  • DataCompany (String): Company name.
  • DataCreated By (String): Author name.
  • DataCreation Date (String): Automatic date stamp (read-only).
  • DataFile Name (String): The full path of the file. Blank if the document has not been saved (read-only).
  • DataId (String): Not implemented yet.
  • DataLabel (String): The name that will appear in the Tree view. Replaced by the name of the document after reopening.
  • DataLast Modified By (String): Author name.
  • DataLast Modified Date (String): Automatic date stamp (read-only).
  • DataLicense (String): License type.
  • DataLicense URL (String): License URL.
  • Data (Hidden)Material (Map): Map with material properties.
  • Data (Hidden)Meta (Map): Map with additional meta information.
  • DataShow Hidden (Bool): If true, items that have been hidden in the Tree view will be displayed anyway. Hiding items in the tree can be useful when working on larger models.
  • DataTip (Link): Not implemented yet.
  • DataTip Name (String): Not implemented yet.
  • DataTransient Dir (String): The transient directory used for recovery data (read-only).
  • Data (Hidden)Uid (UUID): UUID of the document (read-only).

Scripting

See also: Autogenerated API documentation and LabRPS Scripting Basics.

To create a new document use the newDocument([name], [hidden=False]) method of the LabRPS application. The document name must be unique, which is checked automatically. If no name is supplied, the document will be named "Untitled". If hidden=True is used, the new document won't be displayed in the GUI and no tab will appear for it.

import LabRPS
from pathlib import Path

# The folder and filename we will use:
fld = 'D:/testfiles/'
fnm = fld + 'test.RPSStd'

# Make sure fld exists:
Path(fld).mkdir(parents=True, exist_ok=True)

doc = LabRPS.newDocument()
doc.saveAs(fnm)

LabRPS.closeDocument(doc.Name)

doc = LabRPS.open(fnm)
doc.save()

LabRPS.closeDocument(doc.Name)