Difference between revisions of "Journal editor"

Revision as of 11:48, 7 August 2017 (view source) Jbotteram (talk | contribs) ← Older edit		Latest revision as of 12:44, 2 October 2017 (view source) Kevin (talk | contribs) m (Protected "Journal editor" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite)))
(17 intermediate revisions by 2 users not shown)
Line 1:		Line 1:
	== Description ==		== Description ==
		+	The Journal Editor is used to edit journal data:
		+	* quest categories
		+	* quests
		+	* quest states
		+	* markers
		+	* recipes (for item combinations, see [[Stats editor]])
		+	* secrets
	<br />		<br />
Line 5:		Line 12:
	<br />		<br />
−	=== Menu ===	+	=== File Menu ===
	[[File:JournalEditor_Menu_File.png|none]]		[[File:JournalEditor_Menu_File.png|none]]
−	<sub></sub>	+	<sub>The File menu</sub>
		+
		+
		+	The File menu allows you to:
		+	* Save the current document
		+	* Save all open (modified) documents
		+	* Reload the current document
		+	* Reload all documents
		+	* Close the current document
		+	* Close all open documents
		+	* Exit the Journal Editor
	<br />		<br />
	=== Project Browser ===		=== Project Browser ===
−	[[File:JournalEditor_ProjectBrowser.png|none]]	+	[[File:JournalEditor_ProjectBrowser.png|border|none]]
−	<sub></sub>	+	<sub>The project browser</sub>
		+
		+
		+	The project browser shows all loaded projects (see the [[Project settings window|Project Settings Window]] for more info on project load order) and allows you to browse their journal documents.
	<br />		<br />
Line 18:		Line 38:
	==== Quests ====		==== Quests ====
	[[File:JournalEditor_Quests.png|none]]		[[File:JournalEditor_Quests.png|none]]
−	<sub></sub>	+	<sub>The quests tab with each component numbered</sub>
		+
		+
		+	The quests tab has the following components:
		+	# [[#Quest Browser|Quest Browser]]
		+	# Quest Properties
		+	# Quest State Browser
		+	# Quest State Properties
		+
		+	<br />
		+	===== Quest Browser =====
		+	[[File:JournalEditor_Quests_Browser.png|border|none]]
		+	<sub>The quest browser with each component numbered</sub>
		+
		+
		+	The quest browser has the following components:
		+	# [[#Searching - Quests|Filter]]
		+	# Quest Container <sup>[1]</sup>
		+	# Quest State Container <sup>[1]</sup>
		+
		+
		+	<sup>[1] Click "+" to add a new entry</sup>
	<br />		<br />
	==== Quest Categories ====		==== Quest Categories ====
	[[File:JournalEditor_QuestCategories.png|none]]		[[File:JournalEditor_QuestCategories.png|none]]
−	<sub></sub>	+	<sub>The quest categories tab with each component numbered</sub>
		+
		+
		+	The quest categories page has the following components:
		+	# Add Row
		+	# [[#Searching - Grid|Search]]
		+	# Header <sup>[1]</sup>
		+	# Category ID <sup>[2]</sup>
		+	# Category Description
		+
		+
		+	<sup>[1] The row header can be clicked to select a full row for copying, pasting or deleting</sup><br />
		+	<sup>[2] This field is unique, duplicate values are not allowed in a column</sup>
	<br />		<br />
	==== Markers ====		==== Markers ====
	[[File:JournalEditor_Markers.png|none]]		[[File:JournalEditor_Markers.png|none]]
−	<sub></sub>	+	<sub>The markers tab with each component numbered</sub>
		+
		+
		+	The marker page has the following components:
		+	# Add Row
		+	# [[#Searching - Grid|Search]]
		+	# Header <sup>[1]</sup>
		+	# Marker ID <sup>[2]</sup>
		+	# Marker Level
		+	# Marker Target Object GUID
		+	# Marker Target Object Type
		+	# Marker Broadcast Level
		+	# Marker Icon
		+	# Marker Display Text
		+
		+
		+	<sup>[1] The row header can be clicked to select a full row for copying, pasting or deleting</sup><br />
		+	<sup>[2] This field is unique, duplicate values are not allowed in a column</sup>
	<br />		<br />
	==== Recipes ====		==== Recipes ====
	[[File:JournalEditor_Recipes.png|none]]		[[File:JournalEditor_Recipes.png|none]]
−	<sub></sub>	+	<sub>The recipes tab with each component numbered</sub>
		+
		+	The recipes page has the following components:
		+	# Add Row
		+	# [[#Searching - Grid|Search]]
		+	# Header <sup>[1]</sup>
		+	# Recipe ID <sup>[2]</sup>
		+	# Recipe Title Key (translated string key <sup>[4]</sup>)
		+	# Recipe Title (readonly; translated string's content <sup>[4]</sup>)
		+	# Recipe Description Key (translated string key <sup>[4]</sup>)
		+	# Recipe Description (readonly; translated string's content <sup>[4]</sup>)
		+	# Recipes <sup>[3]</sup>
		+
		+
		+	<sup>[1] The row header can be clicked to select a full row for copying, pasting or deleting</sup><br />
		+	<sup>[2] This field is unique, duplicate values are not allowed in a column</sup><br />
		+	<sup>[3] This field uses a custom editor</sup><br />
		+	<sup>[4] For more info on translated strings, see the [[Translated string key editor|Translated String Key Editor]]</sup>
	<br />		<br />
	==== Secrets ====		==== Secrets ====
	[[File:JournalEditor_Secrets.png|none]]		[[File:JournalEditor_Secrets.png|none]]
−	<sub></sub>	+	<sub>The secrets tab with each component numbered</sub>
		+
		+	The secrets page has the following components:
		+	# Add Row
		+	# [[#Searching - Grid|Search]]
		+	# Header <sup>[1]</sup>
		+	# Secret ID <sup>[2]</sup>
		+	# Secret Title
		+	# Secret Description
		+	# Secret Marker ID <sup>[3]</sup> (see [[#Markers|Markers]])
		+	# Secret Broadcast Level
		+
		+
		+	<sup>[1] The row header can be clicked to select a full row for copying, pasting or deleting</sup><br />
		+	<sup>[2] This field is unique, duplicate values are not allowed in a column</sup><br />
		+	<sup>[3] This field uses a custom editor</sup>
	<br />		<br />
	=== Searching ===		=== Searching ===
−	==== Quests ====	+	==== Searching - Quests ====
−	[[File:JournalEditor_Search_Quests.png|none]]	+	[[File:JournalEditor_Search_Quests.png|border|none]]
−	<sub></sub>	+	<sub>Quest tab searching</sub>
		+
		+	The quest filter textbox allows you to input a string to filter quest categories, quests and quest states by.
		+
		+	There are several filtering options:
		+	* '''Default''': by default, a search will filter quest categories, quests and quest states by name <sup>[1]</sup>
		+	* '''Prefixed''': there are several ways to do an advanced search by prefixing your search by one of the following <sup>[2]</sup>:
		+	** "'''a:'''" (All): The same as a default search
		+	** "'''c:'''" (Category): filter only by quest category name
		+	** "'''q:'''" (Quest): filter only by quest name
		+	** "'''s:'''" (State): filter only by quest state name
		+
		+
		+	<sup>[1] You can filter by multiple strings by space-seperating your queries</sup><br />
		+	<sup>[2] You can perform multiple advanced queries at once by comma-seperating your prefixed searches (e.g. "q: redprince, s: wakeup)</sup>
	<br />		<br />
−	==== Grid ====	+	==== Searching - Grid ====
	[[File:JournalEditor_Search_Grid.png|none]]		[[File:JournalEditor_Search_Grid.png|none]]
−	<sub></sub>	+	<sub>Grid searching</sub>
		+
		+
		+	The grid search functionality allows you to search for a string in the currently opened document's grid. To search a string, simply type it in the textbox (space-seperate your search query if you want a field to match multiple strings) and use the "< Previous" and "Next >" buttons to navigate through the grid.
	<br />		<br />
		+
		+	== See Also ==
		+	* [[Osiris/Shared/DB QuestDef Sate‎‎|Activating/showing journal updates in-game]]

---

Latest revision as of 12:44, 2 October 2017

Description

The Journal Editor is used to edit journal data:

• quest categories
• quests
• quest states
• markers
• recipes (for item combinations, see Stats editor)
• secrets

Using the Journal Editor

File Menu

_{The File menu}

The File menu allows you to:

• Save the current document
• Save all open (modified) documents
• Reload the current document
• Reload all documents
• Close the current document
• Close all open documents
• Exit the Journal Editor

Project Browser

_{The project browser}

The project browser shows all loaded projects (see the Project Settings Window for more info on project load order) and allows you to browse their journal documents.

Tabs

Quests

_{The quests tab with each component numbered}

The quests tab has the following components:

1. Quest Browser
2. Quest Properties
3. Quest State Browser
4. Quest State Properties

Quest Browser

_{The quest browser with each component numbered}

The quest browser has the following components:

1. Filter
2. Quest Container ^[1]
3. Quest State Container ^[1]

^{[1] Click "+" to add a new entry}

Quest Categories

_{The quest categories tab with each component numbered}

The quest categories page has the following components:

1. Add Row
2. Search
3. Header ^[1]
4. Category ID ^[2]
5. Category Description

^{[1] The row header can be clicked to select a full row for copying, pasting or deleting
[2] This field is unique, duplicate values are not allowed in a column}

Markers

_{The markers tab with each component numbered}

The marker page has the following components:

1. Add Row
2. Search
3. Header ^[1]
4. Marker ID ^[2]
5. Marker Level
6. Marker Target Object GUID
7. Marker Target Object Type
8. Marker Broadcast Level
9. Marker Icon
10. Marker Display Text

^{[1] The row header can be clicked to select a full row for copying, pasting or deleting
[2] This field is unique, duplicate values are not allowed in a column}

Recipes

_{The recipes tab with each component numbered}

The recipes page has the following components:

1. Add Row
2. Search
3. Header ^[1]
4. Recipe ID ^[2]
5. Recipe Title Key (translated string key ^[4])
6. Recipe Title (readonly; translated string's content ^[4])
7. Recipe Description Key (translated string key ^[4])
8. Recipe Description (readonly; translated string's content ^[4])
9. Recipes ^[3]

^{[1] The row header can be clicked to select a full row for copying, pasting or deleting
[2] This field is unique, duplicate values are not allowed in a column
[3] This field uses a custom editor
[4] For more info on translated strings, see the Translated String Key Editor}

Secrets

_{The secrets tab with each component numbered}

The secrets page has the following components:

1. Add Row
2. Search
3. Header ^[1]
4. Secret ID ^[2]
5. Secret Title
6. Secret Description
7. Secret Marker ID ^[3] (see Markers)
8. Secret Broadcast Level

^{[1] The row header can be clicked to select a full row for copying, pasting or deleting
[2] This field is unique, duplicate values are not allowed in a column
[3] This field uses a custom editor}

Searching

Searching - Quests

_{Quest tab searching}

The quest filter textbox allows you to input a string to filter quest categories, quests and quest states by.

There are several filtering options:

• Default: by default, a search will filter quest categories, quests and quest states by name ^[1]
• Prefixed: there are several ways to do an advanced search by prefixing your search by one of the following ^[2]:
  • "a:" (All): The same as a default search
  • "c:" (Category): filter only by quest category name
  • "q:" (Quest): filter only by quest name
  • "s:" (State): filter only by quest state name

^{[1] You can filter by multiple strings by space-seperating your queries
[2] You can perform multiple advanced queries at once by comma-seperating your prefixed searches (e.g. "q: redprince, s: wakeup)}

Searching - Grid

_{Grid searching}

The grid search functionality allows you to search for a string in the currently opened document's grid. To search a string, simply type it in the textbox (space-seperate your search query if you want a field to match multiple strings) and use the "< Previous" and "Next >" buttons to navigate through the grid.

See Also

• Activating/showing journal updates in-game