Grafoscopio/src/Grafoscopio/GrafoscopioDocs.class.st

68 lines
2.0 KiB
Smalltalk

"
I define the documentation for the Grafoscopio package.
"
Class {
#name : #GrafoscopioDocs,
#superclass : #Object,
#category : #Grafoscopio
}
{ #category : #initialization }
GrafoscopioDocs class >> defineDocumentation [
"I model the important documents that belong to the Grafoscopio documentation.
When more documents become more mature and usable, I will include them."
| gfcDocumentation |
gfcDocumentation := GrafoscopioDocumentation new.
gfcDocumentation
name: 'grafoscopio';
repository: (FossilRepo new remote: 'http://mutabit.com/repos.fossil/grafoscopio');
localPlace: FileLocator workingDirectory asFileReference /'Grafoscopio'.
gfcDocumentation documents
add: 'Docs/Es/Tutoriales/tutorial.ston';
add: 'Docs/En/Books/Manual/manual.ston';
add: 'Docs/En/dev-notes.ston';
add: 'Docs/En/Books/Manual/manual.pdf'.
^ gfcDocumentation
]
{ #category : #initialization }
GrafoscopioDocs class >> initialize [
self defineDocumentation
]
{ #category : #operation }
GrafoscopioDocs class >> openDevNotes [
"I'm just an alias to ease the operation. I need to know wich is the index of the notebook
I want to open, as defined on defineDocumentation method."
| docs |
docs := self defineDocumentation.
docs openNotebookAt: 3
]
{ #category : #operation }
GrafoscopioDocs class >> openManual [
"I'm just an alias to ease the operation. I need to know wich is the index of the notebook
I want to open, as defined on defineDocumentation method."
| docs |
docs := self defineDocumentation.
docs openNotebookAt: 2
]
{ #category : #operation }
GrafoscopioDocs class >> openPDFManual [
"I open the documentation in PDF format."
| pdfManual docs |
docs := self defineDocumentation.
pdfManual := docs documents at: 4.
WebBrowser openOn: (docs localPlace / pdfManual) fullName.
]
{ #category : #operation }
GrafoscopioDocs class >> openTutorial [
"I open the proper notebook in the adecuate documentation."
| docs |
docs := self defineDocumentation.
docs openNotebookAt: 1
]