class PublicanCreatorsCreate
Class for creating stuff
Public Class Methods
This method uses the input of init_docu methods to create the documentation @param [String] string This input comes from init_docu @param [String] title comes from the get method. This param represents the
name or title of your work. It is used in all important code places.
@return [String] true or false
# File lib/publican_creators/create.rb, line 125 def self.create_docu(string, title) system("publican create #{string}") # @param [String] title comes from the get method. This param represents # the name or title of your work. It is used in all important code places. Checker.check_result(title) end
Method for creating initial documentation for private. It asks for title, type, language, homework, brand_homework, brand_private and db5 variable, creates a launch-string from them and launches publican. @param [String] title comes from the get method. This parameter represents
the name or title of your work. It is used in all important code places.
@param [String] type represents the Document-Type like Article or Book. @param [String] homework can be true or false @param [String] brand_private is used in all methods with a “private” in the
name. If this brand is set it will be used instead of the original publican brand.
@param [String] language is just the ISO Code of your target language like:
de-DE, en-GB or such things.
@param [String] brand_homework can be a special customized brand for
distance learning schools.
@param [String] db5 just sets your preferences. If you like to have DocBook
5.x as default you can set it there.
@return [String] true or false @note That method returns just a success or a fail. After the main part of the method it starts another method “PublicanCreatorsChange.check_result”. This method checks if the directory with the content of the parameter title is available.
# File lib/publican_creators/create.rb, line 76 def self.init_docu_private(title, type, homework, language, brand_homework, brand_private, db5) puts 'Creating initial documentation ...' if type == 'Article' string = private_article(language, title, brand_private, brand_homework, homework) else # @note Initial creation of documentation with publican string = "--lang #{language} --name #{title}" string << " --brand #{brand_private}" if brand_private != '' end # @note Check if DocBook 5 wished as default, if yes it adds the parameter # dtdver 5.0 to string string << ' --dtdver 5.0' if db5 == 'true' create_docu(string, title) end
Method for creating initial documentation for work. It asks for title, type, language, brand and db5 variable, creates a launch-string from them and launches publican. @param [String] title comes from the get method. This @param represents the
name or title of your work. It is used in all important code places.
@param [String] type represents the Document-Type like Article or Book. @param [String] language is just the ISO Code of your target language like:
de-DE, en-GB or such things.
@param [String] brand can be a special customized brand for your company to
fit the styleguide.
@param [String] db5 just sets your preferences. If you like to have DocBook
5.x as default you can set it there.
@return [String] true or false @note That method returns just a success or a fail. After the main part of the method it starts another method “PublicanCreatorsChange.check_result”. This method checks if the directory with the content of the parameter title is available.
# File lib/publican_creators/create.rb, line 40 def self.init_docu_work(title, type, language, brand, db5) puts 'Creating initial documentation ...' # Set standard string string = "--lang #{language} --name #{title}" # Add Article if type is Article string << ' --type Article' if type == 'Article' # Set business brand if given string << " --brand #{brand}" if brand != '' # @note Check if DocBook 5 wished as default, if yes it adds the parameter # dtdver 5.0 to string string << ' --dtdver 5.0' if db5 == 'true' create_docu(string, title) end
Method for preparing the string for private articles @param [String] language is just the ISO Code of your target language like:
de-DE, en-GB or such things.
@param [String] title comes from the get method. This parameter represents
the name or title of your work. It is used in all important code places.
@param [String] brand_private is used in all methods with a “private” in the
name. If this brand is set it will be used instead of the original publican brand.
@param [String] brand_homework can be a special customized brand for
distance learning schools.
@param [String] homework true if homework set
# File lib/publican_creators/create.rb, line 105 def self.private_article(language, title, brand_private, brand_homework, homework) # @note Initial creation of documentation with publican string = "--type Article --lang #{language} --name #{title}" # Use brand_private if brand_private is set if brand_private != '' && homework == 'FALSE' string << " --brand #{brand_private}" end # Use brand_homework if its set if brand_homework != '' && homework == 'TRUE' string << " --brand #{brand_homework}" end return string end