API
SEO-Leniviec ma możliwość współpracy przez pseudo-API z innym oprogramowaniem. Pseudo-API SEO-Lenivca, to możliwość wyeksportowania wielu "czynności" programu do przyjaznego pliku XML. Jest też możliwość działania w drugą stronę - SEO-Leniviec uruchomiony z określonymi parametrami wykona dane czynności.API dostępne jest od SEO-Lenivca w wersji 2.0.
Jak wykorzystać i kto może skorzystać z API
Zapraszamy do korzystania z API programu SEO-Leniviec wszystkich Programistów i Producentów oprogramowania związanego z SEO i artykułami - to nic nie kosztuje. Dlaczego warto? Ponieważ obsługa XMLa, czy parametrów jest bardzo prosta, a SEO-Leniviec oferuje bogate możliwości tworzenia, sprawdzania itd tekstu. Jeżeli korzystasz z naszego API - napisz do nas - napiszemy o tym na naszej stronie.XML API:
Instrukcja techniczna
Pliki zapisywane są z rozszerzeniem .xml i są zapisane w UTF-8 bez BOM. Są pełnymi, poprawnymi dokumentami XML. Artybuty i treść elementów są zabezpieczone i znaki HTML są zamienione na encje HTML (np. > = >, < = < itp).Poniżej są opisane struktury poszczególnych plików wynikowych i instrukcje, aby je otrzymać ("nazwa pola" to ścieżka to elementu, bądź atrybutu, należy odczytać jego połozenie z przykładowych zawartości):
Zapis aktualnego tekstu i stanu pracy
Użytkownik ma możliwość wyeksportowania widoku pracy, którą aktualnie wykonuje, wraz z projektem artykułu oraz wygenerowanym podglądem.W tym celu Użytkownik powinien wybrać z menu Plik pozycję Eksportuj dla innych programów (XML API)..., wybrać ścieżkę zapisu - komunikat powiadomi o tym, że plik jest gotowy.
Struktura pliku:
Plik zawiera element główny: SEOLeniviec_XML_API_Export. Ten zawiera podelementy: details, project i articletxt.
<SEOLeniviec_XML_API_Export source="workexport">
<details window-left="485" window-top="53" window-width="860" window-height="626"
editor-width="628" editor-height="332" save-time="2011-02-16 20:01:29" selection=""
count_status="W wygenerowanym tekście: znaków: 26; słów: 5; zdań: 1; linii: 1"/>
<project count="62">A oto {przykładowy tekst|przykładowe {wyrazy|słowa|zdanie}} :)</project>
<articletxt count="26">A oto przykładowy tekst :)</articletxt>
</SEOLeniviec_XML_API_Export>
Pobierz przykładowy plik
Opis pól:
| Nazwa pola | Zawartość | Zawsze istnieje? |
| /source | Zawsze "workexport" | Tak |
| /details/window-left | Pozycja głównego okna SEO-Lenivca od lewej krawędzi | Tak |
| /details/window-top | Pozycja głównego okna SEO-Lenivca od górnej krawędzi | Tak |
| /details/window-width | Szerokość głównego okna SEO-Lenivca | Tak |
| /details/window-height | Wysokość głównego okna SEO-Lenivca | Tak |
| /details/editor-width | Szerokość pola do edycji tekstu projektu źródłowego | Tak |
| /details/editor-height | Wysokość pola do edycji tekstu projektu źródłowego | Tak |
| /details/save-time | Sformatowana data i godzina zapisu tych informacji | Tak |
| /details/selection | Aktualnie zaznaczony w edytorze projektu artykułu tekst | Nie |
| /details/count_status | Zawartość lewego-dolnego rogu - zazwyczaj zawiera ilość znaków w wygenerowanym lub edytowanym tekście | Nie |
| /project/count | Ilość znaków w projekcie tekstu | Tak |
| /project/ | Treść projektu artykułu | Nie |
| /articletxt/count | Ilość znaków w wygenerowanym tekście | Tak |
| /articletxt/ | Treść wygenerowanego artykułu | Nie |
Masowe generowanie artykułów
Użytkownik podczas masowego generowania artykułów powinien wybrać w polu Metoda zapisu opcję Wyeksportuj do XML API (dla innych programów).Po gotowym generowaniu w wybranym przez Użytkownika folderze pojawi się plik XML - gotowy do użycia w Twoim programie.
Struktura pliku:
Plik zawiera element główny: SEOLeniviec_XML_API_Export. Ten zawiera podelementy: settings (zawierający podelement project) oraz articles_txt. Articles_txt zawiera jeden lub więcej podelementów article.
<SEOLeniviec_XML_API_Export source="massgen">
<settings savetype="xmlapi" dir="C:\Users\Ami6669\Desktop\" count="25" adv-threads="4" adv-minuniq="5">
<project>Treść projektu</project>
</settings>
<articles_txt>
<article uniq="0" date="2011-02-15 15:02:43">
Treść wygenerowanego artykułu 1
</article>
<article uniq="34.930049372385" date="2011-02-15 15:02:44">
Treść innego, wygenerowanego artykułu dwa
</article>
(...)
</articles_txt>
</SEOLeniviec_XML_API_Export>
Pobierz przykładowy plik
Opis pól:
| Nazwa pola | Zawartość | Zawsze istnieje? |
| /source | Zawsze "massgen" | Tak |
| settings/savetype | Zawsze "xmlapi" | Tak |
| settings/dir | Scieżka, gdzie zapisano plik | Tak |
| settings/count | Ilość artykułów zleconych do wygenerowania | Tak |
| settings/adv-threads | Ile wątków brało udział przy tworzeniu artykułów | Nie |
| settings/adv-minuniq | Minimalny próg unikalności w %, jaki wybrał Użytkownik | Nie |
| settings/project/ | Projekt tekstu, z którego generowano | Tak |
| settings/articles_txt/article/uniq | Unikalność względem poprzedniego tekstu w tym wątku. Jeżeli Użytkownik nie wybrał progu minimalności, to zawsze zawiera 0 | Nie |
| settings/articles_txt/article/date | Sformatowana data i czas zapisu konkretnego artykułu | Tak |
| settings/articles_txt/article/ | Treść wygenerowanego artykułu. | Tak |
Eksport Biblioteki własnych zapisanych artykułów
Użytkownik może wyeksportować pojedyńczy artykuł, bądź całą kategorię artykułów z Biblioteki własnych zapisanych artykułów (zarówno z lokalnej, jak i z zewnętrznej w sieci Groupwork).Kiedy Użytkownik otworzy Bibliotekę: aby wyeksportować jeden artykuł Użytkownik powinien zaznaczyć go po lewej, aby wyeksportować wszystkie artykuły w jednej kategorii - powinien zaznaczyć tą kategorię. Następnie Użytkownik powinien kliknąć niżej przycisk Wyeksportuj do XML API - po wybraniu miejsca docelowego zapisu zostaną wyeksportowane odpowiednie artykuły i potwierdzi to komunikat - plik jest gotowy do użycia w Twoim programie.
Struktura pliku:
Plik zawiera element główny: SEOLeniviec_XML_API_Export. Ten zawiera podelementy: settings oraz articles. Articles zawiera jeden lub więcej podelementów article. Article zawiera podelementy: preview oraz project.
<SEOLeniviec_XML_API_Export source="biblexport">
<settings count="998" exporttype="wholecategoryexport"/>
<articles>
<article time="16.02.2011 10:00:00" title=""Przykładowy" artykułu">
<preview>Pogląd artykułu</preview>
<project>{Podgląd|Wgląd} {artykułu|tekstu}.</project>
</article>
<article time="16.02.2011 10:01:00" title="Artykuł 2">
<preview>Pogląd artykułu 2</preview>
<project>{Podgląd|Projekt} {artykułu|tekstu} 2.</project>
</article>
(...)
</articles>
</SEOLeniviec_XML_API_Export>
Pobierz przykładowy plik
Opis pól:
| Nazwa pola | Zawartość | Zawsze istnieje? |
| /source | Zawsze "biblexport" | Tak |
| /settings/count | Ilość wyeksportowanych artykułów | Tak |
| /settings/exporttype | "wholecategoryexport" - jeżeli wyeksportowano kategorię; "oneartexport" - jeżeli wyeksportowano jeden artykuł | Tak |
| /articles/article/time | Sformatowana data dodania artykułu do Biblioteki lub inna informacja | Nie |
| /articles/article/title | Tytuł/nazwa artykułu | Tak |
| /articles/article/preview/ | Jeżeli projekt ma poniżej 2048 znaków, to znajduje się tutaj przykładowo wygenerowany tekst z projektu artykułu. Jeżeli projekt ma 2048 lub więcej znaków to pojawi się tutaj przykładowo wygenerowany tekst z pierwszych 2047 znaków projektu i "..." | Nie |
| /articles/article/project/ | Projekt artykułu | Tak |
API - uruchomienie SEO-Lenivca z parametrami
Ścieżka do programu
Ścieżkę do programu SEO-Leniviec można odczytać z rejestru: HKEY_CURRENT_USER\Software\SEOLeniviec\path - do ściezki należy dołączyć nazwę pliku wykonywalnego programu - SEOLeniviec.exe .Parametry
Oto lista parametrów, z jakimi można uruchomić SEO-Lenivca, aby wykonał konkretne czynności:| Czynność | Plik parametry |
| Otworzenie artykułu do edycji | SEOLeniviec.exe NazwaPliku |
| Otworzenie artykułu do edycji i automatyczny zapis po zakończeniu edycji (od wersji 2.1) | SEOLeniviec.exe NazwaPliku -s |
| Wygenerowanie i zapisanie artykułu | SEOLeniviec.exe -g NazwaPliku |
| Wygenerowanie i wydrukowanie artykułu | SEOLeniviec.exe -p NazwaPliku |
| Wygenerowanie i sprawdzenie artykułu w wyszukiwarkach | SEOLeniviec.exe -c NazwaPliku |
| Masowe generowanie artykułów | SEOLeniviec.exe -m NazwaPliku |
| Policzenie kombinacji | SEOLeniviec.exe -o NazwaPliku |
| Wygenerowanie i podgląd w przeglądarce HTML artykułu | SEOLeniviec.exe -r NazwaPliku |
